org.geotoolkit.metadata.iso
Class DefaultMetadata

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultMetadata

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Metadata

@ThreadSafe
public class DefaultMetadata
extends MetadataEntity
implements Metadata

Root entity which defines metadata about a resource or resources.

Localization
When this object is marshalled as an ISO 19139 compliant XML document, the value given to the setLanguage(Locale) method will be used for the localization of InternationalString and CodeList instances of in this DefaultMetadata object and every children, as required by INSPIRE rules. If no language were specified, then the default locale will be the one defined in the XML.LOCALE marshaller property, if any.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultMetadata()
Creates an initially empty metadata.

DefaultMetadata(Metadata source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultMetadata(ResponsibleParty contact, Date dateStamp, Identification identificationInfo)
Creates a meta data initialized to the specified values.

Method Summary

static DefaultMetadata	castOrCopy(Metadata object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<AcquisitionInformation>	getAcquisitionInformation() Provides information about the acquisition of the data.
Collection<ApplicationSchemaInformation>	getApplicationSchemaInfo() Provides information about the conceptual schema of a dataset.
CharacterSet	getCharacterSet() Returns the full name of the character coding standard used for the metadata set.
Collection<ResponsibleParty>	getContacts() Returns the parties responsible for the metadata information.
Collection<ContentInformation>	getContentInfo() Provides information about the feature catalogue and describes the coverage and image data characteristics.
Collection<DataQuality>	getDataQualityInfo() Provides overall assessment of quality of a resource(s).
String	getDataSetUri() Provides the URI of the dataset to which the metadata applies.
Date	getDateStamp() Returns the date that the metadata was created.
Distribution	getDistributionInfo() Provides information about the distributor of and options for obtaining the resource(s).
String	getFileIdentifier() Returns the unique identifier for this metadata file, or null if none.
Collection<String>	getHierarchyLevelNames() Returns the name of the hierarchy levels for which the metadata is provided.
Collection<ScopeCode>	getHierarchyLevels() Returns the scope to which the metadata applies.
Collection<Identification>	getIdentificationInfo() Returns basic information about the resource(s) to which the metadata applies.
Locale	getLanguage() Returns the language used for documenting metadata.
Collection<Locale>	getLocales() Provides information about an alternatively used localized character string for a linguistic extension.
Collection<Constraints>	getMetadataConstraints() Provides restrictions on the access and use of data.
Collection<MetadataExtensionInformation>	getMetadataExtensionInfo() Returns information describing metadata extensions.
MaintenanceInformation	getMetadataMaintenance() Provides information about the frequency of metadata updates, and the scope of those updates.
String	getMetadataStandardName() Returns the name of the metadata standard (including profile name) used.
String	getMetadataStandardVersion() Returns the version (profile) of the metadata standard used.
String	getParentIdentifier() Returns the file identifier of the metadata to which this metadata is a subset (child).
Collection<PortrayalCatalogueReference>	getPortrayalCatalogueInfo() Provides information about the catalogue of rules defined for the portrayal of a resource(s).
Collection<ReferenceSystem>	getReferenceSystemInfo() Returns the description of the spatial and temporal reference systems used in the dataset.
Collection<SpatialRepresentation>	getSpatialRepresentationInfo() Returns the digital representation of spatial information in the dataset.
void	setAcquisitionInformation(Collection<? extends AcquisitionInformation> newValues) Sets information about the acquisition of the data.
void	setApplicationSchemaInfo(Collection<? extends ApplicationSchemaInformation> newValues) Provides information about the conceptual schema of a dataset.
void	setCharacterSet(CharacterSet newValue) Sets the full name of the character coding standard used for the metadata set.
void	setContacts(Collection<? extends ResponsibleParty> newValues) Sets the parties responsible for the metadata information.
void	setContentInfo(Collection<? extends ContentInformation> newValues) Sets information about the feature catalogue and describes the coverage and image data characteristics.
void	setDataQualityInfo(Collection<? extends DataQuality> newValues) Sets overall assessment of quality of a resource(s).
void	setDataSetUri(String newValue) Sets the URI of the dataset to which the metadata applies.
void	setDateStamp(Date newValue) Sets the date that the metadata was created.
void	setDistributionInfo(Distribution newValue) Provides information about the distributor of and options for obtaining the resource(s).
void	setFileIdentifier(String newValue) Sets the unique identifier for this metadata file, or null if none.
void	setHierarchyLevelNames(Collection<? extends String> newValues) Sets the name of the hierarchy levels for which the metadata is provided.
void	setHierarchyLevels(Collection<? extends ScopeCode> newValues) Sets the scope to which the metadata applies.
void	setIdentificationInfo(Collection<? extends Identification> newValues) Sets basic information about the resource(s) to which the metadata applies.
void	setLanguage(Locale newValue) Sets the language used for documenting metadata.
void	setLocales(Collection<? extends Locale> newValues) Sets information about an alternatively used localized character string for a linguistic extension.
void	setMetadataConstraints(Collection<? extends Constraints> newValues) Sets restrictions on the access and use of data.
void	setMetadataExtensionInfo(Collection<? extends MetadataExtensionInformation> newValues) Sets information describing metadata extensions.
void	setMetadataMaintenance(MaintenanceInformation newValue) Sets information about the frequency of metadata updates, and the scope of those updates.
void	setMetadataStandardName(String newValue) Name of the metadata standard (including profile name) used.
void	setMetadataStandardVersion(String newValue) Sets the version (profile) of the metadata standard used.
void	setParentIdentifier(String newValue) Sets the file identifier of the metadata to which this metadata is a subset (child).
void	setPortrayalCatalogueInfo(Collection<? extends PortrayalCatalogueReference> newValues) Sets information about the catalogue of rules defined for the portrayal of a resource(s).
void	setReferenceSystemInfo(Collection<? extends ReferenceSystem> newValues) Sets the description of the spatial and temporal reference systems used in the dataset.
void	setSpatialRepresentationInfo(Collection<? extends SpatialRepresentation> newValues) Sets the digital representation of spatial information in the dataset.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

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

Constructor Detail

DefaultMetadata

public DefaultMetadata()

Creates an initially empty metadata.

DefaultMetadata

public DefaultMetadata(Metadata source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

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

Since:

2.4

DefaultMetadata

public DefaultMetadata(ResponsibleParty contact,
                       Date dateStamp,
                       Identification identificationInfo)

Creates a meta data initialized to the specified values.

Parameters:

contact - Party responsible for the metadata information.

dateStamp - Date that the metadata was created.

identificationInfo - Basic information about the resource to which the metadata applies.

Method Detail

castOrCopy

public static DefaultMetadata castOrCopy(Metadata object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getFileIdentifier

public String getFileIdentifier()

Returns the unique identifier for this metadata file, or null if none.

Specified by:

getFileIdentifier in interface Metadata

setFileIdentifier

public void setFileIdentifier(String newValue)

Sets the unique identifier for this metadata file, or null if none.

Parameters:

newValue - The new identifier.

getLanguage

public Locale getLanguage()

Returns the language used for documenting metadata. This DefaultMetadata object and its children will use that locale for marshalling InternationalString and CodeList instances in ISO 19139 compliant XML documents.

Specified by:

getLanguage in interface Metadata

setLanguage

public void setLanguage(Locale newValue)

Sets the language used for documenting metadata. This DefaultMetadata object and its children will use the given locale for marshalling InternationalString and CodeList instances in ISO 19139 compliant XML documents.

Parameters:

newValue - The new language.

See Also:

XML.LOCALE

getCharacterSet

public CharacterSet getCharacterSet()

Returns the full name of the character coding standard used for the metadata set.

Specified by:

getCharacterSet in interface Metadata

setCharacterSet

public void setCharacterSet(CharacterSet newValue)

Sets the full name of the character coding standard used for the metadata set.

Parameters:

newValue - The new character set.

getParentIdentifier

public String getParentIdentifier()

Returns the file identifier of the metadata to which this metadata is a subset (child).

Specified by:

getParentIdentifier in interface Metadata

setParentIdentifier

public void setParentIdentifier(String newValue)

Sets the file identifier of the metadata to which this metadata is a subset (child).

Parameters:

newValue - The new parent identifier.

getHierarchyLevels

public Collection<ScopeCode> getHierarchyLevels()

Returns the scope to which the metadata applies.

Specified by:

getHierarchyLevels in interface Metadata

setHierarchyLevels

public void setHierarchyLevels(Collection<? extends ScopeCode> newValues)

Sets the scope to which the metadata applies.

Parameters:

newValues - The new hierarchy levels.

getHierarchyLevelNames

public Collection<String> getHierarchyLevelNames()

Returns the name of the hierarchy levels for which the metadata is provided.

Specified by:

getHierarchyLevelNames in interface Metadata

setHierarchyLevelNames

public void setHierarchyLevelNames(Collection<? extends String> newValues)

Sets the name of the hierarchy levels for which the metadata is provided.

Parameters:

newValues - The new hierarchy level names.

getContacts

public Collection<ResponsibleParty> getContacts()

Returns the parties responsible for the metadata information.

Specified by:

getContacts in interface Metadata

setContacts

public void setContacts(Collection<? extends ResponsibleParty> newValues)

Sets the parties responsible for the metadata information.

Parameters:

newValues - The new contacts.

getDateStamp

public Date getDateStamp()

Returns the date that the metadata was created.

Specified by:

getDateStamp in interface Metadata

setDateStamp

public void setDateStamp(Date newValue)

Sets the date that the metadata was created.

Parameters:

newValue - The new date stamp.

getMetadataStandardName

public String getMetadataStandardName()

Returns the name of the metadata standard (including profile name) used.

Specified by:

getMetadataStandardName in interface Metadata

setMetadataStandardName

public void setMetadataStandardName(String newValue)

Name of the metadata standard (including profile name) used.

Parameters:

newValue - The new metadata standard name.

getMetadataStandardVersion

public String getMetadataStandardVersion()

Returns the version (profile) of the metadata standard used.

Specified by:

getMetadataStandardVersion in interface Metadata

setMetadataStandardVersion

public void setMetadataStandardVersion(String newValue)

Sets the version (profile) of the metadata standard used.

Parameters:

newValue - The new metadata standard version.

getSpatialRepresentationInfo

public Collection<SpatialRepresentation> getSpatialRepresentationInfo()

Returns the digital representation of spatial information in the dataset.

Specified by:

getSpatialRepresentationInfo in interface Metadata

setSpatialRepresentationInfo

public void setSpatialRepresentationInfo(Collection<? extends SpatialRepresentation> newValues)

Sets the digital representation of spatial information in the dataset.

Parameters:

newValues - The new spatial representation info.

getReferenceSystemInfo

public Collection<ReferenceSystem> getReferenceSystemInfo()

Returns the description of the spatial and temporal reference systems used in the dataset.

Specified by:

getReferenceSystemInfo in interface Metadata

setReferenceSystemInfo

public void setReferenceSystemInfo(Collection<? extends ReferenceSystem> newValues)

Sets the description of the spatial and temporal reference systems used in the dataset.

Parameters:

newValues - The new reference system info.

getMetadataExtensionInfo

public Collection<MetadataExtensionInformation> getMetadataExtensionInfo()

Returns information describing metadata extensions.

Specified by:

getMetadataExtensionInfo in interface Metadata

setMetadataExtensionInfo

public void setMetadataExtensionInfo(Collection<? extends MetadataExtensionInformation> newValues)

Sets information describing metadata extensions.

Parameters:

newValues - The new metadata extension info.

getIdentificationInfo

public Collection<Identification> getIdentificationInfo()

Returns basic information about the resource(s) to which the metadata applies.

Specified by:

getIdentificationInfo in interface Metadata

setIdentificationInfo

public void setIdentificationInfo(Collection<? extends Identification> newValues)

Sets basic information about the resource(s) to which the metadata applies.

Parameters:

newValues - The new identification info.

getContentInfo

public Collection<ContentInformation> getContentInfo()

Provides information about the feature catalogue and describes the coverage and image data characteristics.

Specified by:

getContentInfo in interface Metadata

setContentInfo

public void setContentInfo(Collection<? extends ContentInformation> newValues)

Sets information about the feature catalogue and describes the coverage and image data characteristics.

Parameters:

newValues - The new content info.

getDistributionInfo

public Distribution getDistributionInfo()

Provides information about the distributor of and options for obtaining the resource(s).

Specified by:

getDistributionInfo in interface Metadata

setDistributionInfo

public void setDistributionInfo(Distribution newValue)

Provides information about the distributor of and options for obtaining the resource(s).

Parameters:

newValue - The new distribution info.

getDataQualityInfo

public Collection<DataQuality> getDataQualityInfo()

Provides overall assessment of quality of a resource(s).

Specified by:

getDataQualityInfo in interface Metadata

setDataQualityInfo

public void setDataQualityInfo(Collection<? extends DataQuality> newValues)

Sets overall assessment of quality of a resource(s).

Parameters:

newValues - The new data quality info.

getPortrayalCatalogueInfo

public Collection<PortrayalCatalogueReference> getPortrayalCatalogueInfo()

Provides information about the catalogue of rules defined for the portrayal of a resource(s).

Specified by:

getPortrayalCatalogueInfo in interface Metadata

setPortrayalCatalogueInfo

public void setPortrayalCatalogueInfo(Collection<? extends PortrayalCatalogueReference> newValues)

Sets information about the catalogue of rules defined for the portrayal of a resource(s).

Parameters:

newValues - The new portrayal catalog info.

getMetadataConstraints

public Collection<Constraints> getMetadataConstraints()

Provides restrictions on the access and use of data.

Specified by:

getMetadataConstraints in interface Metadata

setMetadataConstraints

public void setMetadataConstraints(Collection<? extends Constraints> newValues)

Sets restrictions on the access and use of data.

Parameters:

newValues - The new metadata constraints.

getApplicationSchemaInfo

public Collection<ApplicationSchemaInformation> getApplicationSchemaInfo()

Provides information about the conceptual schema of a dataset.

Specified by:

getApplicationSchemaInfo in interface Metadata

setApplicationSchemaInfo

public void setApplicationSchemaInfo(Collection<? extends ApplicationSchemaInformation> newValues)

Provides information about the conceptual schema of a dataset.

Parameters:

newValues - The new application schema info.

getMetadataMaintenance

public MaintenanceInformation getMetadataMaintenance()

Provides information about the frequency of metadata updates, and the scope of those updates.

Specified by:

getMetadataMaintenance in interface Metadata

setMetadataMaintenance

public void setMetadataMaintenance(MaintenanceInformation newValue)

Sets information about the frequency of metadata updates, and the scope of those updates.

Parameters:

newValue - The new metadata maintenance.

getLocales

public Collection<Locale> getLocales()

Provides information about an alternatively used localized character string for a linguistic extension.

Specified by:

getLocales in interface Metadata

Since:

2.4

setLocales

public void setLocales(Collection<? extends Locale> newValues)

Sets information about an alternatively used localized character string for a linguistic extension.

Parameters:

newValues - The new locales.

Since:

2.4

getDataSetUri

public String getDataSetUri()

Provides the URI of the dataset to which the metadata applies.

Specified by:

getDataSetUri in interface Metadata

Since:

2.4

setDataSetUri

public void setDataSetUri(String newValue)

Sets the URI of the dataset to which the metadata applies.

Parameters:

newValue - The new data set URI.

Since:

2.4

getAcquisitionInformation

public Collection<AcquisitionInformation> getAcquisitionInformation()

Provides information about the acquisition of the data.

Specified by:

getAcquisitionInformation in interface Metadata

Since:

3.03

setAcquisitionInformation

public void setAcquisitionInformation(Collection<? extends AcquisitionInformation> newValues)

Sets information about the acquisition of the data.

Parameters:

newValues - The new acquisition information.

Since:

3.03