Class AbstractGeographicExtent
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.extent.AbstractGeographicExtent
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.extent.GeographicExtent
- Direct Known Subclasses:
DefaultBoundingPolygon
,DefaultGeographicBoundingBox
,DefaultGeographicDescription
public class AbstractGeographicExtent
extends ISOMetadata
implements org.opengis.metadata.extent.GeographicExtent
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
XML
instead.
- Since:
- 0.3
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Boolean
Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty geographic extent.AbstractGeographicExtent
(boolean inclusion) Constructs a geographic extent initialized with the specified inclusion value.AbstractGeographicExtent
(org.opengis.metadata.extent.GeographicExtent object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractGeographicExtent
castOrCopy
(org.opengis.metadata.extent.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).void
setInclusion
(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 org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
inclusion
Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).Implementation note: we need to store the reference to the
Boolean
instance instead than using bitmask becausePrimitiveTypeProperties
may associate some properties to that particular instance.
-
-
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
public AbstractGeographicExtent(org.opengis.metadata.extent.GeographicExtent 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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static AbstractGeographicExtent castOrCopy(org.opengis.metadata.extent.GeographicExtent 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 returnsnull
. - Otherwise if the given object is an instance of
BoundingPolygon
,GeographicBoundingBox
orGeographicDescription
, 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
AbstractGeographicExtent
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, ornull
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.
- 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:
getInclusion
in interfaceorg.opengis.metadata.extent.GeographicExtent
- Returns:
true
for inclusion, orfalse
for 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
-true
if the bounding polygon encompasses an area covered by the data.
-