Class ReferencingByIdentifiers
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
ReferencingByIdentifiers
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- IdentifiedObject,- ReferenceSystem
- Direct Known Subclasses:
- GeohashReferenceSystem,- MilitaryGridReferenceSystem
Base class of reference systems that describe locations using geographic identifiers instead of coordinates.
 
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,ReferencingByIdentifiers instances
 created using only SIS factories and static constants can be shared by many objects and passed between threads
 without synchronization.- Since:
- 0.8
- See Also:
Defined in the sis-referencing-by-identifiers module
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classConversions between direct positions and identifiers.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringKey for the"overallOwner"property to be given to the object factorycreateFoo(…)methods.static final StringKey for the"theme"property to be given to the object factorycreateFoo(…)methods.Fields 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 SummaryConstructorsConstructorDescriptionReferencingByIdentifiers(Map<String, ?> properties, ModifiableLocationType... types) Creates a reference system from the given properties.
- 
Method SummaryModifier and TypeMethodDescriptionprotected longInvoked byhashCode()for computing the hash code when first needed.abstract ReferencingByIdentifiers.CoderReturns a new object performing conversions betweenDirectPositionand identifiers.booleanequals(Object object, ComparisonMode mode) Compares this reference system with the specified object for equality.protected StringFormats a pseudo-Well Known Text (WKT) representation for this object.List<? extends ModifiableLocationType>Description of location type(s) in the spatial reference system.Authority with overall responsibility for the spatial reference system.Property used to characterize the spatial reference system.Methods inherited from class AbstractReferenceSystemgetDomainOfValidity, getInterface, 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, toWKT
- 
Field Details- 
THEME_KEYKey for the"theme"property to be given to the object factorycreateFoo(…)methods. This is used for setting the value to be returned bygetTheme().- See Also:
 
- 
OVERALL_OWNER_KEYKey for the"overallOwner"property to be given to the object factorycreateFoo(…)methods. This is used for setting the value to be returned bygetOverallOwner().- See Also:
 
 
- 
- 
Constructor Details- 
ReferencingByIdentifiersCreates a reference system from the given properties. 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:
 This constructor copies the givenRecognized properties (non exhaustive list) Property name Value type Returned by "theme" StringorInternationalStringgetTheme()"overallOwner" PartygetOverallOwner()Defined in parent class (reminder) "name" IdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" Identifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"domainOfValidity" ExtentAbstractReferenceSystem.getDomainOfValidity()"scope" InternationalStringorStringAbstractReferenceSystem.getScope()LocationTypeinstances as perModifiableLocationType.snapshot(ReferenceSystemUsingIdentifiers, LocationType...). Changes in the given location types after construction will not affect thisReferencingByIdentifiers.Upcoming API change — generalization
 In a future SIS version, the type of array elements may be generalized to theorg.opengis.referencing.gazetteer.LocationTypeinterface. This change is pending GeoAPI revision.- Parameters:
- properties- the properties to be given to the reference system.
- types- description of location type(s) in the spatial reference system.
 
 
- 
- 
Method Details- 
getThemeProperty used to characterize the spatial reference system.- Returns:
- property used to characterize the spatial reference system.
- See Also:
 
- 
getOverallOwnerAuthority with overall responsibility for the spatial reference system.Upcoming API change — generalization
 in a future SIS version, the type of returned element may be generalized to theorg.opengis.metadata.citation.Partyinterface. This change is pending GeoAPI revision for upgrade from ISO 19115:2003 to ISO 19115:2014.- Returns:
- authority with overall responsibility for the spatial reference system.
- See Also:
 
- 
getLocationTypesDescription of location type(s) in the spatial reference system. The collection returned by this method is unmodifiable.Upcoming API change — generalization
 in a future SIS version, the type of elements type may be generalized to theorg.opengis.referencing.gazetteer.Locationinterface. This change is pending GeoAPI revision.- Returns:
- description of location type(s) in the spatial reference system.
- See Also:
 
- 
createCoderReturns a new object performing conversions betweenDirectPositionand identifiers. The returned object is not thread-safe; a new instance must be created for each thread, or synchronization must be applied by the caller.- Returns:
- a new object performing conversions between DirectPositionand identifiers.
- Since:
- 1.3
 
- 
equalsCompares this reference system with the specified object for equality. If themodeargument value isSTRICTorBY_CONTRACT, then all available properties are compared including the theme and the overall owner.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractReferenceSystem
- Parameters:
- object- the object to compare to- this.
- mode-- STRICTfor performing a strict comparison, or- IGNORE_METADATAfor comparing only properties relevant to location identifications.
- 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- AbstractReferenceSystem
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
 
- 
formatToFormats a pseudo-Well Known Text (WKT) representation for this object. The format produced by this method is non-standard and may change in any future Apache SIS version.- Overrides:
- formatToin class- AbstractIdentifiedObject
- Parameters:
- formatter- the formatter where to format the inner content of this pseudo-WKT element.
- Returns:
- an arbitrary keyword for the pseudo-WKT element.
- See Also:
 
 
-