Class DefaultGCPCollection
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.AbstractGeolocationInformation
org.apache.sis.metadata.iso.spatial.DefaultGCPCollection
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.spatial.GCPCollection
,org.opengis.metadata.spatial.GeolocationInformation
@TitleProperty(name="collectionName")
public class DefaultGCPCollection
extends AbstractGeolocationInformation
implements org.opengis.metadata.spatial.GCPCollection
Information about a control point collection.
The following properties are mandatory in a well-formed metadata according ISO 19115:
MI_GCPCollection
├─collectionIdentification………
Identifier of the GCP collection.
├─collectionName…………………………………
Name of the GCP collection.
├─coordinateReferenceSystem……
Coordinate system in which the ground control points are defined.
└─gcp………………………………………………………………
Ground control point(s) used in the collection.
└─geographicCoordinates……
Geographic or map position of the control point, in either two or three dimensions.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
Identifier of the GCP collection.private org.opengis.util.InternationalString
Name of the GCP collection.private org.opengis.referencing.ReferenceSystem
Coordinate system in which the ground control points are defined.private Collection<org.opengis.metadata.spatial.GCP>
Ground control point(s) used in the collection.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 ground control point collection.DefaultGCPCollection
(org.opengis.metadata.spatial.GCPCollection object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGCPCollection
castOrCopy
(org.opengis.metadata.spatial.GCPCollection object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the identifier of the GCP collection.org.opengis.util.InternationalString
Returns the name of the GCP collection.org.opengis.referencing.ReferenceSystem
Returns the coordinate reference system in which the ground control points are defined.Collection<org.opengis.metadata.spatial.GCP>
getGCPs()
Returns the ground control point(s) used in the collection.void
setCollectionIdentification
(Integer newValue) Sets the identifier of the GCP collection.void
setCollectionName
(org.opengis.util.InternationalString newValue) Sets the name of the GCP collection.void
setCoordinateReferenceSystem
(org.opengis.referencing.ReferenceSystem newValue) Sets the coordinate reference system in which the ground control points are defined.void
setGCPs
(Collection<? extends org.opengis.metadata.spatial.GCP> newValues) Sets the ground control point(s) used in the collection.Methods inherited from class org.apache.sis.metadata.iso.spatial.AbstractGeolocationInformation
castOrCopy, getQualityInfo, setQualityInfo
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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.metadata.spatial.GeolocationInformation
getQualityInfo
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
collectionIdentification
Identifier of the GCP collection. -
collectionName
private org.opengis.util.InternationalString collectionNameName of the GCP collection. -
coordinateReferenceSystem
private org.opengis.referencing.ReferenceSystem coordinateReferenceSystemCoordinate system in which the ground control points are defined. -
GCPs
Ground control point(s) used in the collection.
-
-
Constructor Details
-
DefaultGCPCollection
public DefaultGCPCollection()Constructs an initially empty ground control point collection. -
DefaultGCPCollection
public DefaultGCPCollection(org.opengis.metadata.spatial.GCPCollection 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
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
DefaultGCPCollection
, then it is returned unchanged. - Otherwise a new
DefaultGCPCollection
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
-
getCollectionIdentification
Returns the identifier of the GCP collection.- Specified by:
getCollectionIdentification
in interfaceorg.opengis.metadata.spatial.GCPCollection
- Returns:
- the identifier, or
null
.
-
setCollectionIdentification
Sets the identifier of the GCP collection.- Parameters:
newValue
- the new collection identifier value.
-
getCollectionName
public org.opengis.util.InternationalString getCollectionName()Returns the name of the GCP collection.- Specified by:
getCollectionName
in interfaceorg.opengis.metadata.spatial.GCPCollection
- Returns:
- name of the GCP collection, or
null
.
-
setCollectionName
public void setCollectionName(org.opengis.util.InternationalString newValue) Sets the name of the GCP collection.- Parameters:
newValue
- the new collection name.
-
getCoordinateReferenceSystem
public org.opengis.referencing.ReferenceSystem getCoordinateReferenceSystem()Returns the coordinate reference system in which the ground control points are defined.- Specified by:
getCoordinateReferenceSystem
in interfaceorg.opengis.metadata.spatial.GCPCollection
- Returns:
- coordinate reference system in which the ground control points are defined, or
null
.
-
setCoordinateReferenceSystem
public void setCoordinateReferenceSystem(org.opengis.referencing.ReferenceSystem newValue) Sets the coordinate reference system in which the ground control points are defined.- Parameters:
newValue
- the new coordinate reference system value.
-
getGCPs
Returns the ground control point(s) used in the collection.- Specified by:
getGCPs
in interfaceorg.opengis.metadata.spatial.GCPCollection
- Returns:
- ground control point(s).
-
setGCPs
Sets the ground control point(s) used in the collection.- Parameters:
newValues
- the new ground control points values.
-