public class DefaultKeywords extends ISOMetadata implements Keywords
MD_Keywords
└─keyword……
Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.Limitations:
XML
instead.Defined in the sis-metadata
module
identifiers
Constructor and Description |
---|
DefaultKeywords()
Constructs 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.
|
Modifier and Type | Method and Description |
---|---|
static DefaultKeywords |
castOrCopy(Keywords object)
Returns a SIS metadata implementation with the values of the given arbitrary implementation.
|
CodeList<?> |
getKeywordClass()
Returns the user-defined categorization of groups of keywords that extend or
are orthogonal to the standardized keyword type codes.
|
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 |
setKeywordClass(CodeList<?> newValue)
Sets the user-defined categorization of groups of 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.
|
freeze, getIdentifierMap, getIdentifiers, getStandard
checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
public DefaultKeywords()
public DefaultKeywords(CharSequence... keywords)
keywords
- commonly used words or formalised words or phrases used to describe the subject,
or null
if none.public DefaultKeywords(Keywords object)
object
- the metadata to copy values from, or null
if none.castOrCopy(Keywords)
public static DefaultKeywords castOrCopy(Keywords object)
null
, then this method returns null
.DefaultKeywords
, then it is returned unchanged.DefaultKeywords
instance is created using the
copy constructor
and returned. Note that this is a shallow copy operation, since the other
metadata contained in the given object are not recursively copied.object
- the object to get as a SIS implementation, or null
if none.null
if the argument was null.public Collection<InternationalString> getKeywords()
getKeywords
in interface Keywords
public void setKeywords(Collection<? extends InternationalString> newValues)
newValues
- the new keywords.public KeywordType getType()
public void setType(KeywordType newValue)
newValue
- the new keyword type.public Citation getThesaurusName()
getThesaurusName
in interface Keywords
null
.public void setThesaurusName(Citation newValue)
newValue
- the new thesaurus name.@UML(identifier="keywordClass", obligation=OPTIONAL, specification=ISO_19115) public CodeList<?> getKeywordClass()
KeywordClass
code list
when GeoAPI will provide it (tentatively in GeoAPI 3.1).
null
if none.public void setKeywordClass(CodeList<?> newValue)
KeywordClass
code list when GeoAPI will provide it
(tentatively in GeoAPI 3.1). In the meantime, users can define their own code list class as below:
final class UnsupportedCodeList extends CodeList<UnsupportedCodeList> { private static final List<UnsupportedCodeList> VALUES = new ArrayList<UnsupportedCodeList>(); // Need to declare at least one code list element. public static final UnsupportedCodeList MY_CODE_LIST = new UnsupportedCodeList("MY_CODE_LIST"); private UnsupportedCodeList(String name) { super(name, VALUES); } public static UnsupportedCodeList valueOf(String code) { return valueOf(UnsupportedCodeList.class, code); } @Override public UnsupportedCodeList[] family() { synchronized (VALUES) { return VALUES.toArray(new UnsupportedCodeList[VALUES.size()]); } } }
newValue
- new user-defined categorization of groups of keywords.Copyright © 2010–2017 The Apache Software Foundation. All rights reserved.