Package org.apache.sis.referencing.datum
Class AbstractDatum
Object
FormattableObject
AbstractIdentifiedObject
AbstractDatum
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,Datum,IdentifiedObject
- Direct Known Subclasses:
DefaultEngineeringDatum,DefaultGeodeticDatum,DefaultImageDatum,DefaultParametricDatum,DefaultTemporalDatum,DefaultVerticalDatum
Specifies the relationship of a Coordinate System to the earth.
A datum can be defined as a set of real points on the earth that have coordinates.
Each datum subtype can be associated with only specific types of
coordinate systems, thus creating specific types of
coordinate reference system.
Instantiation
This class is conceptually abstract, even if it is technically possible to instantiate it. Typical applications should create instances of the most specific subclass prefixed byDefault instead.
Immutability and thread safety
This base class is immutable if the property values (not necessarily the map itself) given to the constructor are also immutable. Most SIS subclasses and related classes are immutable under similar conditions. This means that unless otherwise noted in the javadoc,Datum instances created using only SIS factories
and static constants can be shared by many objects and passed between threads without synchronization.- Since:
- 0.4
- See Also:
Defined in the sis-referencing module
-
Field Summary
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEYFields inherited from interface Datum
ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY -
Constructor Summary
ConstructorsModifierConstructorDescriptionAbstractDatum(Map<String, ?> properties) Creates a datum from the given properties.protectedAbstractDatum(Datum datum) Creates a new datum with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractDatumcastOrCopy(Datum object) Returns a SIS datum implementation with the values of the given arbitrary implementation.protected longInvoked byhashCode()for computing the hash code when first needed.booleanequals(Object object, ComparisonMode mode) Compares the specified object with this datum for equality.protected StringFormats the inner part of the Well Known Text (WKT) representation for this datum.Returns a description of the point(s) used to anchor the datum to the Earth.Returns the region or timeframe in which this datum is valid, ornullif unspecified.Returns the GeoAPI interface implemented by this class.The time after which this datum definition is valid.Returns the domain or limitations of usage, ornullif unspecified.booleanReturnstrueif either the primary name or at least one alias matches the given string according heuristic rules.Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecatedMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Constructor Details
-
AbstractDatum
Creates a datum from the given properties. The properties given in argument follow the same rules than for the super-class constructor. Additionally, the following properties are understood by this constructor:Recognized properties (non exhaustive list) Property name Value type Returned by "anchorPoint" InternationalStringorStringgetAnchorPoint()"realizationEpoch" DategetRealizationEpoch()"domainOfValidity" ExtentgetDomainOfValidity()"scope" InternationalStringorStringgetScope()Defined in parent class (reminder) "name" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()- Parameters:
properties- the properties to be given to the identified object.
-
AbstractDatum
Creates 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.
-
-
Method Details
-
castOrCopy
Returns a SIS datum implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null, then this method returnsnull. - Otherwise if the given object is an instance of
GeodeticDatum,VerticalDatum,TemporalDatum,EngineeringDatumorImageDatum, then this method delegates to thecastOrCopy(…)method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)method to be used is unspecified. - Otherwise if the given object is already an instance of
AbstractDatum, then it is returned unchanged. - Otherwise a new
AbstractDatuminstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other properties contained in the given object are not recursively copied.
- Parameters:
object- the object to get as a SIS implementation, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getInterface
Returns the GeoAPI interface implemented by this class. The default implementation returnsDatum.class. Subclasses implementing a more specific GeoAPI interface shall override this method.- Overrides:
getInterfacein classAbstractIdentifiedObject- Returns:
- the datum interface implemented by this class.
-
getAnchorPoint
Returns a description of the point(s) used to anchor the datum to the Earth. Also known as the "origin", especially for Engineering and Image Datums.- For a geodetic datum, the anchor may be the point(s) where the relationship between geoid and ellipsoid is defined.
- For an engineering datum, the anchor may be an identified physical point with the orientation defined relative to the object.
- For an image datum, the anchor point may be the centre or the corner of the image.
- For a temporal datum, see their origin instead.
- Specified by:
getAnchorPointin interfaceDatum- Returns:
- description, possibly including coordinates, of the point or points used to anchor the datum to the Earth.
-
getRealizationEpoch
The time after which this datum definition is valid. This time may be precise or merely a year.If an old datum is superseded by a new datum, then the realization epoch for the new datum defines the upper limit for the validity of the old datum.
- Specified by:
getRealizationEpochin interfaceDatum- Returns:
- the time after which this datum definition is valid, or
nullif none.
-
getDomainOfValidity
Returns the region or timeframe in which this datum is valid, ornullif unspecified.- Specified by:
getDomainOfValidityin interfaceDatum- Returns:
- area or region or timeframe in which this datum is valid, or
null. - See Also:
-
getScope
Returns the domain or limitations of usage, ornullif unspecified. -
isHeuristicMatchForName
Returnstrueif either the primary name or at least one alias matches the given string according heuristic rules. This method performs the comparison documented in the super-class, with the following additional flexibility:- The
"D_"prefix (used in ESRI datum names), if presents in the given name or in this datum name, is ignored. - If this datum is an instance of
DefaultGeodeticDatum, then the prime meridian name may also be ignored.
Future evolutions
This method implements heuristic rules learned from experience while trying to provide inter-operability with different data producers. Those rules may be adjusted in any future SIS version according experience gained while working with more data producers.- Overrides:
isHeuristicMatchForNamein classAbstractIdentifiedObject- Parameters:
name- the name to compare.- Returns:
trueif the primary name or at least one alias matches the specifiedname.- See Also:
- The
-
equals
Compares the specified object with this datum for equality. If themodeargument value isSTRICTorBY_CONTRACT, then all available properties are compared including the anchor point, realization epoch, domain of validity and the scope.- Specified by:
equalsin interfaceLenientComparable- Overrides:
equalsin classAbstractIdentifiedObject- Parameters:
object- the object to compare tothis.mode-STRICTfor performing a strict comparison, orIGNORE_METADATAfor comparing only properties relevant to coordinate transformations.- Returns:
trueif both objects are equal.- See Also:
-
computeHashCode
protected long computeHashCode()Invoked byhashCode()for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()for more information.- Overrides:
computeHashCodein classAbstractIdentifiedObject- Returns:
- the hash code value. This value may change in any future Apache SIS version.
-
formatTo
Formats the inner part of the Well Known Text (WKT) representation for this datum. SeeAbstractIdentifiedObject.formatTo(Formatter)for more information.- Overrides:
formatToin classAbstractIdentifiedObject- Parameters:
formatter- the formatter where to format the inner content of this WKT element.- Returns:
- the CamelCase keyword
for the WKT element, or
nullif unknown. - See Also:
-