Class AbstractReferenceSystem

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Identified­Object, Reference­System

Direct Known Subclasses:

Abstract­CRS, Referencing­By­Identifiers

public class AbstractReferenceSystem
extends AbstractIdentifiedObject
implements ReferenceSystem

Description of a spatial and temporal reference system used by a dataset. Reference systems do not necessarily use coordinates. For example, a reference system could use postal codes. The specialized case of referencing by coordinates is handled by the Abstract­CRS subclass.

This class inherits the name, aliases, identifiers, domains and remarks from the parent class.

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 by Default instead.

Immutability and thread safety

This base class is immutable and thus thread-safe 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, Reference­System 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:

• 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 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.

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the object factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Abstract­Reference­System(Map<String,?> properties)	Constructs a reference system from the given properties.
protected	Abstract­Reference­System(Reference­System object)	Constructs a new reference system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

Methods inherited from class AbstractIdentifiedObject

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

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.
protected long	compute­Hash­Code()	Invoked by Abstract­Identified­Object.hash­Code() for computing the hash code when first needed.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
boolean	equals(Object object, Comparison­Mode mode)	Compares this object with the given 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.
protected String	format­To(Formatter formatter)	Formats the inner part of the Well Known Text (WKT) representation for this object.
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.
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 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

AbstractReferenceSystem

public AbstractReferenceSystem(Map<String,?> properties)

Constructs a reference system from the given properties. The properties given in argument follow the same rules as for 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"	ReferenceIdentifier or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to this object.

AbstractReferenceSystem

protected AbstractReferenceSystem(ReferenceSystem object)

Constructs a new reference system 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:

object - the reference system to copy.

Method Details

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. The default implementation returns Reference­System.class. Subclasses implementing a more specific GeoAPI interface shall override this method.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

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

Returns:

the GeoAPI interface implemented by this class.

Since:

1.7

See Also:

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

getDomainOfValidity

@Deprecated(since="1.4")
public Extent getDomainOfValidity()

Deprecated.

Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.

Returns the region or timeframe in which this reference system is valid, or null if unspecified.

Specified by:

get­Domain­Of­Validity in interface Reference­System

Returns:

area or region or timeframe in which this (coordinate) reference system is valid, or null.

getScope

@Deprecated(since="1.4")
public InternationalString getScope()

Deprecated.

Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.

Returns the domain or limitations of usage, or null if unspecified.

Specified by:

get­Scope in interface Reference­System

Returns:

description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid, or null.