org.castor.cpa.test.framework.xml
Class CpactfConf

java.lang.Object
  org.castor.cpa.test.framework.xml.CpactfConf

All Implemented Interfaces:

Serializable

public class CpactfConf
extends Object
implements Serializable

Class CpactfConf.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

CpactfConf()

Method Summary

void	addDatabase(Database vDatabase)
void	addDatabase(int index, Database vDatabase)
void	addTransaction(int index, Transaction vTransaction)
void	addTransaction(Transaction vTransaction)
Enumeration<? extends Database>	enumerateDatabase() Method enumerateDatabase.
Enumeration<? extends Transaction>	enumerateTransaction() Method enumerateTransaction.
Database[]	getDatabase() Method getDatabase.Returns the contents of the collection in an Array.
Database	getDatabase(int index) Method getDatabase.
int	getDatabaseCount() Method getDatabaseCount.
String	getDefaultDatabase() Returns the value of field 'defaultDatabase'.
String	getDefaultTransaction() Returns the value of field 'defaultTransaction'.
Transaction[]	getTransaction() Method getTransaction.Returns the contents of the collection in an Array.
Transaction	getTransaction(int index) Method getTransaction.
int	getTransactionCount() Method getTransactionCount.
boolean	isValid() Method isValid.
Iterator<? extends Database>	iterateDatabase() Method iterateDatabase.
Iterator<? extends Transaction>	iterateTransaction() Method iterateTransaction.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDatabase()
void	removeAllTransaction()
boolean	removeDatabase(Database vDatabase) Method removeDatabase.
Database	removeDatabaseAt(int index) Method removeDatabaseAt.
boolean	removeTransaction(Transaction vTransaction) Method removeTransaction.
Transaction	removeTransactionAt(int index) Method removeTransactionAt.
void	setDatabase(Database[] vDatabaseArray)
void	setDatabase(int index, Database vDatabase)
void	setDefaultDatabase(String defaultDatabase) Sets the value of field 'defaultDatabase'.
void	setDefaultTransaction(String defaultTransaction) Sets the value of field 'defaultTransaction'.
void	setTransaction(int index, Transaction vTransaction)
void	setTransaction(Transaction[] vTransactionArray)
static CpactfConf	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

CpactfConf

public CpactfConf()

Method Detail

addDatabase

public void addDatabase(Database vDatabase)
                 throws IndexOutOfBoundsException

Parameters:

vDatabase -

Throws:

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

addDatabase

public void addDatabase(int index,
                        Database vDatabase)
                 throws IndexOutOfBoundsException

Parameters:

index -

vDatabase -

Throws:

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

addTransaction

public void addTransaction(Transaction vTransaction)
                    throws IndexOutOfBoundsException

Parameters:

vTransaction -

Throws:

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

addTransaction

public void addTransaction(int index,
                           Transaction vTransaction)
                    throws IndexOutOfBoundsException

Parameters:

index -

vTransaction -

Throws:

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

enumerateDatabase

public Enumeration<? extends Database> enumerateDatabase()

Method enumerateDatabase.

Returns:

an Enumeration over all possible elements of this collection

enumerateTransaction

public Enumeration<? extends Transaction> enumerateTransaction()

Method enumerateTransaction.

Returns:

an Enumeration over all possible elements of this collection

getDatabase

public Database getDatabase(int index)
                     throws IndexOutOfBoundsException

Method getDatabase.

Parameters:

index -

Returns:

the value of the org.castor.cpa.test.framework.xml.Database at the given index

Throws:

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

getDatabase

public Database[] getDatabase()

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

getDatabaseCount

public int getDatabaseCount()

Method getDatabaseCount.

Returns:

the size of this collection

getDefaultDatabase

public String getDefaultDatabase()

Returns the value of field 'defaultDatabase'.

Returns:

the value of field 'DefaultDatabase'.

getDefaultTransaction

public String getDefaultTransaction()

Returns the value of field 'defaultTransaction'.

Returns:

the value of field 'DefaultTransaction'.

getTransaction

public Transaction getTransaction(int index)
                           throws IndexOutOfBoundsException

Method getTransaction.

Parameters:

index -

Returns:

the value of the org.castor.cpa.test.framework.xml.Transaction at the given index

Throws:

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

getTransaction

public Transaction[] getTransaction()

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

getTransactionCount

public int getTransactionCount()

Method getTransactionCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateDatabase

public Iterator<? extends Database> iterateDatabase()

Method iterateDatabase.

Returns:

an Iterator over all possible elements in this collection

iterateTransaction

public Iterator<? extends Transaction> iterateTransaction()

Method iterateTransaction.

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

removeAllDatabase

public void removeAllDatabase()

removeAllTransaction

public void removeAllTransaction()

removeDatabase

public boolean removeDatabase(Database vDatabase)

Method removeDatabase.

Parameters:

vDatabase -

Returns:

true if the object was removed from the collection.

removeDatabaseAt

public Database removeDatabaseAt(int index)

Method removeDatabaseAt.

Parameters:

index -

Returns:

the element removed from the collection

removeTransaction

public boolean removeTransaction(Transaction vTransaction)

Method removeTransaction.

Parameters:

vTransaction -

Returns:

true if the object was removed from the collection.

removeTransactionAt

public Transaction removeTransactionAt(int index)

Method removeTransactionAt.

Parameters:

index -

Returns:

the element removed from the collection

setDatabase

public void setDatabase(int index,
                        Database vDatabase)
                 throws IndexOutOfBoundsException

Parameters:

index -

vDatabase -

Throws:

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

setDatabase

public void setDatabase(Database[] vDatabaseArray)

Parameters:

vDatabaseArray -

setDefaultDatabase

public void setDefaultDatabase(String defaultDatabase)

Sets the value of field 'defaultDatabase'.

Parameters:

defaultDatabase - the value of field 'defaultDatabase'.

setDefaultTransaction

public void setDefaultTransaction(String defaultTransaction)

Sets the value of field 'defaultTransaction'.

Parameters:

defaultTransaction - the value of field 'defaultTransaction'.

setTransaction

public void setTransaction(int index,
                           Transaction vTransaction)
                    throws IndexOutOfBoundsException

Parameters:

index -

vTransaction -

Throws:

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

setTransaction

public void setTransaction(Transaction[] vTransactionArray)

Parameters:

vTransactionArray -

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.castor.cpa.test.framework.xml.CpactfConf

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