nl.b3p.xml.ows.v100

Class KeywordsType

java.lang.Object

nl.b3p.xml.ows.v100.KeywordsType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Keywords

public class KeywordsType
extends Object
implements Serializable

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. 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.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeywordsType()

Method Summary

Modifier and Type	Method and Description
void	addKeyword(int index, String vKeyword) Method addKeyword
void	addKeyword(String vKeyword) Method addKeyword
void	clearKeyword() Method clearKeyword
Enumeration	enumerateKeyword() Method enumerateKeyword
String[]	getKeyword() Method getKeyword
String	getKeyword(int index) Method getKeyword
int	getKeywordCount() Method getKeywordCount
Type	getType() Returns the value of field 'type'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeKeyword(String vKeyword) Method removeKeyword
void	setKeyword(int index, String vKeyword) Method setKeyword
void	setKeyword(String[] keywordArray) Method setKeyword
void	setType(Type type) Sets the value of field 'type'.
static KeywordsType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordsType

public KeywordsType()

Method Detail

addKeyword

public void addKeyword(String vKeyword)
                throws IndexOutOfBoundsException

Method addKeyword

Parameters:

vKeyword -

Throws:

IndexOutOfBoundsException

addKeyword

public void addKeyword(int index,
                       String vKeyword)
                throws IndexOutOfBoundsException

Method addKeyword

Parameters:

index -

vKeyword -

Throws:

IndexOutOfBoundsException

clearKeyword

public void clearKeyword()

Method clearKeyword

enumerateKeyword

public Enumeration enumerateKeyword()

Method enumerateKeyword

Returns:

Enumeration

getKeyword

public String getKeyword(int index)
                  throws IndexOutOfBoundsException

Method getKeyword

Parameters:

index -

Returns:

String

Throws:

IndexOutOfBoundsException

getKeyword

public String[] getKeyword()

Method getKeyword

Returns:

String

getKeywordCount

public int getKeywordCount()

Method getKeywordCount

Returns:

int

getType

public Type getType()

Returns the value of field 'type'.

Returns:

Type

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeKeyword

public boolean removeKeyword(String vKeyword)

Method removeKeyword

Parameters:

vKeyword -

Returns:

boolean

setKeyword

public void setKeyword(int index,
                       String vKeyword)
                throws IndexOutOfBoundsException

Method setKeyword

Parameters:

index -

vKeyword -

Throws:

IndexOutOfBoundsException

setKeyword

public void setKeyword(String[] keywordArray)

Method setKeyword

Parameters:

keywordArray -

setType

public void setType(Type type)

Sets the value of field 'type'.

Parameters:

type - the value of field 'type'.

unmarshal

public static KeywordsType unmarshal(Reader reader)
                              throws org.exolab.castor.xml.MarshalException,
                                     org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

KeywordsType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException