001: /*
002: * GeoTools - OpenSource mapping toolkit
003: * http://geotools.org
004: * (C) 2003-2006, GeoTools Project Managment Committee (PMC)
005: * (C) 2001, 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.HashMap;
025: import java.util.Map;
026:
027: // OpenGIS dependencies
028: import org.opengis.referencing.datum.EngineeringDatum;
029:
030: // Geotools dependencies
031: import org.geotools.referencing.AbstractIdentifiedObject;
032: import org.geotools.referencing.wkt.Formatter;
033: import org.geotools.resources.i18n.Vocabulary;
034: import org.geotools.resources.i18n.VocabularyKeys;
035: import org.geotools.util.LocalName;
036:
037: /**
038: * Defines the origin of an engineering coordinate reference system. An engineering datum is used
039: * in a region around that origin. This origin can be fixed with respect to the earth (such as a
040: * defined point at a construction site), or be a defined point on a moving vehicle (such as on a
041: * ship or satellite).
042: *
043: * @since 2.1
044: * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/referencing/src/main/java/org/geotools/referencing/datum/DefaultEngineeringDatum.java $
045: * @version $Id: DefaultEngineeringDatum.java 20874 2006-08-07 10:00:01Z jgarnett $
046: * @author Martin Desruisseaux
047: */
048: public class DefaultEngineeringDatum extends AbstractDatum implements
049: EngineeringDatum {
050: /**
051: * Serial number for interoperability with different versions.
052: */
053: private static final long serialVersionUID = 1498304918725248637L;
054:
055: /**
056: * An engineering datum for unknow coordinate reference system. Such CRS are usually
057: * assumed cartesian, but will not have any transformation path to other CRS.
058: *
059: * @see org.geotools.referencing.crs.DefaultEngineeringCRS#CARTESIAN_2D
060: * @see org.geotools.referencing.crs.DefaultEngineeringCRS#CARTESIAN_3D
061: */
062: public static final DefaultEngineeringDatum UNKNOW;
063: static {
064: final Map properties = new HashMap(4);
065: properties.put(NAME_KEY, "Unknow");
066: properties.put(ALIAS_KEY, new LocalName(Vocabulary
067: .formatInternational(VocabularyKeys.UNKNOW)));
068: UNKNOW = new DefaultEngineeringDatum(properties);
069: }
070:
071: /**
072: * Constructs a new datum with the same values than the specified one.
073: * This copy constructor provides a way to wrap an arbitrary implementation into a
074: * Geotools one or a user-defined one (as a subclass), usually in order to leverage
075: * some implementation-specific API. This constructor performs a shallow copy,
076: * i.e. the properties are not cloned.
077: *
078: * @since 2.2
079: */
080: public DefaultEngineeringDatum(final EngineeringDatum datum) {
081: super (datum);
082: }
083:
084: /**
085: * Constructs an engineering datum from a name.
086: *
087: * @param name The datum name.
088: */
089: public DefaultEngineeringDatum(final String name) {
090: this (Collections.singletonMap(NAME_KEY, name));
091: }
092:
093: /**
094: * Constructs an engineering datum from a set of properties. The properties map is given
095: * unchanged to the {@linkplain AbstractDatum#AbstractDatum(Map) super-class constructor}.
096: *
097: * @param properties Set of properties. Should contains at least <code>"name"</code>.
098: */
099: public DefaultEngineeringDatum(final Map properties) {
100: super (properties);
101: }
102:
103: /**
104: * Compare this datum with the specified object for equality.
105: *
106: * @param object The object to compare to {@code this}.
107: * @param compareMetadata {@code true} for performing a strict comparaison, or
108: * {@code false} for comparing only properties relevant to transformations.
109: * @return {@code true} if both objects are equal.
110: */
111: public boolean equals(final AbstractIdentifiedObject object,
112: final boolean compareMetadata) {
113: if (object == this ) {
114: return true; // Slight optimization.
115: }
116: return super .equals(object, compareMetadata);
117: }
118:
119: /**
120: * Format the inner part of a
121: * <A HREF="http://geoapi.sourceforge.net/snapshot/javadoc/org/opengis/referencing/doc-files/WKT.html"><cite>Well
122: * Known Text</cite> (WKT)</A> element.
123: *
124: * @param formatter The formatter to use.
125: * @return The WKT element name, which is "LOCAL_DATUM"
126: */
127: protected String formatWKT(final Formatter formatter) {
128: super .formatWKT(formatter);
129: return "LOCAL_DATUM";
130: }
131: }
|