org.exolab.castor.xml.schema.annotations.jdo
Class PkType

java.lang.Object
  org.exolab.castor.xml.schema.annotations.jdo.PkType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PrimaryKey

public class PkType
extends Object
implements Serializable

Class PkType.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

PkType()

Method Summary

void	addKey(int index, String vKey)
void	addKey(String vKey)
Enumeration<? extends String>	enumerateKey() Method enumerateKey.
String[]	getKey() Method getKey.Returns the contents of the collection in an Array.
String	getKey(int index) Method getKey.
int	getKeyCount() Method getKeyCount.
boolean	isValid() Method isValid.
Iterator<? extends String>	iterateKey() Method iterateKey.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllKey()
boolean	removeKey(String vKey) Method removeKey.
String	removeKeyAt(int index) Method removeKeyAt.
void	setKey(int index, String vKey)
void	setKey(String[] vKeyArray)
static PkType	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

PkType

public PkType()

Method Detail

addKey

public void addKey(String vKey)
            throws IndexOutOfBoundsException

Parameters:

vKey -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addKey

public void addKey(int index,
                   String vKey)
            throws IndexOutOfBoundsException

Parameters:

index -

vKey -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateKey

public Enumeration<? extends String> enumerateKey()

Method enumerateKey.

Returns:

an Enumeration over all possible elements of this collection

getKey

public String getKey(int index)
              throws IndexOutOfBoundsException

Method getKey.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getKey

public String[] getKey()

Method getKey.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getKeyCount

public int getKeyCount()

Method getKeyCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateKey

public Iterator<? extends String> iterateKey()

Method iterateKey.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws MarshalException,
                    ValidationException

Parameters:

out -

Throws:

MarshalException - if object is null or if any SAXException is thrown during marshaling

ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    MarshalException,
                    ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

ValidationException - if this object is an invalid instance according to the schema

MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllKey

public void removeAllKey()

removeKey

public boolean removeKey(String vKey)

Method removeKey.

Parameters:

vKey -

Returns:

true if the object was removed from the collection.

removeKeyAt

public String removeKeyAt(int index)

Method removeKeyAt.

Parameters:

index -

Returns:

the element removed from the collection

setKey

public void setKey(int index,
                   String vKey)
            throws IndexOutOfBoundsException

Parameters:

index -

vKey -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setKey

public void setKey(String[] vKeyArray)

Parameters:

vKeyArray -

unmarshal

public static PkType unmarshal(Reader reader)
                        throws MarshalException,
                               ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.exolab.castor.xml.schema.annotations.jdo.PkType

Throws:

MarshalException - if object is null or if any SAXException is thrown during marshaling

ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws ValidationException

Throws:

ValidationException - if this object is an invalid instance according to the schema