org.geotoolkit.metadata.iso.spatial
Class DefaultGeoreferenceable

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractSpatialRepresentation
                  DefaultGridSpatialRepresentation
                      DefaultGeoreferenceable

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Georeferenceable, GridSpatialRepresentation, SpatialRepresentation

@ThreadSafe
public class DefaultGeoreferenceable
extends DefaultGridSpatialRepresentation
implements Georeferenceable

Grid with cells irregularly spaced in any given geographic/map projection coordinate system, whose individual cells can be geolocated using geolocation information supplied with the data but cannot be geolocated from the grid properties alone.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (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

DefaultGeoreferenceable()
Constructs an initially empty georeferenceable.

DefaultGeoreferenceable(Georeferenceable source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultGeoreferenceable(int numberOfDimensions, List<? extends Dimension> axisDimensionsProperties, CellGeometry cellGeometry, boolean transformationParameterAvailable, boolean controlPointAvailable, boolean orientationParameterAvailable)
Creates a georeferencable initialized to the given parameters.

Method Summary

static DefaultGeoreferenceable	castOrCopy(Georeferenceable object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<GeolocationInformation>	getGeolocationInformation() Returns the information that can be used to geolocate the data.
Record	getGeoreferencedParameters() Returns the terms which support grid data georeferencing.
InternationalString	getOrientationParameterDescription() Returns a description of parameters used to describe sensor orientation.
Collection<Citation>	getParameterCitations() Returns a reference providing description of the parameters.
boolean	isControlPointAvailable() Returns an indication of whether or not control point(s) exists.
boolean	isOrientationParameterAvailable() Returns an indication of whether or not orientation parameters are available.
void	setControlPointAvailable(boolean newValue) Sets an indication of whether or not control point(s) exists.
void	setGeolocationInformation(Collection<? extends GeolocationInformation> newValues) Sets the information that can be used to geolocate the data.
void	setGeoreferencedParameters(Record newValue) Sets the terms which support grid data georeferencing.
void	setOrientationParameterAvailable(boolean newValue) Sets an indication of whether or not orientation parameters are available.
void	setOrientationParameterDescription(InternationalString newValue) Sets a description of parameters used to describe sensor orientation.
void	setParameterCitations(Collection<? extends Citation> newValues) Sets a reference providing description of the parameters.

Methods inherited from class DefaultGridSpatialRepresentation

castOrCopy, getAxisDimensionProperties, getCellGeometry, getNumberOfDimensions, isTransformationParameterAvailable, setAxisDimensionProperties, setCellGeometry, setNumberOfDimensions, setTransformationParameterAvailable

Methods inherited from class AbstractSpatialRepresentation

castOrCopy

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 GridSpatialRepresentation

getAxisDimensionProperties, getCellGeometry, getNumberOfDimensions, isTransformationParameterAvailable

Constructor Detail

DefaultGeoreferenceable

public DefaultGeoreferenceable()

Constructs an initially empty georeferenceable.

DefaultGeoreferenceable

public DefaultGeoreferenceable(Georeferenceable source)

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

Parameters:

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

Since:

2.4

DefaultGeoreferenceable

public DefaultGeoreferenceable(int numberOfDimensions,
                               List<? extends Dimension> axisDimensionsProperties,
                               CellGeometry cellGeometry,
                               boolean transformationParameterAvailable,
                               boolean controlPointAvailable,
                               boolean orientationParameterAvailable)

Creates a georeferencable initialized to the given parameters.

Parameters:

numberOfDimensions - The number of independent spatial-temporal axes.

axisDimensionsProperties - Information about spatial-temporal axis properties.

cellGeometry - Identification of grid data as point or cell.

transformationParameterAvailable - Indication of whether or not parameters for transformation exists.

controlPointAvailable - An indication of whether or not control point(s) exists.

orientationParameterAvailable - An indication of whether or not orientation parameters are available.

Method Detail

castOrCopy

public static DefaultGeoreferenceable castOrCopy(Georeferenceable 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

isControlPointAvailable

public boolean isControlPointAvailable()

Returns an indication of whether or not control point(s) exists.

Specified by:

isControlPointAvailable in interface Georeferenceable

setControlPointAvailable

public void setControlPointAvailable(boolean newValue)

Sets an indication of whether or not control point(s) exists.

Parameters:

newValue - true if control points are available.

isOrientationParameterAvailable

public boolean isOrientationParameterAvailable()

Returns an indication of whether or not orientation parameters are available.

Specified by:

isOrientationParameterAvailable in interface Georeferenceable

setOrientationParameterAvailable

public void setOrientationParameterAvailable(boolean newValue)

Sets an indication of whether or not orientation parameters are available.

Parameters:

newValue - true if orientation parameter are available.

getOrientationParameterDescription

public InternationalString getOrientationParameterDescription()

Returns a description of parameters used to describe sensor orientation.

Specified by:

getOrientationParameterDescription in interface Georeferenceable

setOrientationParameterDescription

public void setOrientationParameterDescription(InternationalString newValue)

Sets a description of parameters used to describe sensor orientation.

Parameters:

newValue - The new orientation parameter description.

getGeoreferencedParameters

public Record getGeoreferencedParameters()

Returns the terms which support grid data georeferencing.

Specified by:

getGeoreferencedParameters in interface Georeferenceable

Since:

2.4

setGeoreferencedParameters

public void setGeoreferencedParameters(Record newValue)

Sets the terms which support grid data georeferencing.

Parameters:

newValue - The new georeferenced parameters.

Since:

2.4

getParameterCitations

public Collection<Citation> getParameterCitations()

Returns a reference providing description of the parameters.

Specified by:

getParameterCitations in interface Georeferenceable

setParameterCitations

public void setParameterCitations(Collection<? extends Citation> newValues)

Sets a reference providing description of the parameters.

Parameters:

newValues - The new parameter citations.

getGeolocationInformation

public Collection<GeolocationInformation> getGeolocationInformation()

Returns the information that can be used to geolocate the data.

Specified by:

getGeolocationInformation in interface Georeferenceable

Since:

3.03

TODO:

This attribute is declared as mandatory in ISO 19115-2. However metadata compliant with ISO 19115 (without the -2 part) do not contains this attribute. How should we handle the XML formatting for this one?

setGeolocationInformation

public void setGeolocationInformation(Collection<? extends GeolocationInformation> newValues)

Sets the information that can be used to geolocate the data.

Parameters:

newValues - The new geolocation information values.

Since:

3.03