Class DefaultDatumEnsemble<D extends Datum>

Object

FormattableObject

AbstractIdentifiedObject

DefaultDatumEnsemble<D>

Type Parameters:

D - the type of datum members contained in this ensemble.

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Datum, Identified­Object

@UML(identifier="DatumEnsemble",
     specification=ISO_19111)
public class DefaultDatumEnsemble<D extends Datum>
extends AbstractIdentifiedObject
implements Datum

Collection of datums which for low accuracy requirements may be considered to be insignificantly different from each other. Coordinate transformations between different members of an ensemble can be omitted if the ensemble accuracy is sufficient.

Ensemble viewed as a datum

While a Datum­Ensemble is theoretically not a Datum, it is sometime convenient to handle the ensemble as if it was a datum. Therefore, Apache SIS implementation of Datum­Ensemble implements also the Datum interface. This is a non-standard approach for making easier to handle Datum and Datum­Ensemble with the same code. A similar approach is used in the EPSG database, which stores ensembles in the same table as the datums.

It is illegal to use this double inheritance for returning a Datum­Ensemble from Single­CRS.get­Datum(), or for creating a Datum­Ensemble containing a nested Datum­Ensemble. The Apache SIS constructors verify these constraints. For getting a single object which may be a datum or an ensemble, see the Datum­Or­Ensemble static methods.

Since:

1.5

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_POINT_KEY	Key for the "anchor­Point" property to be given to the datum factory create­Foo(…) methods.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the datum factory create­Foo(…) methods.
static final String	REALIZATION_EPOCH_KEY	Key for the "realization­Epoch" property to be given to the datum factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the datum factory create­Foo(…) methods.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default­Datum­Ensemble(Map<String,?> properties, Collection<? extends D> members, Positional­Accuracy accuracy, Class<D> member­Type)	Creates a datum ensemble from the given properties.
protected	Default­Datum­Ensemble(Default­Datum­Ensemble<? extends D> ensemble, Class<D> member­Type)	Creates a new ensemble with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
<N extends Datum> Default­Datum­Ensemble<N>	cast(Class<N> member­Type)	Returns this datum ensemble as a collection of datum of the given type.
static <D extends Datum> Default­Datum­Ensemble<D>	create(Map<String,?> properties, Class<D> member­Type, Collection<? extends D> members, Positional­Accuracy accuracy)	Creates a datum ensemble from the given properties.
International­String	get­Anchor­Point()	Returns an anchor point which is common to all members of the datum ensemble.
Extent	get­Domain­Of­Validity()	Returns a domain of validity which is common to all members of the datum ensemble.
Positional­Accuracy	get­Ensemble­Accuracy()	Returns the inaccuracy introduced through use of this ensemble.
double	get­Linear­Accuracy()	Returns an estimation of positional accuracy in metres, or Na­N if unknown.
final Collection<D>	get­Members()	Returns the datum or reference frames which are members of this ensemble.
Date	get­Realization­Epoch()	Returns a realization epoch which is common to all members of the datum ensemble.
International­String	get­Scope()	Returns a scope which is common to all members of the datum ensemble.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Interface, get­Name, get­Remarks, hash­Code, is­Deprecated

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

DefaultDatumEnsemble

protected DefaultDatumEnsemble(Map<String,?> properties,
 Collection<? extends D> members,
 PositionalAccuracy accuracy,
 Class<D> memberType)

Creates a datum ensemble from the given properties. The properties given in argument follow the same rules as for the super-class constructor.

Recognized properties (non exhaustive list)

Property name	Value type	Returned by
"name"	invalid reference Identifier or String	AbstractIdentifiedObject.getName()
"alias"	invalid reference Generic­Name or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	invalid reference Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	invalid reference org.opengis.referencing.Object­Domain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the identified object.

members - datum or reference frames which are members of this ensemble.

accuracy - inaccuracy introduced through use of this ensemble (mandatory).

member­Type - the base type of datum members contained in this ensemble.

Throws:

Class­Cast­Exception - if a member is not an instance of member­Type.

Illegal­Argument­Exception - if a member is an instance of Datum­Ensemble, of if at least two different conventional reference systems are found.

See Also:

• create(Map, Class, Collection, Positional­Accuracy)

DefaultDatumEnsemble

protected DefaultDatumEnsemble(DefaultDatumEnsemble<? extends D> ensemble,
 Class<D> memberType)

