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:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs 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 SummaryModifier 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 ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultKeywordspublic DefaultKeywords()Constructs an initially empty keywords.
- 
DefaultKeywordsCreates keywords initialized to the given key word.- Parameters:
- keywords- commonly used words or formalised words or phrases used to describe the subject, or- nullif none.
 
- 
DefaultKeywordsConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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, or- nullif 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 
- 
getKeywordsReturns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.- Specified by:
- getKeywordsin interface- Keywords
- Returns:
- word(s) or phrase(s) used to describe the subject.
 
- 
setKeywordsSets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.- Parameters:
- newValues- the new keywords.
 
- 
getTypeReturns the subject matter used to group similar keywords.
- 
setTypeSets the subject matter used to group similar keywords.- Parameters:
- newValue- the new keyword type.
 
- 
getThesaurusNameReturns the name of the formally registered thesaurus or a similar authoritative source of keywords.- Specified by:
- getThesaurusNamein interface- Keywords
- Returns:
- name of registered thesaurus or similar authoritative source of keywords, or null.
 
- 
setThesaurusNameSets 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
 
- 
setKeywordClassSets 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
 
 
-