org.geotoolkit.metadata.iso.lineage
Class DefaultNominalResolution

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultNominalResolution

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, NominalResolution

@ThreadSafe
public class DefaultNominalResolution
extends MetadataEntity
implements NominalResolution

Distance between consistent parts of (centre, left side, right side) adjacent pixels.

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

DefaultNominalResolution()
Constructs an initially empty nominal resolution.

DefaultNominalResolution(NominalResolution source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultNominalResolution	castOrCopy(NominalResolution object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Double	getGroundResolution() Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.
Double	getScanningResolution() Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.
void	setGroundResolution(Double newValue) Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.
void	setScanningResolution(Double newValue) Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

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

Constructor Detail

DefaultNominalResolution

public DefaultNominalResolution()

Constructs an initially empty nominal resolution.

DefaultNominalResolution

public DefaultNominalResolution(NominalResolution 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 DefaultNominalResolution castOrCopy(NominalResolution 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

getScanningResolution

@ValueRange(minimum=0.0,
            isMinIncluded=false)
public Double getScanningResolution()

Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

Specified by:

getScanningResolution in interface NominalResolution

setScanningResolution

public void setScanningResolution(Double newValue)

Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

Parameters:

newValue - The new scanning resolution value.

getGroundResolution

@ValueRange(minimum=0.0,
            isMinIncluded=false)
public Double getGroundResolution()

Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.

Specified by:

getGroundResolution in interface NominalResolution

setGroundResolution

public void setGroundResolution(Double newValue)

Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.

Parameters:

newValue - The new ground resolution value.