Package org.apache.sis.referencing.datum
Class DefaultVerticalDatum
Object
FormattableObject
AbstractIdentifiedObject
AbstractDatum
DefaultVerticalDatum
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- Datum,- VerticalDatum,- IdentifiedObject
Identifies a particular reference level surface used as a zero-height surface.
 There are several types of vertical datums, and each may place constraints on the
 coordinate system axis with which
 it is combined to create a vertical CRS.
 
Creating new vertical datum instances
New instances can be created either directly by specifying all information to a factory method (choices 3 and 4 below), or indirectly by specifying the identifier of an entry in a database (choices 1 and 2 below). Choice 1 in the following list is the easiest but most restrictive way to get a vertical datum. The other choices provide more freedom.- Create a VerticalDatumfrom one of the static convenience shortcuts listed inCommonCRS.Vertical.datum().
- Create a VerticalDatumfrom an identifier in a database by invokingDatumAuthorityFactory.createVerticalDatum(String).
- Create a VerticalDatumby invoking theDatumFactory.createVerticalDatum(…)method (implemented for example byGeodeticObjectFactory).
- Create a DefaultVerticalDatumby invoking the constructor.
VerticalDatum datum = CommonCRS.Vertical.GEOID.datum();
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.- Since:
- 0.4
- See Also:
Defined in the sis-referencing module
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, LOCALE_KEYFields inherited from interface DatumANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultVerticalDatum(Map<String, ?> properties, VerticalDatumType type) Creates a vertical datum from the given properties.protectedCreates a new datum with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultVerticalDatumcastOrCopy(VerticalDatum object) Returns a SIS datum implementation with the same values than the given arbitrary implementation.protected longInvoked byhashCode()for computing the hash code when first needed.booleanequals(Object object, ComparisonMode mode) Compare this vertical datum with the specified object for equality.protected StringFormats this datum as a Well Known TextVerticalDatum[…]element.Class<? extends VerticalDatum>Returns the GeoAPI interface implemented by this class.Returns the type of this vertical datum.Methods inherited from class AbstractDatumcastOrCopy, getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope, isHeuristicMatchForNameMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecatedMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface DatumgetAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScopeMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKT
- 
Constructor Details- 
DefaultVerticalDatumCreates a vertical datum from the given properties. The properties map is given unchanged to the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"anchorPoint" InternationalStringorStringAbstractDatum.getAnchorPoint()"realizationEpoch" DateAbstractDatum.getRealizationEpoch()"domainOfValidity" ExtentAbstractDatum.getDomainOfValidity()"scope" InternationalStringorStringAbstractDatum.getScope()- Parameters:
- properties- the properties to be given to the identified object.
- type- the type of this vertical datum.
- See Also:
 
- 
DefaultVerticalDatumCreates a new datum with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS 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. - Parameters:
- datum- the datum to copy.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS datum implementation with the same values than the given arbitrary implementation. If the given object isnull, then this method returnsnull. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- Parameters:
- object- the object to get as a SIS implementation, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsVerticalDatum.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineVerticalDatumsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
- getInterfacein class- AbstractDatum
- Returns:
- VerticalDatum.classor a user-defined sub-interface.
 
- 
getVerticalDatumTypeReturns the type of this vertical datum.Historical note: this property was defined in the ISO 19111 specification published in 2003, but removed from the revision published 2007. This property provides an information similar to the anchor definition, but in a programmatic way more suitable to coordinate transformation engines.- Specified by:
- getVerticalDatumTypein interface- VerticalDatum
- Returns:
- the type of this vertical datum.
 
- 
equalsCompare this vertical datum with the specified object for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractDatum
- Parameters:
- object- the object to compare to- this.
- mode-- STRICTfor performing a strict comparison, or- IGNORE_METADATAfor comparing only properties relevant to coordinate transformations.
- Returns:
- trueif both objects are equal.
- See Also:
 
- 
computeHashCodeprotected long computeHashCode()Invoked byhashCode()for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()for more information.- Overrides:
- computeHashCodein class- AbstractDatum
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
 
- 
formatToFormats this datum as a Well Known TextVerticalDatum[…]element.Compatibility note: OGC 01-009 defined numerical codes for various vertical datum types, for example 2005 for geoidal height and 2002 for ellipsoidal height. Such codes were formatted for allDatumsubtypes in WKT 1. Datum types became provided only for vertical datum in the ISO 19111:2003 specification, then removed completely in ISO 19111:2007.- Overrides:
- formatToin class- AbstractDatum
- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "VerticalDatum"(WKT 2) or- "Vert_Datum"(WKT 1).
- See Also:
 
 
-