Class DefaultEvent

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultEvent

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Event

@TitleProperty(name="identifier")
public class DefaultEvent
extends ISOMetadata
implements Event

Identification of a significant collection point within an operation. The following properties are mandatory in a well-formed metadata according ISO 19115:

MI_Event ├─identifier…… Event name or number. │ └─code………… Alphanumeric value identifying an instance in the namespace. ├─trigger…………… Initiator of the event. ├─context…………… Meaning of the event. ├─sequence………… Relative time ordering of the event. └─time…………………… Time the event occurred.

Limitations

• Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
• Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Event()	Constructs an initially empty acquisition information.
Default­Event(Event object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Event	cast­Or­Copy(Event object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Context	get­Context()	Meaning of the event.
Temporal	get­Date­Of­Occurrence()	Returns the time the event occurred.
Collection<Objective>	get­Expected­Objectives()	Returns the objective or objectives satisfied by an event.
Identifier	get­Identifier()	Returns the event name or number.
Platform­Pass	get­Related­Pass()	Returns the pass during which an event occurs.
Collection<? extends Instrument>	get­Related­Sensors()	Returns the instrument or instruments for which the event is meaningful.
Sequence	get­Sequence()	Returns the relative time ordering of the event.
Date	get­Time()	Deprecated. Replaced by get­Date­Of­Occurrence().
Trigger	get­Trigger()	Returns the initiator of the event.
void	set­Context(Context new­Value)	Sets the meaning of the event.
void	set­Date­Of­Occurrence(Temporal new­Value)	Sets the date and/or time the event occurred.
void	set­Expected­Objectives(Collection<? extends Objective> new­Values)	Sets the objective or objectives satisfied by an event.
void	set­Identifier(Identifier new­Value)	Sets the event name or number.
void	set­Related­Pass(Platform­Pass new­Value)	Sets the pass during which an event occurs.
void	set­Related­Sensors(Collection<? extends Instrument> new­Values)	Sets the instrument or instruments for which the event is meaningful.
void	set­Sequence(Sequence new­Value)	Sets the relative time ordering of the event.
void	set­Time(Date new­Value)	Deprecated. Replaced by set­Date­Of­Occurrence(Temporal).
void	set­Trigger(Trigger new­Value)	Sets the initiator of the event.

Methods inherited from class ISOMetadata

get­Identifier­Map, get­Identifiers, get­Standard

Modifier and Type	Method	Description
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultEvent

public DefaultEvent()

Constructs an initially empty acquisition information.

DefaultEvent

public DefaultEvent(Event object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

• cast­Or­Copy(Event)

Method Details

castOrCopy

public static DefaultEvent castOrCopy(Event object)

Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Event, then it is returned unchanged.
• Otherwise a new Default­Event instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

getIdentifier

public Identifier getIdentifier()

Returns the event name or number.

Specified by:

get­Identifier in interface Event

Overrides:

get­Identifier in class ISOMetadata

Returns:

event name or number, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the event name or number.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the event identifier value.

getTrigger

public Trigger getTrigger()

Returns the initiator of the event.

Specified by:

get­Trigger in interface Event

Returns:

initiator of the event, or null.

setTrigger

public void setTrigger(Trigger newValue)

Sets the initiator of the event.

Parameters:

new­Value - the new trigger value.

getContext

public Context getContext()

Meaning of the event.

Specified by:

get­Context in interface Event

Returns:

meaning of the event, or null.

setContext

public void setContext(Context newValue)

Sets the meaning of the event.

Parameters:

new­Value - the new context value.

getSequence

public Sequence getSequence()

Returns the relative time ordering of the event.

Specified by:

get­Sequence in interface Event

Returns:

relative time ordering, or null.

setSequence

public void setSequence(Sequence newValue)

Sets the relative time ordering of the event.

Parameters:

new­Value - the new sequence value.

getTime

@Deprecated(since="1.5")
public Date getTime()

Deprecated.

Replaced by get­Date­Of­Occurrence().

Returns the time the event occurred.

Specified by:

get­Time in interface Event

Returns:

time the event occurred, or null.

setTime

@Deprecated(since="1.5")
public void setTime(Date newValue)

Deprecated.

Replaced by set­Date­Of­Occurrence(Temporal).

Sets the time the event occurred.

Parameters:

new­Value - the new time value.

getDateOfOccurrence

@UML(identifier="time",
     obligation=MANDATORY,
     specification=ISO_19115_2)
public Temporal getDateOfOccurrence()

Returns the time the event occurred.

Returns:

time the event occurred, or null.

Since:

1.5

setDateOfOccurrence

public void setDateOfOccurrence(Temporal newValue)

Sets the date and/or time the event occurred.

Parameters:

new­Value - the new time value.

Since:

1.5

getExpectedObjectives

public Collection<Objective> getExpectedObjectives()

Returns the objective or objectives satisfied by an event.

Specified by:

get­Expected­Objectives in interface Event

Returns:

objectives satisfied by an event.

setExpectedObjectives

public void setExpectedObjectives(Collection<? extends Objective> newValues)

Sets the objective or objectives satisfied by an event.

Parameters:

new­Values - the new expected objectives values.

getRelatedPass

public PlatformPass getRelatedPass()

Returns the pass during which an event occurs. null if unspecified.

Specified by:

get­Related­Pass in interface Event

Returns:

pass during which an event occurs, or null.

setRelatedPass

public void setRelatedPass(PlatformPass newValue)

Sets the pass during which an event occurs.

Parameters:

new­Value - the new platform pass value.

getRelatedSensors

public Collection<? extends Instrument> getRelatedSensors()

Returns the instrument or instruments for which the event is meaningful.

Specified by:

get­Related­Sensors in interface Event

Returns:

instruments for which the event is meaningful.

setRelatedSensors

public void setRelatedSensors(Collection<? extends Instrument> newValues)

Sets the instrument or instruments for which the event is meaningful.

Parameters:

new­Values - the new instrument values.