org.geotoolkit.referencing.datum.DefaultEngineeringDatum Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-referencing Show documentation
Show all versions of geotk-referencing Show documentation
Implementations of Coordinate Reference Systems (CRS),
conversion and transformation services derived from ISO 19111.
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2001-2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2011, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotoolkit.referencing.datum;
import java.util.Map;
import java.util.Collections;
import net.jcip.annotations.Immutable;
import org.opengis.referencing.datum.EngineeringDatum;
import org.geotoolkit.resources.Vocabulary;
import org.geotoolkit.util.ComparisonMode;
import org.geotoolkit.io.wkt.Formatter;
/**
* Defines the origin of an engineering coordinate reference system. An engineering datum is used
* in a region around that origin. This origin can be fixed with respect to the earth (such as a
* defined point at a construction site), or be a defined point on a moving vehicle (such as on a
* ship or satellite).
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @version 3.19
*
* @since 1.2
* @module
*/
@Immutable
public class DefaultEngineeringDatum extends AbstractDatum implements EngineeringDatum {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 1498304918725248637L;
/**
* An engineering datum for unknown coordinate reference system. Such CRS are usually
* assumed Cartesian, but will not have any transformation path to other CRS.
*
* @see org.geotoolkit.referencing.crs.DefaultEngineeringCRS#CARTESIAN_2D
* @see org.geotoolkit.referencing.crs.DefaultEngineeringCRS#CARTESIAN_3D
*/
public static final DefaultEngineeringDatum UNKNOWN =
new DefaultEngineeringDatum(name(Vocabulary.Keys.UNKNOWN));
/**
* Constructs a new object in which every attributes are set to a default value.
* This is not a valid object. This constructor is strictly
* reserved to JAXB, which will assign values to the fields using reflexion.
*/
private DefaultEngineeringDatum() {
this(org.geotoolkit.internal.referencing.NilReferencingObject.INSTANCE);
}
/**
* Constructs a new datum with the same values than the specified one.
* This copy constructor provides a way to convert an arbitrary implementation into a
* Geotk 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.
*
* @param datum The datum to copy.
*
* @since 2.2
*/
public DefaultEngineeringDatum(final EngineeringDatum datum) {
super(datum);
}
/**
* Constructs an engineering datum from a name.
*
* @param name The datum name.
*/
public DefaultEngineeringDatum(final String name) {
this(Collections.singletonMap(NAME_KEY, name));
}
/**
* Constructs an engineering datum from a set of properties. The properties map is given
* unchanged to the {@linkplain AbstractDatum#AbstractDatum(Map) super-class constructor}.
*
* @param properties Set of properties. Should contains at least {@code "name"}.
*/
public DefaultEngineeringDatum(final Map properties) {
super(properties);
}
/**
* Returns a Geotk datum implementation with the same values than the given arbitrary
* implementation. If the given object is {@code null}, then this method returns {@code 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.
*
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return A Geotk implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*
* @since 3.18
*/
public static DefaultEngineeringDatum castOrCopy(final EngineeringDatum object) {
return (object == null) || (object instanceof DefaultEngineeringDatum)
? (DefaultEngineeringDatum) object : new DefaultEngineeringDatum(object);
}
/**
* @deprecated Renamed {@link #castOrCopy castOrCopy}.
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return The given object as a Geotk implementation.
*/
@Deprecated
public static DefaultEngineeringDatum wrap(final EngineeringDatum object) {
return castOrCopy(object);
}
/**
* Compare this datum with the specified object for equality.
*
* @param object The object to compare to {@code this}.
* @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
* {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only properties
* relevant to transformations.
* @return {@code true} if both objects are equal.
*/
@Override
public boolean equals(final Object object, final ComparisonMode mode) {
if (object == this) {
return true; // Slight optimization.
}
return super.equals(object, mode);
}
/**
* Formats the inner part of a
* Well
* Known Text (WKT) element.
*
* @param formatter The formatter to use.
* @return The WKT element name, which is {@code "LOCAL_DATUM"}.
*/
@Override
public String formatWKT(final Formatter formatter) {
super.formatWKT(formatter);
return "LOCAL_DATUM";
}
}