org.geotoolkit.metadata.iso.spatial
Class DefaultGCPCollection

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractGeolocationInformation
                  DefaultGCPCollection

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, GCPCollection, GeolocationInformation

@ThreadSafe
public class DefaultGCPCollection
extends AbstractGeolocationInformation
implements GCPCollection

Information about a control point collection.

Since:

3.03

Version:

3.19

Author:

Cédric Briançon (Geomatys), Martin Desruisseaux (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

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

DefaultGCPCollection(GCPCollection source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultGCPCollection	castOrCopy(GCPCollection object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Integer	getCollectionIdentification() Returns the identifier of the GCP collection.
InternationalString	getCollectionName() Returns the name of the GCP collection.
ReferenceSystem	getCoordinateReferenceSystem() Returns the coordinate system in which the ground control points are defined.
Collection<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(InternationalString newValue) Sets the name of the GCP collection.
void	setCoordinateReferenceSystem(ReferenceSystem newValue) Sets the coordinate 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 MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GeolocationInformation

getQualityInfo

Constructor Detail

DefaultGCPCollection

public DefaultGCPCollection()

Constructs an initially empty ground control point collection.

DefaultGCPCollection

public DefaultGCPCollection(GCPCollection source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Method Detail

castOrCopy

public static DefaultGCPCollection castOrCopy(GCPCollection object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getCollectionIdentification

public Integer getCollectionIdentification()

Returns the identifier of the GCP collection.

Specified by:

getCollectionIdentification in interface GCPCollection

setCollectionIdentification

public void setCollectionIdentification(Integer newValue)

Sets the identifier of the GCP collection.

Parameters:

newValue - The new collection identifier value.

getCollectionName

public InternationalString getCollectionName()

Returns the name of the GCP collection.

Specified by:

getCollectionName in interface GCPCollection

setCollectionName

public void setCollectionName(InternationalString newValue)

Sets the name of the GCP collection.

Parameters:

newValue - The new collection name.

getCoordinateReferenceSystem

public ReferenceSystem getCoordinateReferenceSystem()

Returns the coordinate system in which the ground control points are defined.

Specified by:

getCoordinateReferenceSystem in interface GCPCollection

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(ReferenceSystem newValue)

Sets the coordinate system in which the ground control points are defined.

Parameters:

newValue - The new coordinate reference system value.

getGCPs

public Collection<GCP> getGCPs()

Returns the ground control point(s) used in the collection.

Specified by:

getGCPs in interface GCPCollection

setGCPs

public void setGCPs(Collection<? extends GCP> newValues)

Sets the ground control point(s) used in the collection.

Parameters:

newValues - The new ground control points values.