org.geotoolkit.metadata.iso.identification
Class DefaultDataIdentification

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractIdentification
                  DefaultDataIdentification

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, DataIdentification, Identification

@ThreadSafe
public class DefaultDataIdentification
extends AbstractIdentification
implements DataIdentification

Information required to identify a dataset.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultDataIdentification()
Constructs an initially empty data identification.

DefaultDataIdentification(Citation citation, InternationalString abstracts, Collection<? extends Locale> language, Collection<? extends TopicCategory> topicCategories)
Creates a data identification initialized to the specified values.

DefaultDataIdentification(DataIdentification source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultDataIdentification	castOrCopy(DataIdentification object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<CharacterSet>	getCharacterSets() Returns the full name of the character coding standard used for the dataset.
InternationalString	getEnvironmentDescription() Returns a description of the dataset in the producer's processing environment.
Collection<Extent>	getExtents() Returns additional extent information including the bounding polygon, vertical, and temporal extent of the dataset.
Collection<Locale>	getLanguages() Returns the language(s) used within the dataset.
Collection<SpatialRepresentationType>	getSpatialRepresentationTypes() Returns the method used to spatially represent geographic information.
Collection<Resolution>	getSpatialResolutions() Returns the factor which provides a general understanding of the density of spatial data in the dataset.
InternationalString	getSupplementalInformation() Any other descriptive information about the dataset.
Collection<TopicCategory>	getTopicCategories() Returns the main theme(s) of the dataset.
void	setCharacterSets(Collection<? extends CharacterSet> newValues) Sets the full name of the character coding standard used for the dataset.
void	setEnvironmentDescription(InternationalString newValue) Sets the description of the dataset in the producer’s processing environment.
void	setExtents(Collection<? extends Extent> newValues) Sets additional extent information.
void	setLanguages(Collection<? extends Locale> newValues) Sets the language(s) used within the dataset.
void	setSpatialRepresentationTypes(Collection<? extends SpatialRepresentationType> newValues) Sets the method used to spatially represent geographic information.
void	setSpatialResolutions(Collection<? extends Resolution> newValues) Sets the factor which provides a general understanding of the density of spatial data in the dataset.
void	setSupplementalInformation(InternationalString newValue) Sets any other descriptive information about the dataset.
void	setTopicCategories(Collection<? extends TopicCategory> newValues) Sets the main theme(s) of the dataset.

Methods inherited from class AbstractIdentification

castOrCopy, getAbstract, getAggregationInfo, getCitation, getCredits, getDescriptiveKeywords, getGraphicOverviews, getPointOfContacts, getPurpose, getResourceConstraints, getResourceFormats, getResourceMaintenances, getResourceSpecificUsages, getStatus, setAbstract, setAggregationInfo, setCitation, setCredits, setDescriptiveKeywords, setGraphicOverviews, setPointOfContacts, setPurpose, setResourceConstraints, setResourceFormats, setResourceMaintenances, setResourceSpecificUsages, setStatus

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

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

Methods inherited from interface Identification

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

Constructor Detail

DefaultDataIdentification

public DefaultDataIdentification()

Constructs an initially empty data identification.

DefaultDataIdentification

public DefaultDataIdentification(DataIdentification source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultDataIdentification

public DefaultDataIdentification(Citation citation,
                                 InternationalString abstracts,
                                 Collection<? extends Locale> language,
                                 Collection<? extends TopicCategory> topicCategories)

Creates a data identification initialized to the specified values.

Parameters:

citation - The citation data for the resource(s).

abstracts - A brief narrative summary of the content of the resource(s).

language - The language(s) used within the dataset.

topicCategories - The main theme(s) of the dataset.

Method Detail

castOrCopy

public static DefaultDataIdentification castOrCopy(DataIdentification object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getSpatialRepresentationTypes

public Collection<SpatialRepresentationType> getSpatialRepresentationTypes()

Returns the method used to spatially represent geographic information.

Specified by:

getSpatialRepresentationTypes in interface DataIdentification

setSpatialRepresentationTypes

public void setSpatialRepresentationTypes(Collection<? extends SpatialRepresentationType> newValues)

Sets the method used to spatially represent geographic information.

Parameters:

newValues - The new spatial representation types.

getSpatialResolutions

public Collection<Resolution> getSpatialResolutions()

Returns the factor which provides a general understanding of the density of spatial data in the dataset.

Specified by:

getSpatialResolutions in interface DataIdentification

setSpatialResolutions

public void setSpatialResolutions(Collection<? extends Resolution> newValues)

Sets the factor which provides a general understanding of the density of spatial data in the dataset.

Parameters:

newValues - The new spatial resolutions.

getLanguages

public Collection<Locale> getLanguages()

Returns the language(s) used within the dataset.

Specified by:

getLanguages in interface DataIdentification

setLanguages

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

Sets the language(s) used within the dataset.

Parameters:

newValues - The new languages.

getCharacterSets

public Collection<CharacterSet> getCharacterSets()

Returns the full name of the character coding standard used for the dataset.

Specified by:

getCharacterSets in interface DataIdentification

setCharacterSets

public void setCharacterSets(Collection<? extends CharacterSet> newValues)

Sets the full name of the character coding standard used for the dataset.

Parameters:

newValues - The new character sets.

getTopicCategories

public Collection<TopicCategory> getTopicCategories()

Returns the main theme(s) of the dataset.

Specified by:

getTopicCategories in interface DataIdentification

setTopicCategories

public void setTopicCategories(Collection<? extends TopicCategory> newValues)

Sets the main theme(s) of the dataset.

Parameters:

newValues - The new topic categories.

getEnvironmentDescription

public InternationalString getEnvironmentDescription()

Returns a description of the dataset 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 DataIdentification

setEnvironmentDescription

public void setEnvironmentDescription(InternationalString newValue)

Sets the description of the dataset in the producer’s processing environment.

Parameters:

newValue - The new environment description.

getExtents

public Collection<Extent> getExtents()

Returns additional extent information including the bounding polygon, vertical, and temporal extent of the dataset.

Specified by:

getExtents in interface DataIdentification

setExtents

public void setExtents(Collection<? extends Extent> newValues)

Sets additional extent information.

Parameters:

newValues - The new extents

getSupplementalInformation

public InternationalString getSupplementalInformation()

Any other descriptive information about the dataset.

Specified by:

getSupplementalInformation in interface DataIdentification

setSupplementalInformation

public void setSupplementalInformation(InternationalString newValue)

Sets any other descriptive information about the dataset.

Parameters:

newValue - The new supplemental information.