org.geotoolkit.metadata.iso.identification
Class DefaultResolution

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultResolution

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Resolution

@ThreadSafe
public class DefaultResolution
extends MetadataEntity
implements Resolution

Level of detail expressed as a scale factor or a ground distance.

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

DefaultResolution()
Constructs an initially empty Resolution.

DefaultResolution(Resolution source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultResolution	castOrCopy(Resolution object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Double	getDistance() Ground sample distance.
RepresentativeFraction	getEquivalentScale() Level of detail expressed as the scale of a comparable hardcopy map or chart.
void	setDistance(Double newValue) Sets the ground sample distance.
void	setEquivalentScale(RepresentativeFraction newValue) Sets the level of detail expressed as the scale of a comparable hardcopy map or chart.

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

DefaultResolution

public DefaultResolution()

Constructs an initially empty Resolution.

DefaultResolution

public DefaultResolution(Resolution 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

Method Detail

castOrCopy

public static DefaultResolution castOrCopy(Resolution 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

getEquivalentScale

public RepresentativeFraction getEquivalentScale()

Level of detail expressed as the scale of a comparable hardcopy map or chart. Only one of equivalent scale and ground sample distance may be provided.

Specified by:

getEquivalentScale in interface Resolution

setEquivalentScale

public void setEquivalentScale(RepresentativeFraction newValue)

Sets the level of detail expressed as the scale of a comparable hardcopy map or chart.

Parameters:

newValue - The new equivalent scale.

Since:

2.4

getDistance

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

Ground sample distance. Only one of equivalent scale and ground sample distance may be provided.

Specified by:

getDistance in interface Resolution

setDistance

public void setDistance(Double newValue)

Sets the ground sample distance.

Parameters:

newValue - The new distance.