org.geotools.referencing.datum
Class DefaultImageDatum

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.referencing.datum.AbstractDatum
              org.geotools.referencing.datum.DefaultImageDatum

All Implemented Interfaces:

org.opengis.referencing.datum.Datum, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.datum.ImageDatum, java.io.Serializable

public class DefaultImageDatum

extends AbstractDatum

implements org.opengis.referencing.datum.ImageDatum

Defines the origin of an image coordinate reference system. An image datum is used in a local context only. For an image datum, the anchor point is usually either the centre of the image or the corner of the image.

Since:

2.1

Version:

$Id: DefaultImageDatum.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface org.opengis.referencing.datum.Datum

ANCHOR_POINT_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY, VALID_AREA_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultImageDatum(org.opengis.referencing.datum.ImageDatum datum)
Constructs a new datum with the same values than the specified one.

DefaultImageDatum(java.util.Map properties, org.opengis.referencing.datum.PixelInCell pixelInCell)
Constructs an image datum from a set of properties.

DefaultImageDatum(java.lang.String name, org.opengis.referencing.datum.PixelInCell pixelInCell)
Constructs an image datum from a name.

Method Summary

boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compare this datum with the specified object for equality.
protected java.lang.String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
org.opengis.referencing.datum.PixelInCell	getPixelInCell() Specification of the way the image grid is associated with the image data attributes.
int	hashCode() Returns a hash value for this image datum.

Methods inherited from class org.geotools.referencing.datum.AbstractDatum

getAnchorPoint, getRealizationEpoch, getScope, getValidArea

Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches

Methods inherited from class org.geotools.referencing.wkt.Formattable

toString, toWKT, toWKT, toWKT

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.referencing.datum.Datum

getAnchorPoint, getRealizationEpoch, getScope, getValidArea

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

DefaultImageDatum

public DefaultImageDatum(org.opengis.referencing.datum.ImageDatum datum)

Constructs a new datum with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Since:

2.2

DefaultImageDatum

public DefaultImageDatum(java.lang.String name,
                         org.opengis.referencing.datum.PixelInCell pixelInCell)

Constructs an image datum from a name.

Parameters:

name - The datum name.

pixelInCell - the way the image grid is associated with the image data attributes.

DefaultImageDatum

public DefaultImageDatum(java.util.Map properties,
                         org.opengis.referencing.datum.PixelInCell pixelInCell)

Constructs an image datum from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

pixelInCell - the way the image grid is associated with the image data attributes.

Method Detail

getPixelInCell

public org.opengis.referencing.datum.PixelInCell getPixelInCell()

Specification of the way the image grid is associated with the image data attributes.

Specified by:

getPixelInCell in interface org.opengis.referencing.datum.ImageDatum

Returns:

The way image grid is associated with image data attributes.

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compare this datum with the specified object for equality.

Overrides:

equals in class AbstractDatum

Parameters:

object - The object to compare to .

compareMetadata - for performing a strict comparaison, or for comparing only properties relevant to transformations.

Returns:

if both objects are equal.

hashCode

public int hashCode()

Returns a hash value for this image datum. Name, remarks and the like are not taken in account. In other words, two image datums will return the same hash value if they are equal in the sense of equals(AbstractIdentifiedObject, false).

Overrides:

hashCode in class AbstractIdentifiedObject

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.

formatWKT

protected java.lang.String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element. Note: WKT of image datum is not yet part of OGC specification.

Overrides:

formatWKT in class AbstractDatum

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name.