Class AbstractGeographicExtent
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractGeographicExtent
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,GeographicExtent
- Direct Known Subclasses:
DefaultBoundingPolygon,DefaultGeographicBoundingBox,DefaultGeographicDescription
Base class for geographic area of the dataset.
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:
Defined in the sis-metadata module
-
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 geographic extent.AbstractGeographicExtent(boolean inclusion) Constructs a geographic extent initialized with the specified inclusion value.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractGeographicExtentcastOrCopy(GeographicExtent object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).voidsetInclusion(Boolean newValue) Sets whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, 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
-
AbstractGeographicExtent
public AbstractGeographicExtent()Constructs an initially empty geographic extent. -
AbstractGeographicExtent
public AbstractGeographicExtent(boolean inclusion) Constructs a geographic extent initialized with the specified inclusion value.- Parameters:
inclusion- whether the bounding polygon encompasses an area covered by the data.
-
AbstractGeographicExtent
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 an instance of
BoundingPolygon,GeographicBoundingBoxorGeographicDescription, then this method delegates to thecastOrCopy(…)method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)method to be used is unspecified. - Otherwise if the given object is already an instance of
AbstractGeographicExtent, then it is returned unchanged. - Otherwise a new
AbstractGeographicExtentinstance 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
-
getInclusion
Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).- Specified by:
getInclusionin interfaceGeographicExtent- Returns:
truefor inclusion, orfalsefor exclusion.
-
setInclusion
Sets whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).- Parameters:
newValue-trueif the bounding polygon encompasses an area covered by the data.
-