Package org.apache.sis.metadata.iso.identification

Class DefaultDataIdentification

java.lang.Object

org.apache.sis.metadata.AbstractMetadata

org.apache.sis.metadata.ModifiableMetadata

org.apache.sis.metadata.iso.ISOMetadata

org.apache.sis.metadata.iso.identification.AbstractIdentification

org.apache.sis.metadata.iso.identification.DefaultDataIdentification

All Implemented Interfaces:

Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.identification.DataIdentification, org.opengis.metadata.identification.Identification

Direct Known Subclasses:

DataIdentification

public class DefaultDataIdentification
extends AbstractIdentification
implements org.opengis.metadata.identification.DataIdentification

Information required to identify a dataset. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_DataIdentification ├─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). ├─language……………………………………… Language(s) used within the dataset. ├─characterSet…………………………… Full name of the character coding standard(s) used for the dataset. ├─topicCategory………………………… Main theme(s) of the dataset. └─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.

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.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata

ModifiableMetadata.State

Field Summary

Fields

Modifier and Type	Field	Description
private org.opengis.util.InternationalString	environmentDescription	Description of the dataset in the producer's processing environment, including items such as the software, the computer operating system, file name, and the dataset size
private Map<Locale,Charset>	locales	Language(s) and character set(s) used within the dataset.
private static final long	serialVersionUID	Serial number for compatibility with different versions.
private org.opengis.util.InternationalString	supplementalInformation	Any other descriptive information about the dataset.

Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
DefaultDataIdentification()	Constructs an initially empty data identification.
DefaultDataIdentification(org.opengis.metadata.citation.Citation citation, CharSequence abstracts, Locale language, org.opengis.metadata.identification.TopicCategory topicCategory)	Creates a data identification initialized to the specified values.
DefaultDataIdentification(org.opengis.metadata.identification.DataIdentification object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static DefaultDataIdentification	castOrCopy(org.opengis.metadata.identification.DataIdentification object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
private Collection<Charset>	getCharacterSet()	Returns the character coding for the metadata set (used in legacy ISO 19157 format).
Collection<org.opengis.metadata.identification.CharacterSet>	getCharacterSets()	Deprecated. Replaced by getLocalesAndCharsets().values().
private PT_Locale	getDefaultLocale()	Gets the default locale for this record (used in ISO 19115-3 format).
org.opengis.util.InternationalString	getEnvironmentDescription()	Returns a description of the resource in the producer's processing environment.
Collection<Locale>	getLanguages()	Deprecated. Replaced by getLocalesAndCharsets().keySet().
Map<Locale,Charset>	getLocalesAndCharsets()	Returns the language(s) and character set(s) used within the dataset.
private Collection<PT_Locale>	getOtherLocales()	Gets the other locales for this record (used in ISO 19115-3 format).
org.opengis.util.InternationalString	getSupplementalInformation()	Any other descriptive information about the resource.
void	setCharacterSets(Collection<? extends org.opengis.metadata.identification.CharacterSet> newValues)	Deprecated. Replaced by putting values in getLocalesAndCharsets() map.
private void	setDefaultLocale(PT_Locale newValue)	Sets the default locale for this record (used in ISO 19115-3 format).
void	setEnvironmentDescription(org.opengis.util.InternationalString newValue)	Sets the description of the resource in the producer's processing environment.
void	setLanguages(Collection<? extends Locale> newValues)	Deprecated. Replaced by putting keys in getLocalesAndCharsets() map.
void	setLocalesAndCharsets(Map<? extends Locale,? extends Charset> newValues)	Sets the language(s) and character set(s) used within the dataset.
void	setSupplementalInformation(org.opengis.util.InternationalString newValue)	Sets any other descriptive information about the resource.

Methods inherited from class org.apache.sis.metadata.iso.identification.AbstractIdentification

castOrCopy, getAbstract, getAdditionalDocumentations, getAggregationInfo, getAssociatedResources, getCitation, getCredits, getDescriptiveKeywords, getExtents, getGraphicOverviews, getPointOfContacts, getProcessingLevel, getPurpose, getResourceConstraints, getResourceFormats, getResourceMaintenances, getResourceSpecificUsages, getSpatialRepresentationTypes, getSpatialResolutions, getStatus, getTopicCategories, setAbstract, setAdditionalDocumentations, setAggregationInfo, setAssociatedResources, setCitation, setCredits, setDescriptiveKeywords, setExtents, setGraphicOverviews, setPointOfContacts, setProcessingLevel, setPurpose, setResourceConstraints, setResourceFormats, setResourceMaintenances, setResourceSpecificUsages, setSpatialRepresentationTypes, setSpatialResolutions, setStatus, setTopicCategories

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

Methods inherited from class java.lang.Object

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

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

getExtents, getSpatialRepresentationTypes, getSpatialResolutions, getTopicCategories

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

getAbstract, getAggregationInfo, getCitation, getCredits, getDescriptiveKeywords, getGraphicOverviews, getPointOfContacts, getPurpose, getResourceConstraints, getResourceFormats, getResourceMaintenances, getResourceSpecificUsages, getStatus

Field Details

serialVersionUID

private static final long serialVersionUID

Serial number for compatibility with different versions.

See Also:

• Constant Field Values

locales

private Map<Locale,Charset> locales

Language(s) and character set(s) used within the dataset.

environmentDescription

private org.opengis.util.InternationalString environmentDescription

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

supplementalInformation

private org.opengis.util.InternationalString supplementalInformation

Any other descriptive information about the dataset.

Constructor Details

DefaultDataIdentification

public DefaultDataIdentification()

Constructs an initially empty data identification.

DefaultDataIdentification

public DefaultDataIdentification(org.opengis.metadata.citation.Citation citation,
 CharSequence abstracts,
 Locale language,
 org.opengis.metadata.identification.TopicCategory topicCategory)

Creates a data identification initialized to the specified values.

Parameters:

citation - the citation data for the resource(s), or null if none.

abstracts - a brief narrative summary of the content of the resource(s), or null if none.

language - the language used within the dataset, or null if none.

topicCategory - the main theme of the dataset, or null if none.

DefaultDataIdentification

public DefaultDataIdentification(org.opengis.metadata.identification.DataIdentification 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:

• castOrCopy(DataIdentification)

Method Details

castOrCopy

public static DefaultDataIdentification castOrCopy(org.opengis.metadata.identification.DataIdentification 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 DefaultDataIdentification, then it is returned unchanged.
• Otherwise a new DefaultDataIdentification 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.

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.

getLocalesAndCharsets

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

Returns the language(s) and character set(s) used within the dataset. 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) and character set(s) used within the dataset.

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:

newValues - the new language(s) and character set(s) used within the dataset.

Since:

1.0

getLanguages

@Deprecated
public Collection<Locale> getLanguages()

Deprecated.

Replaced by getLocalesAndCharsets().keySet().

Returns the language(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.

The language string representations should use ISO 639-2 language code as returned by Locale.getISO3Language().

Specified by:

getLanguages in interface org.opengis.metadata.identification.DataIdentification

Returns:

language(s) used.

setLanguages

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

Deprecated.

Replaced by putting keys in getLocalesAndCharsets() map.

Sets the language(s) used within the resource.

Parameters:

newValues - the new languages.

getCharacterSets

@Deprecated
public Collection<org.opengis.metadata.identification.CharacterSet> getCharacterSets()

Deprecated.

Replaced by getLocalesAndCharsets().values().

Returns the character coding standard used for the dataset.

Upcoming API change — JDK integration
The element type may change to the Charset class in GeoAPI 4.0.

Specified by:

getCharacterSets in interface org.opengis.metadata.identification.DataIdentification

Returns:

character coding standard(s) used.

setCharacterSets

@Deprecated
public void setCharacterSets(Collection<? extends org.opengis.metadata.identification.CharacterSet> newValues)

Deprecated.

Replaced by putting values in getLocalesAndCharsets() map.

Sets the character coding standard used for the dataset.

Upcoming API change — JDK integration
The element type may change to the Charset class in GeoAPI 4.0.

Parameters:

newValues - the new character sets.

getEnvironmentDescription

public org.opengis.util.InternationalString getEnvironmentDescription()

Returns a description of the resource in the producer's processing environment. This includes items such as the software, the computer operating system, file name, and the dataset size.

Specified by:

getEnvironmentDescription in interface org.opengis.metadata.identification.DataIdentification

Returns:

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

setEnvironmentDescription

public void setEnvironmentDescription(org.opengis.util.InternationalString newValue)

Sets the description of the resource in the producer's processing environment.

Parameters:

newValue - the new environment description.

getSupplementalInformation

public org.opengis.util.InternationalString getSupplementalInformation()

Any other descriptive information about the resource.

Specified by:

getSupplementalInformation in interface org.opengis.metadata.identification.DataIdentification

Returns:

other descriptive information, or null.

setSupplementalInformation

public void setSupplementalInformation(org.opengis.util.InternationalString newValue)

Sets any other descriptive information about the resource.

Parameters:

newValue - the new supplemental information.

getDefaultLocale

private PT_Locale getDefaultLocale()

Gets the default locale for this record (used in ISO 19115-3 format).

setDefaultLocale

private void setDefaultLocale(PT_Locale newValue)

Sets the default locale for this record (used in ISO 19115-3 format).

getOtherLocales

private Collection<PT_Locale> getOtherLocales()

Gets the other locales for this record (used in ISO 19115-3 format).

getCharacterSet

private Collection<Charset> getCharacterSet()

Returns the character coding for the metadata set (used in legacy ISO 19157 format).

See Also:

• getCharacterSets()