Package csw.params.events

Class ObserveEvent

java.lang.Object

csw.params.core.generics.ParameterSetType<ObserveEvent>

csw.params.events.ObserveEvent

All Implemented Interfaces:

Event, java.io.Serializable, scala.Equals, scala.Product

public class ObserveEvent
extends ParameterSetType<ObserveEvent>
implements Event, scala.Product, java.io.Serializable

Defines an observe event. Constructor is private to ensure eventId is created internally to guarantee unique value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ObserveEvent(Id eventId, Prefix source, EventName eventName, UTCTime eventTime, scala.collection.immutable.Set<Parameter<?>> paramSet)

Method Summary

Modifier and Type	Method	Description
static ObserveEvent	apply(Prefix source, EventName eventName)	The apply method is used to create ObserveEvent command by end-user.
static ObserveEvent	apply(Prefix source, EventName eventName, scala.collection.immutable.Set<Parameter<?>> paramSet)	The apply method is used to create ObserveEvent command by end-user.
protected ObserveEvent	create(scala.collection.immutable.Set<Parameter<?>> data)	Create a new ObserveEvent instance when a parameter is added or removed
Id	eventId()	unique Id for event
EventName	eventName()	The name of event
UTCTime	eventTime()	The time of event creation
scala.collection.immutable.Set<Parameter<?>>	paramSet()	Holds the parameters for this parameter set
Prefix	source()	Prefix representing source of the event

Methods inherited from class csw.params.core.generics.ParameterSetType

add, apply, contains, dataToString, exists, find, get, get, getStringMap, jFind, jGet, jGet, jGetStringMap, jMadd, jMissingKeys, jMissingKeys, jParamSet, madd, madd, madd, missingKeys, parameter, remove, remove, size, toString, typeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface csw.params.events.Event

eventKey, isInvalid, paramType, toString, typeName

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Detail

ObserveEvent

public ObserveEvent(Id eventId,
                    Prefix source,
                    EventName eventName,
                    UTCTime eventTime,
                    scala.collection.immutable.Set<Parameter<?>> paramSet)

Method Detail

apply

public static ObserveEvent apply(Prefix source,
                                 EventName eventName)

The apply method is used to create ObserveEvent command by end-user. eventId is not accepted and will be created internally to guarantee unique value.

Parameters:

source - prefix representing source of the event

eventName - the name of event

Returns:

a new instance of ObserveEvent with auto-generated eventId, eventTime and empty paramSet

apply

public static ObserveEvent apply(Prefix source,
                                 EventName eventName,
                                 scala.collection.immutable.Set<Parameter<?>> paramSet)

The apply method is used to create ObserveEvent command by end-user. eventId is not accepted and will be created internally to guarantee unique value.

Parameters:

source - prefix representing source of the event

eventName - the name of event

paramSet - an initial set of parameters (keys with values)

Returns:

a new instance of ObserveEvent with auto-generated eventId and eventTime

eventId

public Id eventId()

Description copied from interface: Event

unique Id for event

Specified by:

eventId in interface Event

Returns:

(undocumented)

source

public Prefix source()

Description copied from interface: Event

Prefix representing source of the event

Specified by:

source in interface Event

Returns:

(undocumented)

eventName

public EventName eventName()

Description copied from interface: Event

The name of event

Specified by:

eventName in interface Event

Returns:

(undocumented)

eventTime

public UTCTime eventTime()

Description copied from interface: Event

The time of event creation

Specified by:

eventTime in interface Event

Returns:

(undocumented)

paramSet

public scala.collection.immutable.Set<Parameter<?>> paramSet()

Description copied from class: ParameterSetType

Holds the parameters for this parameter set

Specified by:

paramSet in interface Event

Specified by:

paramSet in class ParameterSetType<ObserveEvent>

Returns:

(undocumented)

create

protected ObserveEvent create(scala.collection.immutable.Set<Parameter<?>> data)

Create a new ObserveEvent instance when a parameter is added or removed

Specified by:

create in class ParameterSetType<ObserveEvent>

Parameters:

data - set of parameters

Returns:

a new instance of ObserveEvent with new eventId, eventTime and provided data