com.luciad.ogc.ows.model

LuciadLightspeedClass TLcdOWSKeywords

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.ows.model.TLcdOWSKeywords

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

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.

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
TLcdOWSKeywords() Creates a new TLcdOWSKeywords instance.
TLcdOWSKeywords(TLcdDataType aType) Creates a new TLcdOWSKeywords instance with the given data type.

Method Summary

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.

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEYWORD_PROPERTY

public static final TLcdDataProperty KEYWORD_PROPERTY

Data property that maps to the Keyword element. The possible values for this property are instances of List<TLcdOWSLanguageString>.

TYPE_PROPERTY

public static final TLcdDataProperty TYPE_PROPERTY

Data property that maps to the Type element. The possible values for this property are instances of TLcdOWSCode.

Constructor Detail

TLcdOWSKeywords

public TLcdOWSKeywords()

Creates a new TLcdOWSKeywords instance.

TLcdOWSKeywords

public TLcdOWSKeywords(TLcdDataType aType)

Creates a new TLcdOWSKeywords instance with the given data type.

Parameters:

aType - The data type.

Method Detail

addKeyword

public void addKeyword(String aKeyword)

Adds a keyword.

Parameters:

aKeyword - the keyword to be added.

getKeywordCount

public int getKeywordCount()

Gets the number of keywords.

Returns:

the number of keywords.

removeKeyword

public void removeKeyword(int aIndex)

Removes the keyword at a given position.

Parameters:

aIndex - the index of the given position.

getKeyword

public String getKeyword(int aIndex)

Gets the keyword at a given position.

Parameters:

aIndex - the index of the given position.

Returns:

the keyword at the given position.

getType

public TLcdOWSCode getType()

Gets the type.

Returns:

the type.

setType

public void setType(ILcdGML3Code aType)

Deprecated. use setType(TLcdOWSCode)

Sets the type.

Parameters:

aType - the type to be set.

See Also:

setType(TLcdOWSCode)

getKeyword

public List<TLcdOWSLanguageString> getKeyword()

Returns the value of the property that maps to the Keyword element.

Returns:

the value of the KEYWORD_PROPERTY property.

setType

public void setType(TLcdOWSCode aValue)

Sets the value of the property that maps to the Type element.

Parameters:

aValue - the value to set for the TYPE_PROPERTY property.