001: /*
002: * GeoTools - OpenSource mapping toolkit
003: * http://geotools.org
004: * (C) 2004-2006, GeoTools Project Managment Committee (PMC)
005: * (C) 2004, Institut de Recherche pour le Développement
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation;
010: * version 2.1 of the License.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * This package contains documentation from OpenGIS specifications.
018: * OpenGIS consortium's work is fully acknowledged here.
019: */
020: package org.geotools.referencing.datum;
021:
022: // J2SE dependencies
023: import java.util.Collections;
024: import java.util.Map;
025:
026: // OpenGIS dependencies
027: import org.opengis.referencing.datum.ImageDatum;
028: import org.opengis.referencing.datum.PixelInCell;
029:
030: // Geotools dependencies
031: import org.geotools.referencing.AbstractIdentifiedObject;
032: import org.geotools.referencing.wkt.Formatter;
033: import org.geotools.resources.Utilities;
034:
035: /**
036: * Defines the origin of an image coordinate reference system. An image datum is used in a local
037: * context only. For an image datum, the anchor point is usually either the centre of the image
038: * or the corner of the image.
039: *
040: * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/referencing/src/main/java/org/geotools/referencing/datum/DefaultImageDatum.java $
041: * @version $Id: DefaultImageDatum.java 24607 2007-02-26 22:05:40Z desruisseaux $
042: * @author Martin Desruisseaux
043: *
044: * @since 2.1
045: */
046: public class DefaultImageDatum extends AbstractDatum implements
047: ImageDatum {
048: /**
049: * Serial number for interoperability with different versions.
050: */
051: private static final long serialVersionUID = -4304193511244150936L;
052:
053: /**
054: * Specification of the way the image grid is associated with the image data attributes.
055: */
056: private final PixelInCell pixelInCell;
057:
058: /**
059: * Constructs a new datum with the same values than the specified one.
060: * This copy constructor provides a way to wrap an arbitrary implementation into a
061: * Geotools one or a user-defined one (as a subclass), usually in order to leverage
062: * some implementation-specific API. This constructor performs a shallow copy,
063: * i.e. the properties are not cloned.
064: *
065: * @since 2.2
066: */
067: public DefaultImageDatum(final ImageDatum datum) {
068: super (datum);
069: pixelInCell = datum.getPixelInCell();
070: }
071:
072: /**
073: * Constructs an image datum from a name.
074: *
075: * @param name The datum name.
076: * @param pixelInCell the way the image grid is associated with the image data attributes.
077: */
078: public DefaultImageDatum(final String name,
079: final PixelInCell pixelInCell) {
080: this (Collections.singletonMap(NAME_KEY, name), pixelInCell);
081: }
082:
083: /**
084: * Constructs an image datum from a set of properties. The properties map is given
085: * unchanged to the {@linkplain AbstractDatum#AbstractDatum(Map) super-class constructor}.
086: *
087: * @param properties Set of properties. Should contains at least <code>"name"</code>.
088: * @param pixelInCell the way the image grid is associated with the image data attributes.
089: */
090: public DefaultImageDatum(final Map properties,
091: final PixelInCell pixelInCell) {
092: super (properties);
093: this .pixelInCell = pixelInCell;
094: ensureNonNull("pixelInCell", pixelInCell);
095: }
096:
097: /**
098: * Specification of the way the image grid is associated with the image data attributes.
099: *
100: * @return The way image grid is associated with image data attributes.
101: */
102: public PixelInCell getPixelInCell() {
103: return pixelInCell;
104: }
105:
106: /**
107: * Compare this datum with the specified object for equality.
108: *
109: * @param object The object to compare to {@code this}.
110: * @param compareMetadata {@code true} for performing a strict comparaison, or
111: * {@code false} for comparing only properties relevant to transformations.
112: * @return {@code true} if both objects are equal.
113: */
114: public boolean equals(final AbstractIdentifiedObject object,
115: final boolean compareMetadata) {
116: if (object == this ) {
117: return true; // Slight optimization.
118: }
119: if (super .equals(object, compareMetadata)) {
120: final DefaultImageDatum that = (DefaultImageDatum) object;
121: return Utilities.equals(this .pixelInCell, that.pixelInCell);
122: }
123: return false;
124: }
125:
126: /**
127: * Returns a hash value for this image datum. {@linkplain #getName Name},
128: * {@linkplain #getRemarks remarks} and the like are not taken in account. In
129: * other words, two image datums will return the same hash value if they
130: * are equal in the sense of
131: * <code>{@link #equals equals}(AbstractIdentifiedObject, <strong>false</strong>)</code>.
132: *
133: * @return The hash code value. This value doesn't need to be the same
134: * in past or future versions of this class.
135: */
136: public int hashCode() {
137: return super .hashCode() ^ pixelInCell.hashCode();
138: }
139:
140: /**
141: * Format the inner part of a
142: * <A HREF="http://geoapi.sourceforge.net/snapshot/javadoc/org/opengis/referencing/doc-files/WKT.html"><cite>Well
143: * Known Text</cite> (WKT)</A> element.
144: *
145: * <strong>Note:</strong> WKT of image datum is not yet part of OGC specification.
146: *
147: * @param formatter The formatter to use.
148: * @return The WKT element name.
149: */
150: protected String formatWKT(final Formatter formatter) {
151: super .formatWKT(formatter);
152: formatter.append(pixelInCell);
153: formatter.setInvalidWKT(ImageDatum.class);
154: return "IMAGE_DATUM";
155: }
156: }
|