Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.spatial

Class DefaultGCPCollection

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractGeolocationInformation
DefaultGCPCollection
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, GCPCollection, Geolocation­Information
@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   ├─collection­Identification……… Identifier of the GCP collection.   ├─collection­Name………………………………… Name of the GCP collection.   ├─coordinate­Reference­System…… Coordinate system in which the ground control points are defined.   └─gcp……………………………………………………………… Ground control point(s) used in the collection.       └─geographic­Coordinates…… 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:

  • Constructor Details

    • DefaultGCPCollection

      public DefaultGCPCollection()
      Constructs an initially empty ground control point collection.

    • DefaultGCPCollection

      public DefaultGCPCollection(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, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultGCPCollection castOrCopy(GCPCollection 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 returns null.
      • Otherwise if the given object is already an instance of Default­GCPCollection, then it is returned unchanged.
      • Otherwise a new Default­GCPCollection 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, or null 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.

    • getCollectionIdentification

      public Integer getCollectionIdentification()
      Returns the identifier of the GCP collection.
      Specified by:
      get­Collection­Identification in interface GCPCollection
      Returns:
      the identifier, or null.

    • setCollectionIdentification

      public void setCollectionIdentification(Integer newValue)
      Sets the identifier of the GCP collection.
      Parameters:
      new­Value - the new collection identifier value.

    • getCollectionName

      public InternationalString getCollectionName()
      Returns the name of the GCP collection.
      Specified by:
      get­Collection­Name in interface GCPCollection
      Returns:
      name of the GCP collection, or null.

    • setCollectionName

      public void setCollectionName(InternationalString newValue)
      Sets the name of the GCP collection.
      Parameters:
      new­Value - the new collection name.

    • getCoordinateReferenceSystem

      public ReferenceSystem getCoordinateReferenceSystem()
      Returns the coordinate reference system in which the ground control points are defined.
      Specified by:
      get­Coordinate­Reference­System in interface GCPCollection
      Returns:
      coordinate reference system in which the ground control points are defined, or null.

    • setCoordinateReferenceSystem

      public void setCoordinateReferenceSystem(ReferenceSystem newValue)
      Sets the coordinate reference system in which the ground control points are defined.
      Parameters:
      new­Value - the new coordinate reference system value.

    • getGCPs

      public Collection<GCP> getGCPs()
      Returns the ground control point(s) used in the collection.
      Specified by:
      get­GCPs in interface GCPCollection
      Returns:
      ground control point(s).

    • setGCPs

      public void setGCPs(Collection<? extends GCP> newValues)
      Sets the ground control point(s) used in the collection.
      Parameters:
      new­Values - the new ground control points values.