org.geotoolkit.metadata.iso.identification
Class DefaultKeywords

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultKeywords

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Keywords

@ThreadSafe
public class DefaultKeywords
extends MetadataEntity
implements Keywords

Keywords, their type and reference source.

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

DefaultKeywords()
Constructs an initially empty keywords.

DefaultKeywords(Collection<? extends InternationalString> keywords)
Creates keywords initialized to the given list.

DefaultKeywords(Keywords source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultKeywords	castOrCopy(Keywords object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<InternationalString>	getKeywords() Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
Citation	getThesaurusName() Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.
KeywordType	getType() Returns the subject matter used to group similar keywords.
void	setKeywords(Collection<? extends InternationalString> newValues) Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
void	setThesaurusName(Citation newValue) Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.
void	setType(KeywordType newValue) Sets the subject matter used to group similar keywords.

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

Constructor Detail

DefaultKeywords

public DefaultKeywords()

Constructs an initially empty keywords.

DefaultKeywords

public DefaultKeywords(Keywords 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

DefaultKeywords

public DefaultKeywords(Collection<? extends InternationalString> keywords)

Creates keywords initialized to the given list.

Parameters:

keywords - Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject, or null if none.

Method Detail

castOrCopy

public static DefaultKeywords castOrCopy(Keywords 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

getKeywords

public Collection<InternationalString> getKeywords()

Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.

Specified by:

getKeywords in interface Keywords

setKeywords

public void setKeywords(Collection<? extends InternationalString> newValues)

Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.

Parameters:

newValues - The new keywords.

getType

public KeywordType getType()

Returns the subject matter used to group similar keywords.

Specified by:

getType in interface Keywords

setType

public void setType(KeywordType newValue)

Sets the subject matter used to group similar keywords.

Parameters:

newValue - The new keyword type.

getThesaurusName

public Citation getThesaurusName()

Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.

Specified by:

getThesaurusName in interface Keywords

setThesaurusName

public void setThesaurusName(Citation newValue)

Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.

Parameters:

newValue - The new thesaurus name.