org.geotoolkit.metadata.iso.spatial
Class DefaultDimension

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultDimension

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Dimension

@ThreadSafe
public class DefaultDimension
extends MetadataEntity
implements Dimension

Axis properties.

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

DefaultDimension()
Constructs an initially empty dimension.

DefaultDimension(Dimension source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultDimension(DimensionNameType dimensionName, int dimensionSize)
Creates a dimension initialized to the given type.

Method Summary

static DefaultDimension	castOrCopy(Dimension object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
DimensionNameType	getDimensionName() Returns the name of the axis.
Integer	getDimensionSize() Returns the number of elements along the axis.
Double	getResolution() Returns the degree of detail in the grid dataset.
void	setDimensionName(DimensionNameType newValue) Sets the name of the axis.
void	setDimensionSize(Integer newValue) Sets the number of elements along the axis.
void	setResolution(Double newValue) Sets the degree of detail in the grid dataset.

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

DefaultDimension

public DefaultDimension()

Constructs an initially empty dimension.

DefaultDimension

public DefaultDimension(Dimension 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

DefaultDimension

public DefaultDimension(DimensionNameType dimensionName,
                        int dimensionSize)

Creates a dimension initialized to the given type.

Parameters:

dimensionName - The name of the axis.

dimensionSize - The number of elements along the axis.

Method Detail

castOrCopy

public static DefaultDimension castOrCopy(Dimension 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

getDimensionName

public DimensionNameType getDimensionName()

Returns the name of the axis.

Specified by:

getDimensionName in interface Dimension

setDimensionName

public void setDimensionName(DimensionNameType newValue)

Sets the name of the axis.

Parameters:

newValue - The new dimension name.

getDimensionSize

@ValueRange(minimum=0.0)
public Integer getDimensionSize()

Returns the number of elements along the axis.

Specified by:

getDimensionSize in interface Dimension

setDimensionSize

public void setDimensionSize(Integer newValue)

Sets the number of elements along the axis.

Parameters:

newValue - The new dimension size.

getResolution

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

Returns the degree of detail in the grid dataset.

Specified by:

getResolution in interface Dimension

setResolution

public void setResolution(Double newValue)

Sets the degree of detail in the grid dataset.

Parameters:

newValue - The new resolution.