org.apache.sis.metadata.iso.spatial

Class DefaultGCP

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultGCP

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, GCP

public class DefaultGCP
extends ISOMetadata
implements GCP

Information on ground control point. Ground control points (GCP) are large marked targets on the ground, not to be confused with localization grid points embedded in some file formats like GeoTIFF or netCDF. The following property is mandatory in a well-formed metadata according ISO 19115:

MI_GCP └─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:

Default­GCPCollection, Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor and Description
DefaultGCP() Constructs an initially empty ground control point.
DefaultGCP(GCP object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method and Description
static DefaultGCP	castOrCopy(GCP object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Element>	getAccuracyReports() Returns the accuracy of a ground control point.
DirectPosition	getGeographicCoordinates() Returns the geographic or map position of the control point, in either two or three dimensions.
void	setAccuracyReports(Collection<? extends Element> newValues) Sets the accuracy of a ground control point.
void	setGeographicCoordinates(DirectPosition newValue) Sets the geographic or map position of the control point, in either two or three dimensions.

Methods inherited from class ISOMetadata

freeze, get­Identifier­Map, get­Identifiers, get­Standard

Methods inherited from class ModifiableMetadata

check­Write­Permission, clone, collection­Type, copy­Collection, copy­List, copy­Set, is­Modifiable, non­Null­Collection, non­Null­List, non­Null­Set, singleton, unmodifiable, write­Collection, write­List, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Detail

DefaultGCP

public DefaultGCP()

Constructs an initially empty ground control point.

DefaultGCP

public DefaultGCP(GCP object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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:

cast­Or­Copy(GCP)

Method Detail

castOrCopy

public static DefaultGCP castOrCopy(GCP 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­GCP, then it is returned unchanged.
• Otherwise a new Default­GCP instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.

getGeographicCoordinates

public DirectPosition getGeographicCoordinates()

Returns the geographic or map position of the control point, in either two or three dimensions.

Specified by:

get­Geographic­Coordinates in interface GCP

Returns:

geographic or map position of the control point, or null.

TODO:

finish the annotation on the referencing module before.

setGeographicCoordinates

public void setGeographicCoordinates(DirectPosition newValue)

Sets the geographic or map position of the control point, in either two or three dimensions.

Parameters:

new­Value - the new geographic coordinates values.

getAccuracyReports

public Collection<Element> getAccuracyReports()

Returns the accuracy of a ground control point.

Specified by:

get­Accuracy­Reports in interface GCP

Returns:

accuracy of a ground control point.

setAccuracyReports

public void setAccuracyReports(Collection<? extends Element> newValues)

Sets the accuracy of a ground control point.

Parameters:

new­Values - the new accuracy report values.