Creates a new ensemble with the same values as 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:

ensemble - the ensemble to copy.

member­Type - the base type of datum members contained in this ensemble.

Throws:

Class­Cast­Exception - if a member is not an instance of member­Type.

Illegal­Argument­Exception - if a member is an instance of Datum­Ensemble, of if at least two different conventional reference systems are found.

Method Details

create

public static <D extends Datum>
DefaultDatumEnsemble<D> create(Map<String,?> properties,
 Class<D> memberType,
 Collection<? extends D> members,
 PositionalAccuracy accuracy)

Creates a datum ensemble from the given properties. The content of the properties map is described in the constructor. The returned ensemble may implement the Geodetic­Datum, Vertical­Datum, Temporal­Datum, or Engineering­Datum interface if all members are instances of the same interface.

Type Parameters:

D - the type of datum members contained in the ensemble to create.

Parameters:

properties - the properties to be given to the identified object.

member­Type - type of members, or null for automatic.

members - datum or reference frames which are members of this ensemble.

accuracy - inaccuracy introduced through use of this ensemble (mandatory).

Returns:

the datum ensemble.

Throws:

Illegal­Argument­Exception - if a member is an instance of Datum­Ensemble, of if at least two different conventional reference systems are found.

cast

public <N extends Datum> DefaultDatumEnsemble<N> cast(Class<N> memberType)

Returns this datum ensemble as a collection of datum of the given type. This method casts the datum members, it does not copy or rewrite them. However, the returned Datum­Ensemble may be a different instance.

Type Parameters:

N - compile-time value of member­Type.

Parameters:

member­Type - the new desired type of datum members.

Returns:

an ensemble of datum of the given type.

Throws:

Class­Cast­Exception - if at least one member is not an instance of the specified type.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Identified­Object

Returns:

Datum­Ensemble.class or a user-defined sub-interface.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getMembers

public final Collection<D> getMembers()

Returns the datum or reference frames which are members of this ensemble. The returned list is immutable.

Returns:

datum or reference frames which are members of this ensemble.

getEnsembleAccuracy

public PositionalAccuracy getEnsembleAccuracy()

Returns the inaccuracy introduced through use of this ensemble.

Returns:

inaccuracy introduced through use of this ensemble.

getLinearAccuracy

public double getLinearAccuracy()

Returns an estimation of positional accuracy in metres, or Na­N if unknown. If at least one quantitative result is found with a linear unit, then returns the largest result value converted to metres.

Returns:

the accuracy estimation (always in meters), or NaN if unknown.

See Also:

• CRS.get­Linear­Accuracy(Coordinate­Operation)

getAnchorPoint

public InternationalString getAnchorPoint()

Returns an anchor point which is common to all members of the datum ensemble. If the value is not the same for all members, or if at least one member returned null, then this method returns null.

Specified by:

get­Anchor­Point in interface Datum

Returns:

the common anchor point, or null if there is no common value.

getRealizationEpoch

public Date getRealizationEpoch()

Returns a realization epoch which is common to all members of the datum ensemble. If the value is not the same for all members, or if at least one member returned null, then this method returns null.

Specified by:

get­Realization­Epoch in interface Datum

Returns:

the common realization epoch, null if there is no common value.

getDomainOfValidity

public Extent getDomainOfValidity()

Returns a domain of validity which is common to all members of the datum ensemble. If the value is not the same for all members, or if at least one member returned null, then this method returns null.

Specified by:

get­Domain­Of­Validity in interface Datum

Returns:

the common domain of validity, or null if there is no common value.

getScope

public InternationalString getScope()

Returns a scope which is common to all members of the datum ensemble. If the value is not the same for all members, or if at least one member returned null, then this method returns null.

Specified by:

get­Scope in interface Datum

Returns:

the common scope, or null if there is no common value.

isHeuristicMatchForName

public boolean isHeuristicMatchForName(String name)

Returns true if either the primary name or at least one alias matches the given string according heuristic rules. This method performs the comparison documented in the datum class.

Overrides:

is­Heuristic­Match­For­Name in class Abstract­Identified­Object

Parameters:

name - the name to compare.

Returns:

true if the primary name or at least one alias matches the specified name.

See Also:

• Identified­Objects.is­Heuristic­Match­For­Name(Identified­Object, String)
• Characters.Filter.LETTERS_AND_DIGITS