org.geotoolkit.metadata.iso
Class MetadataEntity

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject

Direct Known Subclasses:

AbstractContentInformation, AbstractElement, AbstractGeographicExtent, AbstractGeolocationInformation, AbstractIdentification, AbstractResult, AbstractSpatialRepresentation, DefaultAcquisitionInformation, DefaultAddress, DefaultAggregateInformation, DefaultAlgorithm, DefaultApplicationSchemaInformation, DefaultBrowseGraphic, DefaultCitation, DefaultCitationDate, DefaultConstraints, DefaultContact, DefaultDataFile, DefaultDataQuality, DefaultDigitalTransferOptions, DefaultDimension, DefaultDistribution, DefaultDistributor, DefaultEnvironmentalRecord, DefaultEvent, DefaultExtendedElementInformation, DefaultExtent, DefaultFeatureTypeList, DefaultFormat, DefaultGCP, DefaultGeometricObjects, DefaultIdentifier, DefaultInstrument, DefaultKeywords, DefaultLineage, DefaultMaintenanceInformation, DefaultMedium, DefaultMetadata, DefaultMetadataExtensionInformation, DefaultNominalResolution, DefaultObjective, DefaultOnlineResource, DefaultOperation, DefaultPlan, DefaultPlatform, DefaultPlatformPass, DefaultPortrayalCatalogueReference, DefaultProcessing, DefaultProcessStep, DefaultProcessStepReport, DefaultRangeDimension, DefaultRangeElementDescription, DefaultRequestedDate, DefaultRequirement, DefaultResolution, DefaultResponsibleParty, DefaultScope, DefaultScopeDescription, DefaultSeries, DefaultSource, DefaultStandardOrderProcess, DefaultTelephone, DefaultTemporalExtent, DefaultUsage, DefaultVerticalExtent

@ThreadSafe
public class MetadataEntity
extends ModifiableMetadata
implements IdentifiedObject, Serializable

The base class of ISO 19115 implementation classes. Each sub-classes implements one of the ISO Metadata interface provided by GeoAPI.

This base class implements the IdentifiedObject interface, which implies that every subclasses can be associated to one or many identifiers. Those identifiers fall in two categories:

• The ISO 19115 standard associates identifiers to some metadata objects. The authority of those identifiers are often (but not limited to) one of the constants defined in the Citations class. At XML marshalling time, those identifiers appear as <MD_Identifier> elements.

• The ISO 19139 standard associates identifiers to all metadata objects. The authority of those identifiers are one of the constants defined in the IdentifierSpace interface. At XML marshalling time, those identifiers appear as attributes.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Jody Garnett (Refractions)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

protected Collection<Identifier>

identifiers All identifiers associated with this metadata, or null if none.

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

protected	MetadataEntity() Constructs an initially empty metadata entity.
protected	MetadataEntity(Object source) Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

Identifier	getIdentifier() Convenience method returning the first identifier which is not an ISO 19139 identifier.
IdentifierMap	getIdentifierMap() A map view of identifiers.
Collection<Identifier>	getIdentifiers() Returns all identifiers associated to this object.
MetadataStandard	getStandard() Returns the metadata standard implemented by subclasses, which is ISO 19115.

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

identifiers

protected Collection<Identifier> identifiers

All identifiers associated with this metadata, or null if none. This field is initialized to a non-null value when first needed.

Since:

3.19

See Also:

getIdentifiers()

Constructor Detail

MetadataEntity

protected MetadataEntity()

Constructs an initially empty metadata entity.

MetadataEntity

protected MetadataEntity(Object source)
                  throws ClassCastException

Constructs a metadata entity initialized with the values from the specified metadata. The source metadata must implements the same metadata interface than this class.

Parameters:

source - The metadata to copy values from, or null if none.

Throws:

ClassCastException - if the specified metadata don't implements the expected metadata interface.

Since:

2.4

Method Detail

getStandard

public MetadataStandard getStandard()

Returns the metadata standard implemented by subclasses, which is ISO 19115.

Specified by:

getStandard in class AbstractMetadata

Returns:

The metadata standard implemented.

Since:

2.4

getIdentifier

public Identifier getIdentifier()

Convenience method returning the first identifier which is not an ISO 19139 identifier. The default implementation iterates over the identifiers collection, ignoring the identifiers having one of the IdentifierSpace authority.

Returns:

The first ISO 19115 identifier, or null if none.

Since:

3.19

getIdentifiers

public Collection<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:

• EPSG codes
• Universal Product Code (UPC)
• National Stock Number (NSN)
• International Standard Book Number (ISBN)
• International Standard Serial Number (ISSN)
• Universally Unique Identifier (UUID)
• XML ID attribute
• XLink (href, role, arcrole, title, show and actuate attributes)

Note that XML ID attribute are actually unique only in the scope of the XML document being processed.

Specified by:

getIdentifiers in interface IdentifiedObject

Returns:

All identifiers associated to this object, or an empty collection if none.

Since:

3.19

See Also:

DefaultCitation.getIdentifiers(), DefaultObjective.getIdentifiers(), AbstractIdentifiedObject.getIdentifiers()

getIdentifierMap

public IdentifierMap getIdentifierMap()

A map view of identifiers. Each map entry is associated to an element from the 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.

The map supports put operations if and only if this IdentifiedObject is modifiable.

The default implementation returns a wrapper around the identifier collection. That map is live: changes in this metadata object will be reflected in the map, and conversely.

Specified by:

getIdentifierMap in interface IdentifiedObject

Returns:

The identifiers as a map of (authority, code) entries, or an empty map if none.

Since:

3.19