org.apache.sis.referencing

Class AbstractReferenceSystem

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, IdentifiedObject, ReferenceSystem

Direct Known Subclasses:

AbstractCRS, ReferencingByIdentifiers

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 and remarks from the parent class, and adds the following information:

• a domain of validity, the area for which the reference system is valid,
• a scope, which describes the domain of usage or limitation of usage.

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

Defined in the sis-referencing module

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractReferenceSystem(Map<String,?> properties) Constructs a reference system from the given properties.
protected	AbstractReferenceSystem(ReferenceSystem object) Constructs a new reference system with the same values than the specified one.

Method Summary

Modifier and Type	Method and Description
protected long	computeHashCode() Invoked by hash­Code() for computing the hash code when first needed.
boolean	equals(Object object, ComparisonMode mode) Compares this reference system with the specified object for equality.
Extent	getDomainOfValidity() Returns the region or timeframe in which this reference system is valid, or null if unspecified.
Class<? extends ReferenceSystem>	getInterface() Returns the GeoAPI interface implemented by this class.
InternationalString	getScope() Returns the domain or limitations of usage, or null if unspecified.

Methods inherited from class AbstractIdentifiedObject

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

Methods inherited from class FormattableObject

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

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Detail

AbstractReferenceSystem

public AbstractReferenceSystem(Map<String,?> properties)

Constructs a reference system 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
"domainOfValidity"	Extent	getDomainOfValidity()
"scope"	String or International­String	getScope()
Defined in parent class (reminder)
"name"	ReferenceIdentifier or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"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 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:

object - the reference system to copy.

Method Detail

getInterface

public Class<? extends ReferenceSystem> getInterface()

Returns the GeoAPI interface implemented by this class. The default implementation returns Reference­System.class. Subclasses implementing a more specific GeoAPI interface shall override this method.

Overrides:

get­Interface in class Abstract­Identified­Object

Returns:

the GeoAPI interface implemented by this class.

getDomainOfValidity

@Workaround(library="JDK",
            version="1.8")
public Extent getDomainOfValidity()

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.

See Also:

Default­Extent

getScope

public InternationalString getScope()

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.

equals

public boolean equals(Object object,
                      ComparisonMode mode)

Compares this reference system with the specified object for equality. If the mode argument value is STRICT or BY_CONTRACT, then all available properties are compared including the domain of validity and the scope.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­Identified­Object

Parameters:

object - the object to compare to this.

mode - STRICT for performing a strict comparison, or IGNORE_METADATA for comparing only properties relevant to coordinate transformations.

Returns:

true if both objects are equal.

See Also:

Abstract­Identified­Object.compute­Hash­Code(), Utilities.deep­Equals(Object, Object, Comparison­Mode)

computeHashCode

protected long computeHashCode()

Invoked by hash­Code() for computing the hash code when first needed. See Abstract­Identified­Object.compute­Hash­Code() for more information.

Overrides:

compute­Hash­Code in class Abstract­Identified­Object

Returns:

the hash code value. This value may change in any future Apache SIS version.