Module org.opengis.geoapi

Package org.opengis.metadata.identification

Interface DataIdentification

All Superinterfaces:

Identification

@UML(identifier="MD_DataIdentification",
     specification=ISO_19115)
public interface DataIdentification
extends Identification

Information required to identify a resource.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default Collection<CharacterSet>	getCharacterSets()	Deprecated. Replaced by getLocalesAndCharsets().values().
default InternationalString	getEnvironmentDescription()	Description of the resource in the producer's processing environment, including items such as the software, the computer operating system, file name, and the dataset size.
default Collection<Locale>	getLanguages()	Deprecated. Replaced by getLocalesAndCharsets().keySet().
default Map<Locale,Charset>	getLocalesAndCharsets()	Language(s) and character set(s) used within the resource.
default InternationalString	getSupplementalInformation()	Any other descriptive information about the resource.

Methods inherited from interface org.opengis.metadata.identification.Identification

getAbstract, getAdditionalDocumentations, getAggregationInfo, getAssociatedResources, getCitation, getCredits, getDescriptiveKeywords, getExtents, getGraphicOverviews, getPointOfContacts, getProcessingLevel, getPurpose, getResourceConstraints, getResourceFormats, getResourceMaintenances, getResourceSpecificUsages, getSpatialRepresentationTypes, getSpatialResolutions, getStatus, getTemporalResolutions, getTopicCategories

Method Details

getLocalesAndCharsets

@Profile(level=CORE)
@UML(identifier="defaultLocale+otherLocale",
     obligation=CONDITIONAL,
     specification=ISO_19115)
default Map<Locale,Charset> getLocalesAndCharsets()

Language(s) and character set(s) used within the resource. The first element in iteration order shall be the default language. All other elements, if any, are alternate language(s) used within the resource. Note that contrarily to the PT_Locale object defined by ISO 19115:2014, the java.util.Locale object does not contain character encoding information. The character set information is stored in separated objects, associated to locales through entries in the map.

XML representation

XML documents shall format languages using the ISO 639-2 language code as returned by Locale.getISO3Language(). Character sets shall be referenced by name from the IANA Character Set register.

Returns:

language(s) and character set(s) used within the resource.

Since:

3.1

See Also:

• Metadata.getLocalesAndCharsets()
• FeatureCatalogueDescription.getLocalesAndCharsets()

Departure from OGC/ISO standard for closer integration with the Java environment

GeoAPI replaces ISO 19115:2014 LanguageCode, CountryCode and MD_CharacterSetCode code lists by equivalent objects from the standard Java library. See org.opengis.metadata.Metadata#getLocalesAndCharsets() for more information.

Condition:

Mandatory if language used in resource.

getLanguages

@Deprecated(since="3.1")
@UML(identifier="language",
     obligation=MANDATORY,
     specification=ISO_19115,
     version=2003)
default Collection<Locale> getLanguages()

Deprecated.

Replaced by getLocalesAndCharsets().keySet().

Language(s) used within the resource.

Returns:

language(s) used.

getCharacterSets

@Deprecated(since="3.1")
@UML(identifier="characterSet",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default Collection<CharacterSet> getCharacterSets()

Deprecated.

Replaced by getLocalesAndCharsets().values().

The character coding standard(s) used for the dataset.

Upcoming API change — JDK integration
As of ISO 19115:2014, CharacterSet is replaced by a reference to the IANA Character Set register, which is represented in Java by Charset. This change may be applied in GeoAPI 4.0.

Returns:

the character coding standard(s) used.

getEnvironmentDescription

@UML(identifier="environmentDescription",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getEnvironmentDescription()

Description of the resource in the producer's processing environment, including items such as the software, the computer operating system, file name, and the dataset size.

Returns:

description of the resource in the producer's processing environment, or null.

getSupplementalInformation

@UML(identifier="supplementalInformation",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getSupplementalInformation()

Any other descriptive information about the resource.

Returns:

other descriptive information, or null.