Module org.apache.sis.metadata

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

Class DefaultDataIdentification

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractIdentification

DefaultDataIdentification

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Data­Identification, Identification

public class DefaultDataIdentification
extends AbstractIdentification
implements 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_Data­Identification ├─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. ├─character­Set…………………………… Full name of the character coding standard(s) used for the dataset. ├─topic­Category………………………… 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. ├─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.

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:

• 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­Data­Identification()	Constructs an initially empty data identification.
Default­Data­Identification(Citation citation, Char­Sequence abstracts, Locale language, Topic­Category topic­Category)	Creates a data identification initialized to the specified values.
Default­Data­Identification(Data­Identification object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Data­Identification	cast­Or­Copy(Data­Identification object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Character­Set>	get­Character­Sets()	Deprecated. Replaced by get­Locales­And­Charsets().values().
International­String	get­Environment­Description()	Returns a description of the resource in the producer's processing environment.
Collection<Locale>	get­Languages()	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 within the dataset.
International­String	get­Supplemental­Information()	Any other descriptive information about the resource.
void	set­Character­Sets(Collection<? extends Character­Set> new­Values)	Deprecated. Replaced by putting values in get­Locales­And­Charsets() map.
void	set­Environment­Description(International­String new­Value)	Sets the description of the resource in the producer's processing environment.
void	set­Languages(Collection<? extends Locale> new­Values)	Deprecated. Replaced by putting keys in get­Locales­And­Charsets() map.
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­Supplemental­Information(International­String new­Value)	Sets any other descriptive information about the resource.

Methods inherited from class AbstractIdentification

cast­Or­Copy, get­Abstract, get­Additional­Documentations, get­Aggregation­Info, get­Associated­Resources, get­Citation, get­Credits, get­Descriptive­Keywords, get­Extents, get­Graphic­Overviews, get­Point­Of­Contacts, get­Processing­Level, get­Purpose, get­Resource­Constraints, get­Resource­Formats, get­Resource­Maintenances, get­Resource­Specific­Usages, get­Spatial­Representation­Types, get­Spatial­Resolutions, get­Status, get­Topic­Categories, set­Abstract, set­Additional­Documentations, set­Aggregation­Info, set­Associated­Resources, set­Citation, set­Credits, set­Descriptive­Keywords, set­Extents, set­Graphic­Overviews, set­Point­Of­Contacts, set­Processing­Level, set­Purpose, set­Resource­Constraints, set­Resource­Formats, set­Resource­Maintenances, set­Resource­Specific­Usages, set­Spatial­Representation­Types, set­Spatial­Resolutions, set­Status, set­Topic­Categories

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

Methods inherited from interface DataIdentification

get­Extents, get­Spatial­Representation­Types, get­Spatial­Resolutions, get­Topic­Categories

Methods inherited from interface Identification

get­Abstract, get­Aggregation­Info, get­Citation, get­Credits, get­Descriptive­Keywords, get­Graphic­Overviews, get­Point­Of­Contacts, get­Purpose, get­Resource­Constraints, get­Resource­Formats, get­Resource­Maintenances, get­Resource­Specific­Usages, get­Status

Constructor Details

DefaultDataIdentification

public DefaultDataIdentification()

Constructs an initially empty data identification.

DefaultDataIdentification

public DefaultDataIdentification(Citation citation,
 CharSequence abstracts,
 Locale language,
 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.

topic­Category - the main theme of the dataset, or null if none.

DefaultDataIdentification

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

• cast­Or­Copy(Data­Identification)

Method Details

castOrCopy

public static DefaultDataIdentification castOrCopy(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 Default­Data­Identification, then it is returned unchanged.
• Otherwise a new Default­Data­Identification 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:

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

Since:

1.0

getLanguages

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

Deprecated.

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

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.get­ISO3Language().

Specified by:

get­Languages in interface Data­Identification

Returns:

language(s) used.

setLanguages

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

Deprecated.

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

Sets the language(s) used within the resource.

Parameters:

new­Values - the new languages.

getCharacterSets

@Deprecated(since="1.0")
public Collection<CharacterSet> getCharacterSets()

Deprecated.

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

get­Character­Sets in interface Data­Identification

Returns:

character coding standard(s) used.

setCharacterSets

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

Deprecated.

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

new­Values - the new character sets.

getEnvironmentDescription

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

get­Environment­Description in interface Data­Identification

Returns:

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

setEnvironmentDescription

public void setEnvironmentDescription(InternationalString newValue)

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

Parameters:

new­Value - the new environment description.

getSupplementalInformation

public InternationalString getSupplementalInformation()

Any other descriptive information about the resource.

Specified by:

get­Supplemental­Information in interface Data­Identification

Returns:

other descriptive information, or null.

setSupplementalInformation

public void setSupplementalInformation(InternationalString newValue)

Sets any other descriptive information about the resource.

Parameters:

new­Value - the new supplemental information.