Module org.apache.sis.metadata
Class DefaultGCPCollection
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractGeolocationInformation
DefaultGCPCollection
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,GCPCollection
,GeolocationInformation
@TitleProperty(name="collectionName")
public class DefaultGCPCollection
extends AbstractGeolocationInformation
implements 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
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
Fields inherited from class ISOMetadata
identifiers
-
Constructor Summary
ConstructorDescriptionConstructs an initially empty ground control point collection.DefaultGCPCollection
(GCPCollection object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGCPCollection
castOrCopy
(GCPCollection object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the identifier of the GCP collection.Returns the name of the GCP collection.Returns the coordinate reference system in which the ground control points are defined.getGCPs()
Returns the ground control point(s) used in the collection.void
setCollectionIdentification
(Integer newValue) Sets the identifier of the GCP collection.void
setCollectionName
(InternationalString newValue) Sets the name of the GCP collection.void
setCoordinateReferenceSystem
(ReferenceSystem newValue) Sets the coordinate reference system in which the ground control points are defined.void
setGCPs
(Collection<? extends GCP> newValues) Sets the ground control point(s) used in the collection.Methods inherited from class AbstractGeolocationInformation
castOrCopy, getQualityInfo, setQualityInfo
Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface GeolocationInformation
getQualityInfo
-
Constructor Details
-
DefaultGCPCollection
public DefaultGCPCollection()Constructs an initially empty ground control point collection. -
DefaultGCPCollection
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 interfaceGCPCollection
- Returns:
- the identifier, or
null
.
-
setCollectionIdentification
Sets the identifier of the GCP collection.- Parameters:
newValue
- the new collection identifier value.
-
getCollectionName
Returns the name of the GCP collection.- Specified by:
getCollectionName
in interfaceGCPCollection
- Returns:
- name of the GCP collection, or
null
.
-
setCollectionName
Sets the name of the GCP collection.- Parameters:
newValue
- the new collection name.
-
getCoordinateReferenceSystem
Returns the coordinate reference system in which the ground control points are defined.- Specified by:
getCoordinateReferenceSystem
in interfaceGCPCollection
- Returns:
- coordinate reference system in which the ground control points are defined, or
null
.
-
setCoordinateReferenceSystem
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 interfaceGCPCollection
- Returns:
- ground control point(s).
-
setGCPs
Sets the ground control point(s) used in the collection.- Parameters:
newValues
- the new ground control points values.
-