Module org.apache.sis.metadata
Class DefaultKeywords
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultKeywords
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,Keywords
Keywords, their type and reference source.
The following property is mandatory in a well-formed metadata according ISO 19115:
MD_Keywords
└─keyword…… Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty keywords.DefaultKeywords(CharSequence... keywords) Creates keywords initialized to the given key word.DefaultKeywords(Keywords object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultKeywordscastOrCopy(Keywords object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the user-defined categorization of groups of keywords that extend or are orthogonal to the standardized keyword type codes.Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.getType()Returns the subject matter used to group similar keywords.voidsetKeywordClass(DefaultKeywordClass newValue) Sets the user-defined categorization of groups of keywords.voidsetKeywords(Collection<? extends InternationalString> newValues) Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.voidsetThesaurusName(Citation newValue) Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.voidsetType(KeywordType newValue) Sets the subject matter used to group similar keywords.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultKeywords
public DefaultKeywords()Constructs an initially empty keywords. -
DefaultKeywords
Creates keywords initialized to the given key word.- Parameters:
keywords- commonly used words or formalised words or phrases used to describe the subject, ornullif none.
-
DefaultKeywords
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultKeywords, then it is returned unchanged. - Otherwise a new
DefaultKeywordsinstance 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getKeywords
Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.- Specified by:
getKeywordsin interfaceKeywords- Returns:
- word(s) or phrase(s) used to describe the subject.
-
setKeywords
Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.- Parameters:
newValues- the new keywords.
-
getType
Returns the subject matter used to group similar keywords. -
setType
Sets the subject matter used to group similar keywords.- Parameters:
newValue- the new keyword type.
-
getThesaurusName
Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.- Specified by:
getThesaurusNamein interfaceKeywords- Returns:
- name of registered thesaurus or similar authoritative source of keywords, or
null.
-
setThesaurusName
Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.- Parameters:
newValue- the new thesaurus name.
-
getKeywordClass
@UML(identifier="keywordClass", obligation=OPTIONAL, specification=ISO_19115) public DefaultKeywordClass getKeywordClass()Returns the user-defined categorization of groups of keywords that extend or are orthogonal to the standardized keyword type codes.Upcoming API change — generalization
The element type will be changed to theKeywordClassinterface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Returns:
- user-defined categorization of groups of keywords, or
nullif none. - Since:
- 0.5
-
setKeywordClass
Sets the user-defined categorization of groups of keywords.Upcoming API change — generalization
The argument type will be changed to theKeywordClassinterface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Parameters:
newValue- new user-defined categorization of groups of keywords.- Since:
- 0.5
-