Package org.apache.sis.referencing.cs
Class AbstractCS
Object
FormattableObject
AbstractIdentifiedObject
AbstractCS
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- CoordinateSystem,- IdentifiedObject
- Direct Known Subclasses:
- DefaultAffineCS,- DefaultCompoundCS,- DefaultCylindricalCS,- DefaultEllipsoidalCS,- DefaultLinearCS,- DefaultParametricCS,- DefaultPolarCS,- DefaultSphericalCS,- DefaultTimeCS,- DefaultUserDefinedCS,- DefaultVerticalCS
The set of coordinate system axes that spans a given coordinate space.
 The type of the coordinate system implies the set of mathematical rules for calculating geometric properties
 like angles, distances and surfaces.
 
This class is conceptually abstract, even if it is technically possible to instantiate it.
 Typical applications should create instances of the most specific subclass with Default prefix instead.
 An exception to this rule may occurs when it is not possible to identify the exact type. For example, it is not
 possible to infer the exact coordinate system from Well Known Text (WKT) version 1 in some cases
 (e.g. in a LOCAL_CS element). In such exceptional situation, a plain AbstractCS object may be
 instantiated.
Immutability and thread safety
This base class is immutable and thus thread-safe if the property values (not necessarily the map itself) and theCoordinateSystemAxis instances 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,
 CoordinateSystem 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 SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, LOCALE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionAbstractCS(Map<String, ?> properties, CoordinateSystemAxis... axes) Constructs a coordinate system from a set of properties and a sequence of axes.protectedCreates a new coordinate system with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic AbstractCScastOrCopy(CoordinateSystem object) Returns a SIS coordinate system 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 coordinate system for equality.forConvention(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.protected StringFormats the inner part of the Well Known Text (WKT) representation of this coordinate system.final CoordinateSystemAxisgetAxis(int dimension) Returns the axis for this coordinate system at the specified dimension.final intReturns the number of dimensions of this coordinate system.Class<? extends CoordinateSystem>Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKT
- 
Constructor Details- 
AbstractCSConstructs a coordinate system from a set of properties and a sequence of axes. 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()- Parameters:
- properties- the properties to be given to the identified object.
- axes- the sequence of axes.
 
- 
AbstractCSCreates a new coordinate 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:
- cs- the coordinate system to copy.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS coordinate system 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
       AffineCS,CartesianCS,SphericalCS,EllipsoidalCS,CylindricalCS,PolarCS,LinearCS,VerticalCS,TimeCSorUserDefinedCS, 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
       AbstractCS, then it is returned unchanged.
- Otherwise a new AbstractCSinstance 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, 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.
 
- If the given object is 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The default implementation returnsCoordinateSystem.class. Subclasses implementing a more specific GeoAPI interface shall override this method.- Overrides:
- getInterfacein class- AbstractIdentifiedObject
- Returns:
- the coordinate system interface implemented by this class.
 
- 
getDimensionpublic final int getDimension()Returns the number of dimensions of this coordinate system. This is the number of axes given at construction time.- Specified by:
- getDimensionin interface- CoordinateSystem
- Returns:
- the number of dimensions of this coordinate system.
 
- 
getAxisReturns the axis for this coordinate system at the specified dimension.- Specified by:
- getAxisin interface- CoordinateSystem
- Parameters:
- dimension- the zero based index of axis.
- Returns:
- the axis at the specified dimension.
- Throws:
- IndexOutOfBoundsException- if- dimensionis out of bounds.
 
- 
forConventionReturns a coordinate system equivalent to this one but with axes rearranged according the given convention. If this coordinate system is already compatible with the given convention, then this method returnsthis.- Parameters:
- convention- the axes convention for which a coordinate system is desired.
- Returns:
- a coordinate system compatible with the given convention (may be this).
- See Also:
 
- 
equalsCompares the specified object with this coordinate system for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractIdentifiedObject
- 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- AbstractIdentifiedObject
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
 
- 
formatToFormats the inner part of the Well Known Text (WKT) representation of this coordinate system. This method does not format the axes, because they shall appear outside theCS[…]element for historical reasons. Axes shall be formatted by the enclosing element (usually anAbstractCRS).Example: Well-Known Text of a two-dimensionalEllipsoidalCShaving (φ,λ) axes in a unit defined by the enclosing CRS (usually degrees).CS[ellipsoidal, 2], Axis["latitude", north], Axis["longitude", east] Compatibility note:CSis defined in the WKT 2 specification only.- Overrides:
- formatToin class- AbstractIdentifiedObject
- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "CS".
- See Also:
 
 
-