Module org.apache.sis.metadata
Class DefaultPlatformPass
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultPlatformPass
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,PlatformPass
Identification of collection coverage.
The following properties are mandatory in a well-formed metadata according ISO 19115:
MI_PlatformPass
└─identifier…… Unique name of the pass.
└─code………… Alphanumeric value identifying an instance in the namespace.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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty platform pass.DefaultPlatformPass(PlatformPass object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultPlatformPasscastOrCopy(PlatformPass object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the area covered by the pass.Returns the unique name of the pass.Returns the occurrence of one or more events for a pass.voidsetExtent(Geometry newValue) Sets the area covered by the pass.voidsetIdentifier(Identifier newValue) Sets the unique name of the pass.voidsetRelatedEvents(Collection<? extends Event> newValues) Sets the occurrence of one or more events for a pass.Methods inherited from class ISOMetadata
getIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultPlatformPass
public DefaultPlatformPass()Constructs an initially empty platform pass. -
DefaultPlatformPass
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultPlatformPass, then it is returned unchanged. - Otherwise a new
DefaultPlatformPassinstance 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getIdentifier
Returns the unique name of the pass.- Specified by:
getIdentifierin interfacePlatformPass- Overrides:
getIdentifierin classISOMetadata- Returns:
- unique name of the pass, or
null.
-
setIdentifier
Sets the unique name of the pass.- Overrides:
setIdentifierin classISOMetadata- Parameters:
newValue- the new identifier value.
-
getExtent
Returns the area covered by the pass.nullif unspecified.- Specified by:
getExtentin interfacePlatformPass- Returns:
- area covered by the pass, or
null.
-
setExtent
Sets the area covered by the pass.- Parameters:
newValue- the new extent value.
-
getRelatedEvents
Returns the occurrence of one or more events for a pass.- Specified by:
getRelatedEventsin interfacePlatformPass- Returns:
- occurrence of one or more events for a pass.
-
setRelatedEvents
Sets the occurrence of one or more events for a pass.- Parameters:
newValues- the new related events values.
-