public class TLcdOWSKeywords extends TLcdDataObject
Unordered list of one or more commonly used or formalised word(s) or phrase(s) used to describe the subject. When needed, the optional "type" can name the type of the associated list of keywords that shall all have the same type. Also when needed, the codeSpace attribute of that "type" can reference the type name authority and/or thesaurus.
If the xml:lang attribute is not included in a Keyword element, then no language is specified for that element unless specified by another means. All Keyword elements in the same Keywords element that share the same xml:lang attribute value represent different keywords in that language.
For OWS use, the optional thesaurusName element was omitted as being complex information that could be referenced by the codeSpace attribute of the Type element.
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
KEYWORD_PROPERTY
Data property that maps to the
Keyword element. |
static TLcdDataProperty |
TYPE_PROPERTY
Data property that maps to the
Type element. |
Constructor and Description |
---|
TLcdOWSKeywords()
Creates a new
TLcdOWSKeywords instance. |
TLcdOWSKeywords(TLcdDataType aType)
Creates a new
TLcdOWSKeywords instance with the given data type. |
Modifier and Type | Method and Description |
---|---|
void |
addKeyword(String aKeyword)
Adds a keyword.
|
List<TLcdOWSLanguageString> |
getKeyword()
Returns the value of the property that maps to the
Keyword element. |
String |
getKeyword(int aIndex)
Gets the keyword at a given position.
|
int |
getKeywordCount()
Gets the number of keywords.
|
TLcdOWSCode |
getType()
Gets the type.
|
void |
removeKeyword(int aIndex)
Removes the keyword at a given position.
|
void |
setType(ILcdGML3Code aType)
Deprecated.
use
setType(TLcdOWSCode) |
void |
setType(TLcdOWSCode aValue)
Sets the value of the property that maps to the
Type element. |
public static final TLcdDataProperty KEYWORD_PROPERTY
Keyword
element.
The possible values for this property are instances of List<TLcdOWSLanguageString>
.public static final TLcdDataProperty TYPE_PROPERTY
Type
element.
The possible values for this property are instances of TLcdOWSCode
.public TLcdOWSKeywords()
TLcdOWSKeywords
instance.public TLcdOWSKeywords(TLcdDataType aType)
TLcdOWSKeywords
instance with the given data type.aType
- The data type.public void addKeyword(String aKeyword)
aKeyword
- the keyword to be added.public int getKeywordCount()
public void removeKeyword(int aIndex)
aIndex
- the index of the given position.public String getKeyword(int aIndex)
aIndex
- the index of the given position.public TLcdOWSCode getType()
public void setType(ILcdGML3Code aType)
setType(TLcdOWSCode)
aType
- the type to be set.setType(TLcdOWSCode)
public List<TLcdOWSLanguageString> getKeyword()
Keyword
element.KEYWORD_PROPERTY
property.public void setType(TLcdOWSCode aValue)
Type
element.aValue
- the value to set for the TYPE_PROPERTY
property.