Package org.apache.sis.referencing.crs
Class DefaultVerticalCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultVerticalCRS
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- CoordinateReferenceSystem,- SingleCRS,- VerticalCRS,- IdentifiedObject,- ReferenceSystem
A 1-dimensional coordinate reference system used for recording heights or depths.
 Vertical CRSs make use of the direction of gravity to define the concept of height or depth,
 but the relationship with gravity may not be straightforward.
 
Used with datum type:
   Vertical.
 Used with coordinate system type:
   Vertical.
 
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.- 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_KEYFields inherited from interface ReferenceSystemDOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultVerticalCRS(Map<String, ?> properties, VerticalDatum datum, VerticalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protectedConstructs a new coordinate reference system with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultVerticalCRScastOrCopy(VerticalCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.forConvention(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected StringFormats this CRS as a Well Known TextVerticalCRS[…]element.Returns the coordinate system.Returns the datum.Class<? extends VerticalCRS>Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractCRScastOrCopy, computeHashCode, equalsMethods inherited from class AbstractReferenceSystemgetDomainOfValidity, getScopeMethods 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, toWKTMethods inherited from interface ReferenceSystemgetDomainOfValidity, getScope
- 
Constructor Details- 
DefaultVerticalCRSCreates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than 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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"domainOfValidity" ExtentAbstractReferenceSystem.getDomainOfValidity()"scope" InternationalStringorStringAbstractReferenceSystem.getScope()- Parameters:
- properties- the properties to be given to the coordinate reference system.
- datum- the datum.
- cs- the coordinate system.
- See Also:
 
- 
DefaultVerticalCRSConstructs a new coordinate 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:
- crs- the coordinate reference system to copy.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object isnull, then this method returnsnull. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- 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.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsVerticalCRS.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineVerticalCRSsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
- getInterfacein class- AbstractCRS
- Returns:
- VerticalCRS.classor a user-defined sub-interface.
 
- 
getDatumReturns the datum.- Specified by:
- getDatumin interface- SingleCRS
- Specified by:
- getDatumin interface- VerticalCRS
- Returns:
- the datum.
 
- 
getCoordinateSystemReturns the coordinate system.- Specified by:
- getCoordinateSystemin interface- CoordinateReferenceSystem
- Specified by:
- getCoordinateSystemin interface- SingleCRS
- Specified by:
- getCoordinateSystemin interface- VerticalCRS
- Overrides:
- getCoordinateSystemin class- AbstractCRS
- Returns:
- the coordinate system.
 
- 
forConventionReturns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returnsthis.- Overrides:
- forConventionin class- AbstractCRS
- Parameters:
- convention- the axes convention for which a coordinate reference system is desired.
- Returns:
- a coordinate reference system compatible with the given convention (may be this).
- See Also:
 
- 
formatToFormats this CRS as a Well Known TextVerticalCRS[…]element.- Overrides:
- formatToin class- AbstractCRS
- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "VerticalCRS"(WKT 2) or- "Vert_CS"(WKT 1).
- See Also:
 
 
-