Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso

Class DefaultMetadata

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultMetadata

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Metadata

public class DefaultMetadata
extends ISOMetadata
implements 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. ├─character­Set……………………………………… 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. ├─identification­Info……………………… 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. │ │ ├─geographic­Element…… Geographic component of the extent of the referring object. │ │ ├─temporal­Element………… Temporal component of the extent of the referring object. │ │ └─vertical­Element………… Vertical component of the extent of the referring object. │ └─topic­Category………………………… Main theme(s) of the dataset. ├─date­Info………………………………………………… Date(s) associated with the metadata. ├─metadata­Scope…………………………………… The scope or type of resource for which metadata is provided. │ └─resource­Scope………………………… Resource scope └─parent­Metadata………………………………… 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 the set­Language(Locale) method will be used for the localization of International­String and Code­List instances of in this Default­Metadata 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

See Also:

• Resource.get­Metadata()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Metadata()	Creates an initially empty metadata.
Default­Metadata(Responsible­Party contact, Date date­Stamp, Identification identification­Info)	Creates a meta data initialized to the specified values.
Default­Metadata(Metadata object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Metadata	cast­Or­Copy(Metadata object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
static Default­Metadata	deep­Copy(Metadata object)	Returns an editable copy of the given metadata.
Collection<Acquisition­Information>	get­Acquisition­Information()	Returns information about the acquisition of the data.
Collection<Citation>	get­Alternative­Metadata­References()	Returns reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.
Collection<Application­Schema­Information>	get­Application­Schema­Info()	Returns information about the conceptual schema of a dataset.
Character­Set	get­Character­Set()	Deprecated. Replaced by get­Locales­And­Charsets().values().
Collection<Charset>	get­Character­Sets()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by get­Locales­And­Charsets().values().
Collection<Responsible­Party>	get­Contacts()	Returns the parties responsible for the metadata information.
Collection<Content­Information>	get­Content­Info()	Returns information about the feature catalogue and describes the coverage and image data characteristics.
Collection<Data­Quality>	get­Data­Quality­Info()	Returns overall assessment of quality of a resource(s).
String	get­Data­Set­Uri()	Deprecated. As of ISO 19115:2014, replaced by get­Identification­Info() followed by Abstract­Identification.get­Citation() followed by Default­Citation.get­Online­Resources().
Collection<Citation­Date>	get­Date­Info()	Returns the date(s) associated with the metadata.
Date	get­Date­Stamp()	Deprecated. As of ISO 19115:2014, replaced by get­Date­Info().
Distribution	get­Distribution­Info()	Returns information about the distributor of and options for obtaining the resource(s).
String	get­File­Identifier()	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Identifier() in order to include the codespace attribute.
final Collection<String>	get­Hierarchy­Level­Names()	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Scopes() followed by Default­Metadata­Scope.get­Name().
final Collection<Scope­Code>	get­Hierarchy­Levels()	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Scopes() followed by Default­Metadata­Scope.get­Resource­Scope().
Collection<Identification>	get­Identification­Info()	Returns basic information about the resource(s) to which the metadata applies.
Locale	get­Language()	Deprecated. Replaced by get­Locales­And­Charsets().key­Set().
Collection<Locale>	get­Languages()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by get­Locales­And­Charsets().key­Set().
Collection<Locale>	get­Locales()	Deprecated. Replaced by get­Locales­And­Charsets().key­Set().
Map<Locale,Charset>	get­Locales­And­Charsets()	Returns the language(s) and character set(s) used for documenting metadata.
Collection<Constraints>	get­Metadata­Constraints()	Returns restrictions on the access and use of metadata.
Collection<Metadata­Extension­Information>	get­Metadata­Extension­Info()	Returns information describing metadata extensions.
Identifier	get­Metadata­Identifier()	Returns a unique identifier for this metadata record.
Collection<Online­Resource>	get­Metadata­Linkages()	Returns the online location(s) where the metadata is available.
Maintenance­Information	get­Metadata­Maintenance()	Returns information about the frequency of metadata updates, and the scope of those updates.
Collection<Citation>	get­Metadata­Profiles()	Returns the citation(s) for the profile(s) of the metadata standard to which the metadata conform.
Collection<Default­Metadata­Scope>	get­Metadata­Scopes()	Returns the scope or type of resource for which metadata is provided.
String	get­Metadata­Standard­Name()	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.get­Title().
Collection<Citation>	get­Metadata­Standards()	Returns the citation(s) for the standard(s) to which the metadata conform.
String	get­Metadata­Standard­Version()	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.get­Edition().
String	get­Parent­Identifier()	Deprecated. As of ISO 19115:2014, replaced by get­Parent­Metadata().
Citation	get­Parent­Metadata()	Returns an identification of the parent metadata record.
Collection<Portrayal­Catalogue­Reference>	get­Portrayal­Catalogue­Info()	Returns information about the catalogue of rules defined for the portrayal of a resource(s).
Collection<Reference­System>	get­Reference­System­Info()	Returns the description of the spatial and temporal reference systems used in the dataset.
Collection<Lineage>	get­Resource­Lineages()	Returns information about the provenance, sources and/or the production processes applied to the resource.
Collection<Spatial­Representation>	get­Spatial­Representation­Info()	Returns the digital representation of spatial information in the dataset.
void	set­Acquisition­Information(Collection<? extends Acquisition­Information> new­Values)	Sets information about the acquisition of the data.
void	set­Alternative­Metadata­References(Collection<? extends Citation> new­Values)	Set reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.
void	set­Application­Schema­Info(Collection<? extends Application­Schema­Information> new­Values)	Returns information about the conceptual schema of a dataset.
void	set­Character­Set(Character­Set new­Value)	Deprecated. Replaced by get­Locales­And­Charsets().put(…, new­Value).
void	set­Character­Sets(Collection<? extends Charset> new­Values)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by putting values in get­Locales­And­Charsets() map.
void	set­Contacts(Collection<? extends Responsible­Party> new­Values)	Sets the parties responsible for the metadata information.
void	set­Content­Info(Collection<? extends Content­Information> new­Values)	Sets information about the feature catalogue and describes the coverage and image data characteristics.
void	set­Data­Quality­Info(Collection<? extends Data­Quality> new­Values)	Sets overall assessment of quality of a resource(s).
void	set­Data­Set­Uri(String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Identification­Info() followed by Abstract­Identification.get­Citation() followed by Default­Citation.set­Online­Resources(Collection).
void	set­Date­Info(Collection<? extends Citation­Date> new­Values)	Sets the date(s) associated with the metadata.
void	set­Date­Stamp(Date new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Date­Info(Collection).
void	set­Distribution­Info(Distribution new­Value)	Sets information about the distributor of and options for obtaining the resource(s).
void	set­File­Identifier(String new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Metadata­Identifier(Identifier)
void	set­Hierarchy­Level­Names(Collection<? extends String> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Metadata­Scopes(Collection) and Default­Metadata­Scope.set­Name(International­String).
void	set­Hierarchy­Levels(Collection<? extends Scope­Code> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Metadata­Scopes(Collection) and Default­Metadata­Scope.set­Resource­Scope(Scope­Code).
void	set­Identification­Info(Collection<? extends Identification> new­Values)	Sets basic information about the resource(s) to which the metadata applies.
void	set­Language(Locale new­Value)	Deprecated. Replaced by get­Locales­And­Charsets().put(new­Value, …).
void	set­Languages(Collection<Locale> new­Values)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by putting keys in get­Locales­And­Charsets() map.
void	set­Locales(Collection<? extends Locale> new­Values)	Deprecated. Replaced by putting keys in get­Locales­And­Charsets().
void	set­Locales­And­Charsets(Map<? extends Locale,? extends Charset> new­Values)	Sets the language(s) and character set(s) used within the dataset.
void	set­Metadata­Constraints(Collection<? extends Constraints> new­Values)	Sets restrictions on the access and use of metadata.
void	set­Metadata­Extension­Info(Collection<? extends Metadata­Extension­Information> new­Values)	Sets information describing metadata extensions.
void	set­Metadata­Identifier(Identifier new­Value)	Sets the unique identifier for this metadata record.
void	set­Metadata­Linkages(Collection<? extends Online­Resource> new­Values)	Sets the online location(s) where the metadata is available.
void	set­Metadata­Maintenance(Maintenance­Information new­Value)	Sets information about the frequency of metadata updates, and the scope of those updates.
void	set­Metadata­Profiles(Collection<? extends Citation> new­Values)	Set the citation(s) for the profile(s) of the metadata standard to which the metadata conform.
void	set­Metadata­Scopes(Collection<? extends Default­Metadata­Scope> new­Values)	Sets the scope or type of resource for which metadata is provided.
void	set­Metadata­Standard­Name(String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.set­Title(International­String).
void	set­Metadata­Standards(Collection<? extends Citation> new­Values)	Sets the citation(s) for the standard(s) to which the metadata conform.
void	set­Metadata­Standard­Version(String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.set­Edition(International­String).
void	set­Parent­Identifier(String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Parent­Metadata().
void	set­Parent­Metadata(Citation new­Value)	Sets an identification of the parent metadata record.
void	set­Portrayal­Catalogue­Info(Collection<? extends Portrayal­Catalogue­Reference> new­Values)	Sets information about the catalogue of rules defined for the portrayal of a resource(s).
void	set­Reference­System­Info(Collection<? extends Reference­System> new­Values)	Sets the description of the spatial and temporal reference systems used in the dataset.
void	set­Resource­Lineages(Collection<? extends Lineage> new­Values)	Sets information about the provenance, sources and/or the production processes applied to the resource.
void	set­Spatial­Representation­Info(Collection<? extends Spatial­Representation> new­Values)	Sets the digital representation of spatial information in the dataset.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultMetadata

public DefaultMetadata()

Creates an initially empty metadata.

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.

date­Stamp - date that the metadata was created.

identification­Info - basic information about the resource to which the metadata applies.

DefaultMetadata

public DefaultMetadata(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, or null if none.

See Also:

• cast­Or­Copy(Metadata)

Method Details

castOrCopy

public static DefaultMetadata castOrCopy(Metadata object)

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 returns null.
• Otherwise if the given object is already an instance of Default­Metadata, then it is returned unchanged.
• Otherwise a new Default­Metadata 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, see deep­Copy(Metadata).

Parameters:

object - the object to get as a SIS implementation, or null 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.

deepCopy

public static DefaultMetadata deepCopy(Metadata object)

Returns an editable copy of the given metadata. All children are also copied. This method is more expensive than cast­Or­Copy(Metadata) because the copy is unconditional and much deeper. However, the result is guaranteed to be editable.

Use case

Metadata returned by Resource.get­Metadata() are typically unmodifiable. This deep­Copy(…) method is useful for completing those metadata with new elements, for example before insertion in a catalog.

Parameters:

object - the metadata to copy, or null if none.

Returns:

a deep copy of the given object, or null if the argument was null.

Since:

1.1

See Also:

• Modifiable­Metadata.deep­Copy(State)
• Modifiable­Metadata.State.EDITABLE

getMetadataIdentifier

@UML(identifier="metadataIdentifier",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Identifier getMetadataIdentifier()

Returns a unique identifier for this metadata record.

Standard usage

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(Identifier newValue)

Sets the unique identifier for this metadata record.

Parameters:

new­Value - the new identifier, or null if none.

Since:

0.5

getFileIdentifier

@Deprecated(since="1.0")
public String getFileIdentifier()

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Identifier() in order to include the codespace attribute.

Returns the unique identifier for this metadata file.

Specified by:

get­File­Identifier in interface Metadata

Returns:

unique identifier for this metadata file, or null.

setFileIdentifier

@Deprecated(since="1.0")
public void setFileIdentifier(String newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Metadata­Identifier(Identifier)

Sets the unique identifier for this metadata file.

Parameters:

new­Value - the new identifier, or null 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, this Default­Metadata instance and its children will use the first locale returned by this method for marshalling International­String and Code­List instances in ISO 19115-2 compliant XML documents.

Each (Locale, Charset) entry is equivalent to an instance of ISO 19115 PT_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

public void setLocalesAndCharsets(Map<? extends Locale,? extends Charset> newValues)

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:

new­Values - the new language(s) and character set(s) used for documenting metadata.

Since:

1.0

See Also:

• XML.LOCALE

getLanguages

@Deprecated(since="1.0",
            forRemoval=true)
public Collection<Locale> getLanguages()

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by get­Locales­And­Charsets().key­Set().

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(since="1.0",
            forRemoval=true)
public void setLanguages(Collection<Locale> newValues)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by putting keys in get­Locales­And­Charsets() 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:

new­Values - the new languages.

Since:

0.5

getLanguage

@Deprecated(since="1.0")
public Locale getLanguage()

Deprecated.

Replaced by get­Locales­And­Charsets().key­Set().

Returns the default language used for documenting metadata.

Specified by:

get­Language in interface Metadata

Returns:

language used for documenting metadata, or null.

setLanguage

@Deprecated(since="1.0")
public void setLanguage(Locale newValue)

Deprecated.

Replaced by get­Locales­And­Charsets().put(new­Value, …).

Sets the language used for documenting metadata. This method modifies the collection returned by get­Languages() as below:

• If the languages collection is empty, then this method sets the collection to the given new­Value.
• Otherwise the first element in the languages collection is replaced by the given new­Value.

Parameters:

new­Value - the new language.

getLocales

@Deprecated(since="1.0")
public Collection<Locale> getLocales()

Deprecated.

Replaced by get­Locales­And­Charsets().key­Set().

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

Specified by:

get­Locales in interface Metadata

Returns:

alternatively used localized character string for a linguistic extension.

setLocales

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

Deprecated.

Replaced by putting keys in get­Locales­And­Charsets().

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

Parameters:

new­Values - the new locales.

getCharacterSets

@Deprecated(since="1.0",
            forRemoval=true)
public Collection<Charset> getCharacterSets()

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by get­Locales­And­Charsets().values().

Returns the character coding standard used for the metadata set.

Returns:

character coding standards used for the metadata.

Since:

0.5

setCharacterSets

@Deprecated(since="1.0",
            forRemoval=true)
public void setCharacterSets(Collection<? extends Charset> newValues)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by putting values in get­Locales­And­Charsets() map.

Sets the character coding standard used for the metadata set.

Parameters:

new­Values - the new character coding standards.

Since:

0.5

getCharacterSet

@Deprecated(since="1.0")
public CharacterSet getCharacterSet()

Deprecated.

Replaced by get­Locales­And­Charsets().values().

Returns the character coding standard used for the metadata set.

Specified by:

get­Character­Set in interface Metadata

Returns:

character coding standard used for the metadata, or null.

setCharacterSet

@Deprecated(since="1.0")
public void setCharacterSet(CharacterSet newValue)

Deprecated.

Replaced by get­Locales­And­Charsets().put(…, new­Value).

Sets the character coding standard used for the metadata set.

Parameters:

new­Value - the new character set.

getParentMetadata

@UML(identifier="parentMetadata",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public 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(Citation newValue)

Sets an identification of the parent metadata record.

Parameters:

new­Value - the new identification of the parent metadata record.

Since:

0.5

getParentIdentifier

@Deprecated(since="1.0")
public String getParentIdentifier()

Deprecated.

As of ISO 19115:2014, replaced by get­Parent­Metadata().

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

Specified by:

get­Parent­Identifier in interface Metadata

Returns:

identifier of the metadata to which this metadata is a subset, or null.

setParentIdentifier

@Deprecated(since="1.0")
public void setParentIdentifier(String newValue)

Deprecated.

As of ISO 19115:2014, replaced by get­Parent­Metadata().

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

Parameters:

new­Value - 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 the Metadata­Scope 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

public void setMetadataScopes(Collection<? extends DefaultMetadataScope> newValues)

Sets the scope or type of resource for which metadata is provided.

Upcoming API change — generalization
The element type will be changed to the Metadata­Scope interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Parameters:

new­Values - the new scope or type of resource.

Since:

0.5

getHierarchyLevels

@Deprecated(since="1.0")
public final Collection<ScopeCode> getHierarchyLevels()

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Scopes() followed by Default­Metadata­Scope.get­Resource­Scope().

Returns the scope to which the metadata applies.

Specified by:

get­Hierarchy­Levels in interface Metadata

Returns:

scope to which the metadata applies.

setHierarchyLevels

@Deprecated(since="1.0")
public void setHierarchyLevels(Collection<? extends ScopeCode> newValues)

Deprecated.

As of ISO 19115:2014, replaced by set­Metadata­Scopes(Collection) and Default­Metadata­Scope.set­Resource­Scope(Scope­Code).

Sets the scope to which the metadata applies.

Parameters:

new­Values - the new hierarchy levels.

getHierarchyLevelNames

@Deprecated(since="1.0")
public final Collection<String> getHierarchyLevelNames()

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Scopes() followed by Default­Metadata­Scope.get­Name().

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

Specified by:

get­Hierarchy­Level­Names in interface Metadata

Returns:

hierarchy levels for which the metadata is provided.

setHierarchyLevelNames

@Deprecated(since="1.0")
public void setHierarchyLevelNames(Collection<? extends String> newValues)

Deprecated.

As of ISO 19115:2014, replaced by set­Metadata­Scopes(Collection) and Default­Metadata­Scope.set­Name(International­String).

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

Parameters:

new­Values - the new hierarchy level names.

getContacts

public Collection<ResponsibleParty> getContacts()

Returns the parties responsible for the metadata information.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change will be tentatively applied in GeoAPI 4.0.

Specified by:

get­Contacts in interface Metadata

Returns:

parties responsible for the metadata information.

setContacts

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

Sets the parties responsible for the metadata information.

Parameters:

new­Values - the new contacts.

getDateInfo

@UML(identifier="dateInfo",
     obligation=MANDATORY,
     specification=ISO_19115)
public Collection<CitationDate> getDateInfo()

Returns the date(s) associated with the metadata.

Returns:

date(s) associated with the metadata.

Since:

0.5

See Also:

• Citation.get­Dates()

setDateInfo

public void setDateInfo(Collection<? extends CitationDate> newValues)

Sets the date(s) associated with the metadata. The collection should contain at least an element for Date­Type.CREATION.

Parameters:

new­Values - new dates associated with the metadata.

Since:

0.5

getDateStamp

@Deprecated(since="1.0")
public Date getDateStamp()

Deprecated.

As of ISO 19115:2014, replaced by get­Date­Info().

Returns the date that the metadata was created.

Specified by:

get­Date­Stamp in interface Metadata

Returns:

date that the metadata was created, or null.

setDateStamp

@Deprecated(since="1.0")
public void setDateStamp(Date newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Date­Info(Collection).

Sets the date that the metadata was created.

Parameters:

new­Value - the new date stamp.

getMetadataStandards

@UML(identifier="metadataStandard",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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 the Citations.ISO_19115 list.

Returns:

the standard(s) to which the metadata conform.

Since:

0.5

See Also:

• get­Metadata­Profiles()

setMetadataStandards

public void setMetadataStandards(Collection<? extends Citation> newValues)

Sets the citation(s) for the standard(s) to which the metadata conform. Metadata standard citations should include an identifier.

Parameters:

new­Values - the new standard(s) to which the metadata conform.

Since:

0.5

getMetadataProfiles

@UML(identifier="metadataProfile",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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:

• get­Metadata­Standards()
• get­Metadata­Extension­Info()

setMetadataProfiles

public void setMetadataProfiles(Collection<? extends 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:

new­Values - the new profile(s) to which the metadata conform.

Since:

0.5

getAlternativeMetadataReferences

@UML(identifier="alternativeMetadataReference",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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 Citation> newValues)

Set reference(s) to alternative metadata or metadata in a non-ISO standard for the same resource.

Parameters:

new­Values - the new reference(s) to alternative metadata (e.g. Dublin core, FGDC).

Since:

0.5

getMetadataStandardName

@Deprecated(since="1.0")
public String getMetadataStandardName()

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.get­Title().

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

Specified by:

get­Metadata­Standard­Name in interface Metadata

Returns:

name of the metadata standard used, or null.

setMetadataStandardName

@Deprecated(since="1.0")
public void setMetadataStandardName(String newValue)

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.set­Title(International­String).

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

Parameters:

new­Value - the new metadata standard name.

getMetadataStandardVersion

@Deprecated(since="1.0")
public String getMetadataStandardVersion()

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.get­Edition().

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

Specified by:

get­Metadata­Standard­Version in interface Metadata

Returns:

version of the metadata standard used, or null.

setMetadataStandardVersion

@Deprecated(since="1.0")
public void setMetadataStandardVersion(String newValue)

Deprecated.

As of ISO 19115:2014, replaced by get­Metadata­Standards() followed by Default­Citation.set­Edition(International­String).

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

Parameters:

new­Value - the new metadata standard version.

getMetadataLinkages

@UML(identifier="metadataLinkage",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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 OnlineResource> newValues)

Sets the online location(s) where the metadata is available.

Parameters:

new­Values - the new online location(s).

Since:

0.5

getDataSetUri

@Deprecated(since="1.0")
public String getDataSetUri()

Deprecated.

As of ISO 19115:2014, replaced by get­Identification­Info() followed by Abstract­Identification.get­Citation() followed by Default­Citation.get­Online­Resources().

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

Specified by:

get­Data­Set­Uri in interface Metadata

Returns:

Uniform Resource Identifier of the dataset, or null.

setDataSetUri

@Deprecated(since="1.0")
public void setDataSetUri(String newValue)
                   throws URISyntaxException

Deprecated.

As of ISO 19115:2014, replaced by get­Identification­Info() followed by Abstract­Identification.get­Citation() followed by Default­Citation.set­Online­Resources(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:

new­Value - the new data set URI.

Throws:

URISyntax­Exception - if the given value cannot be parsed as a URI.

getSpatialRepresentationInfo

public Collection<SpatialRepresentation> getSpatialRepresentationInfo()

Returns the digital representation of spatial information in the dataset.

Specified by:

get­Spatial­Representation­Info in interface Metadata

Returns:

digital representation of spatial information in the dataset.

setSpatialRepresentationInfo

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

Sets the digital representation of spatial information in the dataset.

Parameters:

new­Values - 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:

get­Reference­System­Info in interface Metadata

Returns:

spatial and temporal reference systems used in the dataset.

setReferenceSystemInfo

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

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

Parameters:

new­Values - the new reference system info.

getMetadataExtensionInfo

public Collection<MetadataExtensionInformation> getMetadataExtensionInfo()

Returns information describing metadata extensions.

Specified by:

get­Metadata­Extension­Info in interface Metadata

Returns:

metadata extensions.

setMetadataExtensionInfo

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

Sets information describing metadata extensions.

Parameters:

new­Values - the new metadata extension info.

getIdentificationInfo

public Collection<Identification> getIdentificationInfo()

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

Specified by:

get­Identification­Info in interface Metadata

Returns:

the resource(s) to which the metadata applies.

setIdentificationInfo

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

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

Parameters:

new­Values - the new identification info.

getContentInfo

public Collection<ContentInformation> getContentInfo()

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

Specified by:

get­Content­Info in interface Metadata

Returns:

the feature catalogue, coverage descriptions and image data characteristics.

setContentInfo

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

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

Parameters:

new­Values - the new content info.

getDistributionInfo

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

get­Distribution­Info in interface Metadata

Returns:

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

setDistributionInfo

public void setDistributionInfo(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:

new­Value - the new distribution info.

getDataQualityInfo

public Collection<DataQuality> getDataQualityInfo()

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

Specified by:

get­Data­Quality­Info in interface Metadata

Returns:

overall assessment of quality of a resource(s).

setDataQualityInfo

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

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

Parameters:

new­Values - the new data quality info.

getPortrayalCatalogueInfo

public Collection<PortrayalCatalogueReference> getPortrayalCatalogueInfo()

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

Specified by:

get­Portrayal­Catalogue­Info in interface Metadata

Returns:

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

setPortrayalCatalogueInfo

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

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

Parameters:

new­Values - the new portrayal catalog info.

getMetadataConstraints

public Collection<Constraints> getMetadataConstraints()

Returns restrictions on the access and use of metadata.

Specified by:

get­Metadata­Constraints in interface Metadata

Returns:

restrictions on the access and use of metadata.

See Also:

• Abstract­Identification.get­Resource­Constraints()

setMetadataConstraints

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

Sets restrictions on the access and use of metadata.

Parameters:

new­Values - the new metadata constraints.

See Also:

• Abstract­Identification.set­Resource­Constraints(Collection)

getApplicationSchemaInfo

public Collection<ApplicationSchemaInformation> getApplicationSchemaInfo()

Returns information about the conceptual schema of a dataset.

Specified by:

get­Application­Schema­Info in interface Metadata

Returns:

the conceptual schema of a dataset.

setApplicationSchemaInfo

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

Returns information about the conceptual schema of a dataset.

Parameters:

new­Values - the new application schema info.

getAcquisitionInformation

public Collection<AcquisitionInformation> getAcquisitionInformation()

Returns information about the acquisition of the data.

Specified by:

get­Acquisition­Information in interface Metadata

Returns:

the acquisition of data.

setAcquisitionInformation

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

Sets information about the acquisition of the data.

Parameters:

new­Values - the new acquisition information.

getMetadataMaintenance

public MaintenanceInformation getMetadataMaintenance()

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

Specified by:

get­Metadata­Maintenance in interface Metadata

Returns:

the frequency of metadata updates and their scope, or null.

See Also:

• Abstract­Identification.get­Resource­Maintenances()

setMetadataMaintenance

public void setMetadataMaintenance(MaintenanceInformation newValue)

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

Parameters:

new­Value - the new metadata maintenance.

See Also:

• Abstract­Identification.set­Resource­Maintenances(Collection)

getResourceLineages

@UML(identifier="resourceLineage",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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 Lineage> newValues)

Sets information about the provenance, sources and/or the production processes applied to the resource.

Parameters:

new­Values - new information about the provenance, sources and/or the production processes.

Since:

0.5