- All Known Implementing Classes:
AbstractCompleteness
,AbstractContentInformation
,AbstractDataEvaluation
,AbstractElement
,AbstractGeographicExtent
,AbstractGeolocationInformation
,AbstractIdentification
,AbstractLogicalConsistency
,AbstractMetaquality
,AbstractParty
,AbstractPositionalAccuracy
,AbstractResult
,AbstractSpatialRepresentation
,AbstractTemporalAccuracy
,AbstractTemporalQuality
,AbstractThematicAccuracy
,DefaultAbsoluteExternalPositionalAccuracy
,DefaultAccuracyOfATimeMeasurement
,DefaultAcquisitionInformation
,DefaultAddress
,DefaultAggregateInformation
,DefaultAggregationDerivation
,DefaultAlgorithm
,DefaultApplicationSchemaInformation
,DefaultAssociatedResource
,DefaultAttributeGroup
,DefaultBand
,DefaultBasicMeasure
,DefaultBoundingPolygon
,DefaultBrowseGraphic
,DefaultCitation
,DefaultCitationDate
,DefaultCompletenessCommission
,DefaultCompletenessOmission
,DefaultConceptualConsistency
,DefaultConfidence
,DefaultConformanceResult
,DefaultConstraints
,DefaultContact
,DefaultCoupledResource
,DefaultCoverageDescription
,DefaultCoverageResult
,DefaultDataFile
,DefaultDataIdentification
,DefaultDataQuality
,DefaultDescriptiveResult
,DefaultDigitalTransferOptions
,DefaultDimension
,DefaultDistribution
,DefaultDistributor
,DefaultDomainConsistency
,DefaultEnvironmentalRecord
,DefaultEvaluationMethod
,DefaultEvaluationReportInformation
,DefaultEvent
,DefaultExtendedElementInformation
,DefaultExtent
,DefaultFeatureCatalogueDescription
,DefaultFeatureTypeInfo
,DefaultFormat
,DefaultFormatConsistency
,DefaultFullInspection
,DefaultGCP
,DefaultGCPCollection
,DefaultGeographicBoundingBox
,DefaultGeographicDescription
,DefaultGeometricObjects
,DefaultGeorectified
,DefaultGeoreferenceable
,DefaultGriddedDataPositionalAccuracy
,DefaultGridSpatialRepresentation
,DefaultHomogeneity
,DefaultIdentifier
,DefaultImageDescription
,DefaultIndirectEvaluation
,DefaultIndividual
,DefaultInstrument
,DefaultKeywordClass
,DefaultKeywords
,DefaultLegalConstraints
,DefaultLineage
,DefaultMaintenanceInformation
,DefaultMeasureDescription
,DefaultMeasureReference
,DefaultMedium
,DefaultMetadata
,DefaultMetadataExtensionInformation
,DefaultMetadataScope
,DefaultNominalResolution
,DefaultNonQuantitativeAttributeAccuracy
,DefaultNonQuantitativeAttributeCorrectness
,DefaultObjective
,DefaultOnlineResource
,DefaultOperation
,DefaultOperationChainMetadata
,DefaultOperationMetadata
,DefaultOrganisation
,DefaultPlan
,DefaultPlatform
,DefaultPlatformPass
,DefaultPortrayalCatalogueReference
,DefaultProcessing
,DefaultProcessStep
,DefaultProcessStepReport
,DefaultQualityMeasure
,DefaultQuantitativeAttributeAccuracy
,DefaultQuantitativeResult
,DefaultRangeDimension
,DefaultRangeElementDescription
,DefaultRelativeInternalPositionalAccuracy
,DefaultReleasability
,DefaultRepresentativeFraction
,DefaultRepresentativity
,DefaultRequestedDate
,DefaultRequirement
,DefaultResolution
,DefaultResponsibility
,DefaultResponsibleParty
,DefaultSampleBasedInspection
,DefaultSampleDimension
,DefaultScope
,DefaultScope
,DefaultScopeDescription
,DefaultSecurityConstraints
,DefaultSeries
,DefaultServiceIdentification
,DefaultSource
,DefaultSourceReference
,DefaultSpatialTemporalExtent
,DefaultStandardOrderProcess
,DefaultTelephone
,DefaultTemporalConsistency
,DefaultTemporalExtent
,DefaultTemporalValidity
,DefaultThematicClassificationCorrectness
,DefaultTopologicalConsistency
,DefaultUsability
,DefaultUsage
,DefaultVectorSpatialRepresentation
,DefaultVerticalExtent
,ISOMetadata
String
in
a namespace identified by a Citation
. The namespace can be some organization like
EPSG for Coordinate Reference System objects, or a
well-known acronym like ISBN for International Standard Book Number.
When an identified object is marshalled in a ISO 19115-3 compliant XML document, some identifiers
are handled in a special way: they appear as gml:id
, gco:uuid
or xlink:href
attributes of the XML element. Those identifiers can be specified using the IdentifierSpace
enum values as below:
IdentifiedObject object = ...;
object.getIdentifierMap().put(IdentifierSpace.ID, "myID");
Relationship with GeoAPI
Identifiers exist also in some (not all) GeoAPI objects. Some GeoAPI objects (Instrument
, Platform
,
Operation
, Processing
,
etc.) have an explicit single identifier attribute, while other GeoAPI objects
(Citation
, Objective
,
referencing IdentifiedObject
, etc.) allow an arbitrary
number of identifiers. However, GeoAPI does not define explicit methods for handling the id
,
uuid
or href
attributes, since they are specific to XML marshalling (they do not
appear in OGC/ISO abstract specifications). This IdentifiedObject
interface provides a
way to handle those identifiers.
Note that GeoAPI defines a similar interface, also named IdentifiedObject
.
However, that GeoAPI interface is not of general use, since it contains methods like
toWKT()
that are specific to referencing
or geometric objects. In addition, the GeoAPI interface defines some attributes
(name,
alias,
remarks) that are not needed
for the purpose of handling XML id
, uuid
or href
attributes.
- Since:
- 0.3
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionA map view of the identifiers collection as (authority, code) entries.Collection
<? extends Identifier> Returns all identifiers associated to this object.
-
Method Details
-
getIdentifiers
Collection<? extends Identifier> getIdentifiers()Returns all identifiers associated to this object. Each identifier code shall be unique in the identifier authority name space. Examples of namespace are: Note that XML ID attribute are actually unique only in the scope of the XML document being processed.- Returns:
- all identifiers associated to this object, or an empty collection if none.
- See Also:
-
getIdentifierMap
IdentifierMap getIdentifierMap()A map view of the identifiers collection as (authority, code) entries. Each map entry is associated to an element from the above identifier collection in which the key is the identifier authority and the value is the identifier code.There is usually a one-to-one relationship between the map entries and the identifier elements, but not always:
- The map view may contain less entries, because the map interface allows only one
entry per authority. If the identifier collection contains
many identifiers for the same authority, then only the first occurrence is visible through
this
Map
view. - The map view may also contain more entries than the identifier collection. For example, the
Citation
interface defines separated attributes for ISBN, ISSN and other identifiers. This map view may choose to unify all those attributes in a single view.
put
operations if and only if thisIdentifiedObject
is modifiable.- Returns:
- the identifiers as a map of (authority, code) entries, or an empty map if none.
- The map view may contain less entries, because the map interface allows only one
entry per authority. If the identifier collection contains
many identifiers for the same authority, then only the first occurrence is visible through
this
-