Class DefaultGeometricObjects
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.spatial.DefaultGeometricObjects
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.spatial.GeometricObjects
public class DefaultGeometricObjects
extends ISOMetadata
implements org.opengis.metadata.spatial.GeometricObjects
Number of objects, listed by geometric object type, used in the dataset.
The following property is mandatory in a well-formed metadata according ISO 19115:
MD_GeometricObjects
└─geometricObjectType……
Name of point and vector spatial objects used to locate zero-, one-, and two-dimensional spatial locations in 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 Integer
Total number of the point or vector object type occurring in the dataset.private org.opengis.metadata.spatial.GeometricObjectType
Total number of the point or vector object type occurring in the dataset.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 geometric objects.DefaultGeometricObjects
(org.opengis.metadata.spatial.GeometricObjects object) Constructs a new instance initialized with the values from the specified metadata object.DefaultGeometricObjects
(org.opengis.metadata.spatial.GeometricObjectType geometricObjectType) Creates a geometric object initialized to the given type. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGeometricObjects
castOrCopy
(org.opengis.metadata.spatial.GeometricObjects object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the total number of the point or vector object type occurring in the dataset.org.opengis.metadata.spatial.GeometricObjectType
Returns the total number of the point or vector object type occurring in the dataset.void
setGeometricObjectCount
(Integer newValue) Sets the total number of the point or vector object type occurring in the dataset.void
setGeometricObjectType
(org.opengis.metadata.spatial.GeometricObjectType newValue) Sets the total number of the point or vector object type occurring in the dataset.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:
-
geometricObjectType
private org.opengis.metadata.spatial.GeometricObjectType geometricObjectTypeTotal number of the point or vector object type occurring in the dataset. -
geometricObjectCount
Total number of the point or vector object type occurring in the dataset.
-
-
Constructor Details
-
DefaultGeometricObjects
public DefaultGeometricObjects()Constructs an initially empty geometric objects. -
DefaultGeometricObjects
public DefaultGeometricObjects(org.opengis.metadata.spatial.GeometricObjectType geometricObjectType) Creates a geometric object initialized to the given type.- Parameters:
geometricObjectType
- total number of the point or vector object type occurring in the dataset.
-
DefaultGeometricObjects
public DefaultGeometricObjects(org.opengis.metadata.spatial.GeometricObjects 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.Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static DefaultGeometricObjects castOrCopy(org.opengis.metadata.spatial.GeometricObjects 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 already an instance of
DefaultGeometricObjects
, then it is returned unchanged. - Otherwise a new
DefaultGeometricObjects
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
-
getGeometricObjectType
public org.opengis.metadata.spatial.GeometricObjectType getGeometricObjectType()Returns the total number of the point or vector object type occurring in the dataset.- Specified by:
getGeometricObjectType
in interfaceorg.opengis.metadata.spatial.GeometricObjects
- Returns:
- name of spatial objects used to locate spatial locations in the dataset, or
null
.
-
setGeometricObjectType
public void setGeometricObjectType(org.opengis.metadata.spatial.GeometricObjectType newValue) Sets the total number of the point or vector object type occurring in the dataset.- Parameters:
newValue
- the new geometric object type.
-
getGeometricObjectCount
Returns the total number of the point or vector object type occurring in the dataset.- Specified by:
getGeometricObjectCount
in interfaceorg.opengis.metadata.spatial.GeometricObjects
- Returns:
- total number of the point or vector object type, or
null
.
-
setGeometricObjectCount
Sets the total number of the point or vector object type occurring in the dataset.- Parameters:
newValue
- the geometric object count, ornull
.- Throws:
IllegalArgumentException
- if the given value is zero or negative.
-