Package org.apache.sis.metadata.iso
Class DefaultMetadata
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.DefaultMetadata
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.Metadata
- Direct Known Subclasses:
MI_Metadata
Root entity which defines metadata about a resource or resources.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
MD_Metadata
├─language…………………………………………………
Language used for documenting metadata.
├─characterSet………………………………………
Full name of the character coding standard used for the metadata set.
├─contact……………………………………………………
Parties responsible for the metadata information.
│ ├─party………………………………………………
Information about the parties.
│ │ └─name………………………………………
Name of the party.
│ └─role…………………………………………………
Function performed by the responsible party.
├─identificationInfo………………………
Basic information about the resource(s) to which the metadata applies.
│ ├─citation………………………………………
Citation data for the resource(s).
│ │ ├─title……………………………………
Name by which the cited resource is known.
│ │ └─date………………………………………
Reference date for the cited resource.
│ ├─abstract………………………………………
Brief narrative summary of the content of the resource(s).
│ ├─extent……………………………………………
Bounding polygon, vertical, and temporal extent of the dataset.
│ │ ├─description……………………
The spatial and temporal extent for the referring object.
│ │ ├─geographicElement……
Geographic component of the extent of the referring object.
│ │ ├─temporalElement…………
Temporal component of the extent of the referring object.
│ │ └─verticalElement…………
Vertical component of the extent of the referring object.
│ └─topicCategory…………………………
Main theme(s) of the dataset.
├─dateInfo…………………………………………………
Date(s) associated with the metadata.
├─metadataScope……………………………………
The scope or type of resource for which metadata is provided.
│ └─resourceScope…………………………
Resource scope
└─parentMetadata…………………………………
Identification of the parent metadata record.
├─title………………………………………………
Name by which the cited resource is known.
└─date…………………………………………………
Reference date for the cited resource.Localization
When this object is marshalled as an ISO 19139 compliant XML document, the value given to thesetLanguage(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.
Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XML
instead.
- Since:
- 0.3
- Version:
- 1.1
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
private static final class
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Collection<org.opengis.metadata.acquisition.AcquisitionInformation>
Provides information about the acquisition of the data.private Collection<org.opengis.metadata.citation.Citation>
Reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.private Collection<org.opengis.metadata.ApplicationSchemaInformation>
Provides information about the conceptual schema of a dataset.private Collection<org.opengis.metadata.citation.ResponsibleParty>
Parties responsible for the metadata information.private Collection<org.opengis.metadata.content.ContentInformation>
Provides information about the feature catalogue and describes the coverage and image data characteristics.private Collection<org.opengis.metadata.quality.DataQuality>
Provides overall assessment of quality of a resource(s).private Collection<org.opengis.metadata.citation.CitationDate>
Date(s) associated with the metadata.private org.opengis.metadata.distribution.Distribution
Provides information about the distributor of and options for obtaining the resource(s).private Collection<org.opengis.metadata.identification.Identification>
Basic information about the resource(s) to which the metadata applies.Language(s) and character set(s) used within the dataset.private Collection<org.opengis.metadata.constraint.Constraints>
Provides restrictions on the access and use of metadata.private Collection<org.opengis.metadata.MetadataExtensionInformation>
Information describing metadata extensions.private Collection<org.opengis.metadata.citation.OnlineResource>
Online location(s) where the metadata is available.private org.opengis.metadata.maintenance.MaintenanceInformation
Provides information about the frequency of metadata updates, and the scope of those updates.private Collection<org.opengis.metadata.citation.Citation>
Citation(s) for the profile(s) of the metadata standard to which the metadata conform.private Collection<DefaultMetadataScope>
Scope to which the metadata applies.private Collection<org.opengis.metadata.citation.Citation>
Citation(s) for the standard(s) to which the metadata conform.private org.opengis.metadata.citation.Citation
Identification of the parent metadata record.private Collection<org.opengis.metadata.PortrayalCatalogueReference>
Provides information about the catalogue of rules defined for the portrayal of a resource(s).private Collection<org.opengis.referencing.ReferenceSystem>
Description of the spatial and temporal reference systems used in the dataset.private Collection<org.opengis.metadata.lineage.Lineage>
Information about the provenance, sources and/or the production processes applied to the resource.private static final long
Serial number for inter-operability with different versions.private Collection<org.opengis.metadata.spatial.SpatialRepresentation>
Digital representation of spatial information in the dataset.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an initially empty metadata.DefaultMetadata
(org.opengis.metadata.citation.ResponsibleParty contact, Date dateStamp, org.opengis.metadata.identification.Identification identificationInfo) Creates a meta data initialized to the specified values.DefaultMetadata
(org.opengis.metadata.Metadata object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
afterMarshal
(Marshaller marshaller) Invoked by JAXBMarshaller
after this object has been marshalled to XML.private void
beforeMarshal
(Marshaller marshaller) Invoked by JAXBMarshaller
before this object is marshalled to XML.static DefaultMetadata
castOrCopy
(org.opengis.metadata.Metadata object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.static DefaultMetadata
deepCopy
(org.opengis.metadata.Metadata object) Returns an editable copy of the given metadata.Collection<org.opengis.metadata.acquisition.AcquisitionInformation>
Returns information about the acquisition of the data.private Collection<org.opengis.metadata.citation.Citation>
Collection<org.opengis.metadata.citation.Citation>
Returns reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.Collection<org.opengis.metadata.ApplicationSchemaInformation>
Returns information about the conceptual schema of a dataset.org.opengis.metadata.identification.CharacterSet
Deprecated.Deprecated.Replaced bygetLocalesAndCharsets().values()
.private Charset
Returns the character coding for the metadata set (used in legacy ISO 19157 format).Collection<org.opengis.metadata.citation.ResponsibleParty>
Returns the parties responsible for the metadata information.Collection<org.opengis.metadata.content.ContentInformation>
Returns information about the feature catalogue and describes the coverage and image data characteristics.Collection<org.opengis.metadata.quality.DataQuality>
Returns overall assessment of quality of a resource(s).Deprecated.As of ISO 19115:2014, replaced bygetIdentificationInfo()
followed byAbstractIdentification.getCitation()
followed byDefaultCitation.getOnlineResources()
.Collection<org.opengis.metadata.citation.CitationDate>
Returns the date(s) associated with the metadata.private Collection<org.opengis.metadata.citation.CitationDate>
getDates()
Invoked by JAXB at both marshalling and unmarshalling time.Deprecated.As of ISO 19115:2014, replaced bygetDateInfo()
.private PT_Locale
Gets the default locale for this record (used in ISO 19115-3:2016 format).org.opengis.metadata.distribution.Distribution
Returns information about the distributor of and options for obtaining the resource(s).Deprecated.As of ISO 19115:2014, replaced bygetMetadataIdentifier()
in order to include the codespace attribute.final Collection<String>
Deprecated.As of ISO 19115:2014, replaced bygetMetadataScopes()
followed byDefaultMetadataScope.getName()
.final Collection<org.opengis.metadata.maintenance.ScopeCode>
Deprecated.As of ISO 19115:2014, replaced bygetMetadataScopes()
followed byDefaultMetadataScope.getResourceScope()
.Collection<org.opengis.metadata.identification.Identification>
Returns basic information about the resource(s) to which the metadata applies.Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Returns the language(s) and character set(s) used for documenting metadata.Collection<org.opengis.metadata.constraint.Constraints>
Returns restrictions on the access and use of metadata.Collection<org.opengis.metadata.MetadataExtensionInformation>
Returns information describing metadata extensions.org.opengis.metadata.Identifier
Returns a unique identifier for this metadata record.private Collection<org.opengis.metadata.citation.OnlineResource>
Collection<org.opengis.metadata.citation.OnlineResource>
Returns the online location(s) where the metadata is available.org.opengis.metadata.maintenance.MaintenanceInformation
Returns information about the frequency of metadata updates, and the scope of those updates.private Collection<org.opengis.metadata.citation.Citation>
Collection<org.opengis.metadata.citation.Citation>
Returns the citation(s) for the profile(s) of the metadata standard to which the metadata conform.private Collection<DefaultMetadataScope>
Returns the scope or type of resource for which metadata is provided.private Collection<org.opengis.metadata.citation.Citation>
private String
getMetadataStandard
(boolean version) Implementation of legacygetMetadataStandardName()
andgetMetadataStandardVersion()
methods.Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.getTitle()
.Collection<org.opengis.metadata.citation.Citation>
Returns the citation(s) for the standard(s) to which the metadata conform.Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.getEdition()
.private Collection<PT_Locale>
Gets the other locales for this record (used in ISO 19115-3:2016 format).Deprecated.As of ISO 19115:2014, replaced bygetParentMetadata()
.org.opengis.metadata.citation.Citation
Returns an identification of the parent metadata record.Collection<org.opengis.metadata.PortrayalCatalogueReference>
Returns information about the catalogue of rules defined for the portrayal of a resource(s).Collection<org.opengis.referencing.ReferenceSystem>
Returns the description of the spatial and temporal reference systems used in the dataset.private Collection<org.opengis.metadata.lineage.Lineage>
Collection<org.opengis.metadata.lineage.Lineage>
Returns information about the provenance, sources and/or the production processes applied to the resource.Collection<org.opengis.metadata.spatial.SpatialRepresentation>
Returns the digital representation of spatial information in the dataset.void
setAcquisitionInformation
(Collection<? extends org.opengis.metadata.acquisition.AcquisitionInformation> newValues) Sets information about the acquisition of the data.void
setAlternativeMetadataReferences
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Set reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.void
setApplicationSchemaInfo
(Collection<? extends org.opengis.metadata.ApplicationSchemaInformation> newValues) Returns information about the conceptual schema of a dataset.void
setCharacterSet
(org.opengis.metadata.identification.CharacterSet newValue) Deprecated.Replaced bygetLocalesAndCharsets().put(…, newValue)
.void
setCharacterSets
(Collection<? extends Charset> newValues) Deprecated.Replaced by putting values ingetLocalesAndCharsets()
map.private void
setCharset
(Charset newValue) Sets the character coding standard for the metadata set (used in legacy ISO 19157 format).void
setContacts
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the parties responsible for the metadata information.void
setContentInfo
(Collection<? extends org.opengis.metadata.content.ContentInformation> newValues) Sets information about the feature catalogue and describes the coverage and image data characteristics.void
setDataQualityInfo
(Collection<? extends org.opengis.metadata.quality.DataQuality> newValues) Sets overall assessment of quality of a resource(s).void
setDataSetUri
(String newValue) Deprecated.As of ISO 19115:2014, replaced bygetIdentificationInfo()
followed byAbstractIdentification.getCitation()
followed byDefaultCitation.setOnlineResources(Collection)
.void
setDateInfo
(Collection<? extends org.opengis.metadata.citation.CitationDate> newValues) Sets the date(s) associated with the metadata.void
setDateStamp
(Date newValue) Deprecated.As of ISO 19115:2014, replaced bysetDateInfo(Collection)
.private void
setDefaultLocale
(PT_Locale newValue) Sets the default locale for this record (used in ISO 19115-3:2016 format).void
setDistributionInfo
(org.opengis.metadata.distribution.Distribution newValue) Sets information about the distributor of and options for obtaining the resource(s).void
setFileIdentifier
(String newValue) Deprecated.As of ISO 19115:2014, replaced bysetMetadataIdentifier(Identifier)
void
setHierarchyLevelNames
(Collection<? extends String> newValues) Deprecated.As of ISO 19115:2014, replaced bysetMetadataScopes(Collection)
andDefaultMetadataScope.setName(InternationalString)
.void
setHierarchyLevels
(Collection<? extends org.opengis.metadata.maintenance.ScopeCode> newValues) Deprecated.As of ISO 19115:2014, replaced bysetMetadataScopes(Collection)
andDefaultMetadataScope.setResourceScope(ScopeCode)
.void
setIdentificationInfo
(Collection<? extends org.opengis.metadata.identification.Identification> newValues) Sets basic information about the resource(s) to which the metadata applies.void
setLanguage
(Locale newValue) Deprecated.Replaced bygetLocalesAndCharsets().put(newValue, …)
.void
setLanguages
(Collection<Locale> newValues) Deprecated.Replaced by putting keys ingetLocalesAndCharsets()
map.void
setLocales
(Collection<? extends Locale> newValues) Deprecated.Replaced by putting keys ingetLocalesAndCharsets()
.void
setLocalesAndCharsets
(Map<? extends Locale, ? extends Charset> newValues) Sets the language(s) and character set(s) used within the dataset.void
setMetadataConstraints
(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets restrictions on the access and use of metadata.void
setMetadataExtensionInfo
(Collection<? extends org.opengis.metadata.MetadataExtensionInformation> newValues) Sets information describing metadata extensions.void
setMetadataIdentifier
(org.opengis.metadata.Identifier newValue) Sets the unique identifier for this metadata record.void
setMetadataLinkages
(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets the online location(s) where the metadata is available.void
setMetadataMaintenance
(org.opengis.metadata.maintenance.MaintenanceInformation newValue) Sets information about the frequency of metadata updates, and the scope of those updates.void
setMetadataProfiles
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Set the citation(s) for the profile(s) of the metadata standard to which the metadata conform.void
setMetadataScopes
(Collection<? extends DefaultMetadataScope> newValues) Sets the scope or type of resource for which metadata is provided.private void
setMetadataStandard
(boolean version, String newValue) Implementation of legacysetMetadataStandardName(String)
andsetMetadataStandardVersion(String)
methods.void
setMetadataStandardName
(String newValue) Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.setTitle(InternationalString)
.void
setMetadataStandards
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets the citation(s) for the standard(s) to which the metadata conform.void
setMetadataStandardVersion
(String newValue) Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.setEdition(InternationalString)
.void
setParentIdentifier
(String newValue) Deprecated.As of ISO 19115:2014, replaced bygetParentMetadata()
.void
setParentMetadata
(org.opengis.metadata.citation.Citation newValue) Sets an identification of the parent metadata record.void
setPortrayalCatalogueInfo
(Collection<? extends org.opengis.metadata.PortrayalCatalogueReference> newValues) Sets information about the catalogue of rules defined for the portrayal of a resource(s).void
setReferenceSystemInfo
(Collection<? extends org.opengis.referencing.ReferenceSystem> newValues) Sets the description of the spatial and temporal reference systems used in the dataset.void
setResourceLineages
(Collection<? extends org.opengis.metadata.lineage.Lineage> newValues) Sets information about the provenance, sources and/or the production processes applied to the resource.void
setSpatialRepresentationInfo
(Collection<? extends org.opengis.metadata.spatial.SpatialRepresentation> newValues) Sets the digital representation of spatial information in the dataset.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
locales
Language(s) and character set(s) used within the dataset. -
parentMetadata
private org.opengis.metadata.citation.Citation parentMetadataIdentification of the parent metadata record. -
metadataScopes
Scope to which the metadata applies. -
contacts
Parties responsible for the metadata information. -
dateInfo
Date(s) associated with the metadata. -
metadataStandards
Citation(s) for the standard(s) to which the metadata conform. -
metadataProfiles
Citation(s) for the profile(s) of the metadata standard to which the metadata conform. -
alternativeMetadataReferences
Reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource. -
metadataLinkages
Online location(s) where the metadata is available. -
spatialRepresentationInfo
Digital representation of spatial information in the dataset. -
referenceSystemInfo
Description of the spatial and temporal reference systems used in the dataset. -
metadataExtensionInfo
Information describing metadata extensions. -
identificationInfo
Basic information about the resource(s) to which the metadata applies. -
contentInfo
Provides information about the feature catalogue and describes the coverage and image data characteristics. -
distributionInfo
private org.opengis.metadata.distribution.Distribution distributionInfoProvides information about the distributor of and options for obtaining the resource(s). -
dataQualityInfo
Provides overall assessment of quality of a resource(s). -
portrayalCatalogueInfo
Provides information about the catalogue of rules defined for the portrayal of a resource(s). -
metadataConstraints
Provides restrictions on the access and use of metadata. -
applicationSchemaInfo
Provides information about the conceptual schema of a dataset. -
metadataMaintenance
private org.opengis.metadata.maintenance.MaintenanceInformation metadataMaintenanceProvides information about the frequency of metadata updates, and the scope of those updates. -
acquisitionInformation
Provides information about the acquisition of the data. -
resourceLineages
Information about the provenance, sources and/or the production processes applied to the resource.
-
-
Constructor Details
-
DefaultMetadata
public DefaultMetadata()Creates an initially empty metadata. -
DefaultMetadata
public DefaultMetadata(org.opengis.metadata.citation.ResponsibleParty contact, Date dateStamp, org.opengis.metadata.identification.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.
-
DefaultMetadata
public DefaultMetadata(org.opengis.metadata.Metadata object) Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null
, then this method returnsnull
. - Otherwise if the given object is already an instance of
DefaultMetadata
, then it is returned unchanged. - Otherwise a new
DefaultMetadata
instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
Use case
This method is useful before XML marshalling or serialization, which may not be supported by all implementations. However, the returned metadata is not guaranteed to be editable. For editable metadata, seedeepCopy(Metadata)
.- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
- If the given object is
-
deepCopy
Returns an editable copy of the given metadata. All children are also copied. This method is more expensive thancastOrCopy(Metadata)
because the copy is unconditional and much deeper. However, the result is guaranteed to be editable.Use case
Metadata returned byResource.getMetadata()
are typically unmodifiable. ThisdeepCopy(…)
method is useful for completing those metadata with new elements, for example before insertion in a catalog.- Parameters:
object
- the metadata to copy, ornull
if none.- Returns:
- a deep copy of the given object, or
null
if the argument was null. - Since:
- 1.1
- See Also:
-
getMetadataIdentifier
@UML(identifier="metadataIdentifier", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.metadata.Identifier getMetadataIdentifier()Returns a unique identifier for this metadata record.Note: OGC 07-045 (Catalog Service Specification — ISO metadata application profile) recommends usage of a UUID (Universal Unique Identifier) as specified by IETF to ensure identifier’s uniqueness.- Returns:
- unique identifier for this metadata record, or
null
. - Since:
- 0.5
-
setMetadataIdentifier
public void setMetadataIdentifier(org.opengis.metadata.Identifier newValue) Sets the unique identifier for this metadata record.- Parameters:
newValue
- the new identifier, ornull
if none.- Since:
- 0.5
-
getFileIdentifier
Deprecated.As of ISO 19115:2014, replaced bygetMetadataIdentifier()
in order to include the codespace attribute.Returns the unique identifier for this metadata file.- Specified by:
getFileIdentifier
in interfaceorg.opengis.metadata.Metadata
- Returns:
- unique identifier for this metadata file, or
null
.
-
setFileIdentifier
Deprecated.As of ISO 19115:2014, replaced bysetMetadataIdentifier(Identifier)
Sets the unique identifier for this metadata file.- Parameters:
newValue
- the new identifier, ornull
if none.
-
getLocalesAndCharsets
@UML(identifier="defaultLocale+otherLocale", obligation=CONDITIONAL, specification=ISO_19115) public Map<Locale,Charset> getLocalesAndCharsets()Returns the language(s) and character set(s) used for documenting metadata. The first entry in iteration order is the default language and its character set. All other entries, if any, are alternate language(s) and character set(s) used within the resource.Unless another locale has been specified with the
XML.LOCALE
property, thisDefaultMetadata
instance and its children will use the first locale returned by this method for marshallingInternationalString
andCodeList
instances in ISO 19115-2 compliant XML documents.Each (
Locale
,Charset
) entry is equivalent to an instance of ISO 19115PT_Locale
class. The language code and the character set are mandatory elements in ISO standard. Consequently, this map should not contain null key or null values, but Apache SIS implementations is tolerant for historical reasons. The same character set may be associated to many languages.- Returns:
- language(s) and character set(s) used for documenting metadata.
- Since:
- 1.0
-
setLocalesAndCharsets
Sets the language(s) and character set(s) used within the dataset. The first element in iteration order should be the default language. All other elements, if any, are alternate language(s) used within the resource.- Parameters:
newValues
- the new language(s) and character set(s) used for documenting metadata.- Since:
- 1.0
- See Also:
-
getLanguages
Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Returns the language(s) used for documenting metadata. The first element in iteration order is the default language. All other elements, if any, are alternate language(s) used within the resource.- Returns:
- language(s) used for documenting metadata.
- Since:
- 0.5
-
setLanguages
Deprecated.Replaced by putting keys ingetLocalesAndCharsets()
map.Sets the language(s) used for documenting metadata. The first element in iteration order shall be the default language. All other elements, if any, are alternate language(s) used within the resource.- Parameters:
newValues
- the new languages.- Since:
- 0.5
-
getLanguage
Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Returns the default language used for documenting metadata.- Specified by:
getLanguage
in interfaceorg.opengis.metadata.Metadata
- Returns:
- language used for documenting metadata, or
null
.
-
setLanguage
Deprecated.Replaced bygetLocalesAndCharsets().put(newValue, …)
.Sets the language used for documenting metadata. This method modifies the collection returned bygetLanguages()
as below:- If the languages collection is empty, then this method sets the collection to the given
newValue
. - Otherwise the first element in the languages collection is replaced by the given
newValue
.
- Parameters:
newValue
- the new language.
- If the languages collection is empty, then this method sets the collection to the given
-
getLocales
Deprecated.Replaced bygetLocalesAndCharsets().keySet()
.Provides information about an alternatively used localized character string for a linguistic extension.- Specified by:
getLocales
in interfaceorg.opengis.metadata.Metadata
- Returns:
- alternatively used localized character string for a linguistic extension.
-
setLocales
Deprecated.Replaced by putting keys ingetLocalesAndCharsets()
.Sets information about an alternatively used localized character string for a linguistic extension.- Parameters:
newValues
- the new locales.
-
getCharacterSets
Deprecated.Replaced bygetLocalesAndCharsets().values()
.Returns the character coding standard used for the metadata set.- Returns:
- character coding standards used for the metadata.
- Since:
- 0.5
-
setCharacterSets
Deprecated.Replaced by putting values ingetLocalesAndCharsets()
map.Sets the character coding standard used for the metadata set.- Parameters:
newValues
- the new character coding standards.- Since:
- 0.5
-
getCharacterSet
Deprecated.Replaced bygetLocalesAndCharsets().values()
.Returns the character coding standard used for the metadata set.- Specified by:
getCharacterSet
in interfaceorg.opengis.metadata.Metadata
- Returns:
- character coding standard used for the metadata, or
null
.
-
setCharacterSet
Deprecated.Replaced bygetLocalesAndCharsets().put(…, newValue)
.Sets the character coding standard used for the metadata set.- Parameters:
newValue
- the new character set.
-
getParentMetadata
@UML(identifier="parentMetadata", obligation=CONDITIONAL, specification=ISO_19115) public org.opengis.metadata.citation.Citation getParentMetadata()Returns an identification of the parent metadata record. This is non-null if this metadata is a subset (child) of another metadata that is described elsewhere.- Returns:
- identification of the parent metadata record, or
null
if none. - Since:
- 0.5
-
setParentMetadata
public void setParentMetadata(org.opengis.metadata.citation.Citation newValue) Sets an identification of the parent metadata record.- Parameters:
newValue
- the new identification of the parent metadata record.- Since:
- 0.5
-
getParentIdentifier
Deprecated.As of ISO 19115:2014, replaced bygetParentMetadata()
.Returns the file identifier of the metadata to which this metadata is a subset (child).- Specified by:
getParentIdentifier
in interfaceorg.opengis.metadata.Metadata
- Returns:
- identifier of the metadata to which this metadata is a subset, or
null
.
-
setParentIdentifier
Deprecated.As of ISO 19115:2014, replaced bygetParentMetadata()
.Sets the file identifier of the metadata to which this metadata is a subset (child).- Parameters:
newValue
- the new parent identifier.
-
getMetadataScopes
@UML(identifier="metadataScope", obligation=CONDITIONAL, specification=ISO_19115) public Collection<DefaultMetadataScope> getMetadataScopes()Returns the scope or type of resource for which metadata is provided.Upcoming API change — generalization
The element type will be changed to theMetadataScope
interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Returns:
- scope or type of resource for which metadata is provided.
- Since:
- 0.5
-
setMetadataScopes
Sets the scope or type of resource for which metadata is provided.Upcoming API change — generalization
The element type will be changed to theMetadataScope
interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Parameters:
newValues
- the new scope or type of resource.- Since:
- 0.5
-
getHierarchyLevels
@Deprecated public final Collection<org.opengis.metadata.maintenance.ScopeCode> getHierarchyLevels()Deprecated.As of ISO 19115:2014, replaced bygetMetadataScopes()
followed byDefaultMetadataScope.getResourceScope()
.Returns the scope to which the metadata applies.- Specified by:
getHierarchyLevels
in interfaceorg.opengis.metadata.Metadata
- Returns:
- scope to which the metadata applies.
-
setHierarchyLevels
@Deprecated public void setHierarchyLevels(Collection<? extends org.opengis.metadata.maintenance.ScopeCode> newValues) Deprecated.As of ISO 19115:2014, replaced bysetMetadataScopes(Collection)
andDefaultMetadataScope.setResourceScope(ScopeCode)
.Sets the scope to which the metadata applies.- Parameters:
newValues
- the new hierarchy levels.
-
getHierarchyLevelNames
Deprecated.As of ISO 19115:2014, replaced bygetMetadataScopes()
followed byDefaultMetadataScope.getName()
.Returns the name of the hierarchy levels for which the metadata is provided.- Specified by:
getHierarchyLevelNames
in interfaceorg.opengis.metadata.Metadata
- Returns:
- hierarchy levels for which the metadata is provided.
-
setHierarchyLevelNames
Deprecated.As of ISO 19115:2014, replaced bysetMetadataScopes(Collection)
andDefaultMetadataScope.setName(InternationalString)
.Sets the name of the hierarchy levels for which the metadata is provided.- Parameters:
newValues
- the new hierarchy level names.
-
getContacts
Returns the parties responsible for the metadata information.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getContacts
in interfaceorg.opengis.metadata.Metadata
- Returns:
- parties responsible for the metadata information.
-
setContacts
public void setContacts(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the parties responsible for the metadata information.- Parameters:
newValues
- the new contacts.
-
getDateInfo
@UML(identifier="dateInfo", obligation=MANDATORY, specification=ISO_19115) public Collection<org.opengis.metadata.citation.CitationDate> getDateInfo()Returns the date(s) associated with the metadata.- Returns:
- date(s) associated with the metadata.
- Since:
- 0.5
- See Also:
-
Citation.getDates()
-
setDateInfo
Sets the date(s) associated with the metadata. The collection should contain at least an element forDateType.CREATION
.- Parameters:
newValues
- new dates associated with the metadata.- Since:
- 0.5
-
getDateStamp
Deprecated.As of ISO 19115:2014, replaced bygetDateInfo()
.Returns the date that the metadata was created.- Specified by:
getDateStamp
in interfaceorg.opengis.metadata.Metadata
- Returns:
- date that the metadata was created, or
null
.
-
setDateStamp
Deprecated.As of ISO 19115:2014, replaced bysetDateInfo(Collection)
.Sets the date that the metadata was created.- Parameters:
newValue
- the new date stamp.
-
getMetadataStandards
@UML(identifier="metadataStandard", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Citation> getMetadataStandards()Returns the citation(s) for the standard(s) to which the metadata conform. The collection returned by this method typically contains elements from theCitations.ISO_19115
list.- Returns:
- the standard(s) to which the metadata conform.
- Since:
- 0.5
- See Also:
-
setMetadataStandards
public void setMetadataStandards(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets the citation(s) for the standard(s) to which the metadata conform. Metadata standard citations should include an identifier.- Parameters:
newValues
- the new standard(s) to which the metadata conform.- Since:
- 0.5
-
getMetadataProfiles
@UML(identifier="metadataProfile", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Citation> getMetadataProfiles()Returns the citation(s) for the profile(s) of the metadata standard to which the metadata conform.- Returns:
- the profile(s) to which the metadata conform.
- Since:
- 0.5
- See Also:
-
setMetadataProfiles
public void setMetadataProfiles(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Set the citation(s) for the profile(s) of the metadata standard to which the metadata conform. Metadata profile standard citations should include an identifier.- Parameters:
newValues
- the new profile(s) to which the metadata conform.- Since:
- 0.5
-
getAlternativeMetadataReferences
@UML(identifier="alternativeMetadataReference", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Citation> getAlternativeMetadataReferences()Returns reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.- Returns:
- reference(s) to alternative metadata (e.g. Dublin core, FGDC).
- Since:
- 0.5
-
setAlternativeMetadataReferences
public void setAlternativeMetadataReferences(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Set reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.- Parameters:
newValues
- the new reference(s) to alternative metadata (e.g. Dublin core, FGDC).- Since:
- 0.5
-
getMetadataStandard
Implementation of legacygetMetadataStandardName()
andgetMetadataStandardVersion()
methods. -
setMetadataStandard
Implementation of legacysetMetadataStandardName(String)
andsetMetadataStandardVersion(String)
methods. -
getMetadataStandardName
Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.getTitle()
.Returns the name of the metadata standard (including profile name) used.- Specified by:
getMetadataStandardName
in interfaceorg.opengis.metadata.Metadata
- Returns:
- name of the metadata standard used, or
null
.
-
setMetadataStandardName
Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.setTitle(InternationalString)
.Name of the metadata standard (including profile name) used.- Parameters:
newValue
- the new metadata standard name.
-
getMetadataStandardVersion
Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.getEdition()
.Returns the version (profile) of the metadata standard used.- Specified by:
getMetadataStandardVersion
in interfaceorg.opengis.metadata.Metadata
- Returns:
- version of the metadata standard used, or
null
.
-
setMetadataStandardVersion
Deprecated.As of ISO 19115:2014, replaced bygetMetadataStandards()
followed byDefaultCitation.setEdition(InternationalString)
.Sets the version (profile) of the metadata standard used.- Parameters:
newValue
- the new metadata standard version.
-
getMetadataLinkages
@UML(identifier="metadataLinkage", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.OnlineResource> getMetadataLinkages()Returns the online location(s) where the metadata is available.- Returns:
- online location(s) where the metadata is available.
- Since:
- 0.5
-
setMetadataLinkages
public void setMetadataLinkages(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets the online location(s) where the metadata is available.- Parameters:
newValues
- the new online location(s).- Since:
- 0.5
-
getDataSetUri
Deprecated.As of ISO 19115:2014, replaced bygetIdentificationInfo()
followed byAbstractIdentification.getCitation()
followed byDefaultCitation.getOnlineResources()
.Provides the URI of the dataset to which the metadata applies.- Specified by:
getDataSetUri
in interfaceorg.opengis.metadata.Metadata
- Returns:
- Uniform Resource Identifier of the dataset, or
null
.
-
setDataSetUri
Deprecated.As of ISO 19115:2014, replaced bygetIdentificationInfo()
followed byAbstractIdentification.getCitation()
followed byDefaultCitation.setOnlineResources(Collection)
.Sets the URI of the dataset to which the metadata applies. This method sets the linkage of the first online resource in the citation of the first identification info.- Parameters:
newValue
- the new data set URI.- Throws:
URISyntaxException
- if the given value cannot be parsed as a URI.
-
getSpatialRepresentationInfo
public Collection<org.opengis.metadata.spatial.SpatialRepresentation> getSpatialRepresentationInfo()Returns the digital representation of spatial information in the dataset.- Specified by:
getSpatialRepresentationInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- digital representation of spatial information in the dataset.
-
setSpatialRepresentationInfo
public void setSpatialRepresentationInfo(Collection<? extends org.opengis.metadata.spatial.SpatialRepresentation> newValues) Sets the digital representation of spatial information in the dataset.- Parameters:
newValues
- the new spatial representation info.
-
getReferenceSystemInfo
Returns the description of the spatial and temporal reference systems used in the dataset.- Specified by:
getReferenceSystemInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- spatial and temporal reference systems used in the dataset.
-
setReferenceSystemInfo
public void setReferenceSystemInfo(Collection<? extends org.opengis.referencing.ReferenceSystem> newValues) Sets the description of the spatial and temporal reference systems used in the dataset.- Parameters:
newValues
- the new reference system info.
-
getMetadataExtensionInfo
Returns information describing metadata extensions.- Specified by:
getMetadataExtensionInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- metadata extensions.
-
setMetadataExtensionInfo
public void setMetadataExtensionInfo(Collection<? extends org.opengis.metadata.MetadataExtensionInformation> newValues) Sets information describing metadata extensions.- Parameters:
newValues
- the new metadata extension info.
-
getIdentificationInfo
Returns basic information about the resource(s) to which the metadata applies.- Specified by:
getIdentificationInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the resource(s) to which the metadata applies.
-
setIdentificationInfo
public void setIdentificationInfo(Collection<? extends org.opengis.metadata.identification.Identification> newValues) Sets basic information about the resource(s) to which the metadata applies.- Parameters:
newValues
- the new identification info.
-
getContentInfo
Returns information about the feature catalogue and describes the coverage and image data characteristics.- Specified by:
getContentInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the feature catalogue, coverage descriptions and image data characteristics.
-
setContentInfo
public void setContentInfo(Collection<? extends org.opengis.metadata.content.ContentInformation> newValues) Sets information about the feature catalogue and describes the coverage and image data characteristics.- Parameters:
newValues
- the new content info.
-
getDistributionInfo
public org.opengis.metadata.distribution.Distribution getDistributionInfo()Returns information about the distributor of and options for obtaining the resource(s).Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change will tentatively be applied in GeoAPI 4.0.- Specified by:
getDistributionInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the distributor of and options for obtaining the resource(s).
-
setDistributionInfo
public void setDistributionInfo(org.opengis.metadata.distribution.Distribution newValue) Sets information about the distributor of and options for obtaining the resource(s).Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change will tentatively be applied in GeoAPI 4.0.- Parameters:
newValue
- the new distribution info.
-
getDataQualityInfo
Returns overall assessment of quality of a resource(s).- Specified by:
getDataQualityInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- overall assessment of quality of a resource(s).
-
setDataQualityInfo
public void setDataQualityInfo(Collection<? extends org.opengis.metadata.quality.DataQuality> newValues) Sets overall assessment of quality of a resource(s).- Parameters:
newValues
- the new data quality info.
-
getPortrayalCatalogueInfo
Returns information about the catalogue of rules defined for the portrayal of a resource(s).- Specified by:
getPortrayalCatalogueInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the catalogue of rules defined for the portrayal of a resource(s).
-
setPortrayalCatalogueInfo
public void setPortrayalCatalogueInfo(Collection<? extends org.opengis.metadata.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
Returns restrictions on the access and use of metadata.- Specified by:
getMetadataConstraints
in interfaceorg.opengis.metadata.Metadata
- Returns:
- restrictions on the access and use of metadata.
- See Also:
-
setMetadataConstraints
public void setMetadataConstraints(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets restrictions on the access and use of metadata.- Parameters:
newValues
- the new metadata constraints.- See Also:
-
getApplicationSchemaInfo
Returns information about the conceptual schema of a dataset.- Specified by:
getApplicationSchemaInfo
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the conceptual schema of a dataset.
-
setApplicationSchemaInfo
public void setApplicationSchemaInfo(Collection<? extends org.opengis.metadata.ApplicationSchemaInformation> newValues) Returns information about the conceptual schema of a dataset.- Parameters:
newValues
- the new application schema info.
-
getAcquisitionInformation
public Collection<org.opengis.metadata.acquisition.AcquisitionInformation> getAcquisitionInformation()Returns information about the acquisition of the data.- Specified by:
getAcquisitionInformation
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the acquisition of data.
-
setAcquisitionInformation
public void setAcquisitionInformation(Collection<? extends org.opengis.metadata.acquisition.AcquisitionInformation> newValues) Sets information about the acquisition of the data.- Parameters:
newValues
- the new acquisition information.
-
getMetadataMaintenance
public org.opengis.metadata.maintenance.MaintenanceInformation getMetadataMaintenance()Returns information about the frequency of metadata updates, and the scope of those updates.- Specified by:
getMetadataMaintenance
in interfaceorg.opengis.metadata.Metadata
- Returns:
- the frequency of metadata updates and their scope, or
null
. - See Also:
-
setMetadataMaintenance
public void setMetadataMaintenance(org.opengis.metadata.maintenance.MaintenanceInformation newValue) Sets information about the frequency of metadata updates, and the scope of those updates.- Parameters:
newValue
- the new metadata maintenance.- See Also:
-
getResourceLineages
@UML(identifier="resourceLineage", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.lineage.Lineage> getResourceLineages()Returns information about the provenance, sources and/or the production processes applied to the resource.- Returns:
- information about the provenance, sources and/or the production processes.
- Since:
- 0.5
-
setResourceLineages
public void setResourceLineages(Collection<? extends org.opengis.metadata.lineage.Lineage> newValues) Sets information about the provenance, sources and/or the production processes applied to the resource.- Parameters:
newValues
- new information about the provenance, sources and/or the production processes.- Since:
- 0.5
-
beforeMarshal
Invoked by JAXBMarshaller
before this object is marshalled to XML. This method sets the locale to be used for XML marshalling to the metadata language. -
afterMarshal
Invoked by JAXBMarshaller
after this object has been marshalled to XML. This method restores the locale to be used for XML marshalling to its previous value. -
getDefaultLocale
Gets the default locale for this record (used in ISO 19115-3:2016 format). -
setDefaultLocale
Sets the default locale for this record (used in ISO 19115-3:2016 format). -
getOtherLocales
Gets the other locales for this record (used in ISO 19115-3:2016 format). -
getCharset
Returns the character coding for the metadata set (used in legacy ISO 19157 format). -
setCharset
Sets the character coding standard for the metadata set (used in legacy ISO 19157 format). -
getDates
Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute. -
getMetadataStandard
-
getMetadataProfile
-
getAlternativeMetadataReference
-
getMetadataLinkage
-
getResourceLineage
-
getMetadataScope
-
getLocalesAndCharsets().values()
.