org.opennms.netmgt.config.filter
Class Table

java.lang.Object
  org.opennms.netmgt.config.filter.Table

All Implemented Interfaces:

Serializable

public class Table
extends Object
implements Serializable

Class Table.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Table()

Method Summary

void	addColumn(Column vColumn)
void	addColumn(int index, Column vColumn)
void	addJoin(int index, Join vJoin)
void	addJoin(Join vJoin)
Enumeration<Column>	enumerateColumn() Method enumerateColumn.
Enumeration<Join>	enumerateJoin() Method enumerateJoin.
Column[]	getColumn() Method getColumn.Returns the contents of the collection in an Array.
Column	getColumn(int index) Method getColumn.
List<Column>	getColumnCollection() Method getColumnCollection.Returns a reference to '_columnList'.
int	getColumnCount() Method getColumnCount.
Join[]	getJoin() Method getJoin.Returns the contents of the collection in an Array.
Join	getJoin(int index) Method getJoin.
List<Join>	getJoinCollection() Method getJoinCollection.Returns a reference to '_joinList'.
int	getJoinCount() Method getJoinCount.
String	getKey() Returns the value of field 'key'.
String	getName() Returns the value of field 'name'.
String	getVisible() Returns the value of field 'visible'.
boolean	isValid() Method isValid.
Iterator<Column>	iterateColumn() Method iterateColumn.
Iterator<Join>	iterateJoin() Method iterateJoin.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllColumn()
void	removeAllJoin()
boolean	removeColumn(Column vColumn) Method removeColumn.
Column	removeColumnAt(int index) Method removeColumnAt.
boolean	removeJoin(Join vJoin) Method removeJoin.
Join	removeJoinAt(int index) Method removeJoinAt.
void	setColumn(Column[] vColumnArray)
void	setColumn(int index, Column vColumn)
void	setColumn(List<Column> vColumnList) Sets the value of '_columnList' by copying the given Vector.
void	setColumnCollection(List<Column> columnList) Deprecated.
void	setJoin(int index, Join vJoin)
void	setJoin(Join[] vJoinArray)
void	setJoin(List<Join> vJoinList) Sets the value of '_joinList' by copying the given Vector.
void	setJoinCollection(List<Join> joinList) Deprecated.
void	setKey(String key) Sets the value of field 'key'.
void	setName(String name) Sets the value of field 'name'.
void	setVisible(String visible) Sets the value of field 'visible'.
static Table	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

Table

public Table()

Method Detail

addColumn

public void addColumn(Column vColumn)
               throws IndexOutOfBoundsException

Parameters:

vColumn -

Throws:

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

addColumn

public void addColumn(int index,
                      Column vColumn)
               throws IndexOutOfBoundsException

Parameters:

index -

vColumn -

Throws:

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

addJoin

public void addJoin(Join vJoin)
             throws IndexOutOfBoundsException

Parameters:

vJoin -

Throws:

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

addJoin

public void addJoin(int index,
                    Join vJoin)
             throws IndexOutOfBoundsException

Parameters:

index -

vJoin -

Throws:

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

enumerateColumn

public Enumeration<Column> enumerateColumn()

Method enumerateColumn.

Returns:

an Enumeration over all possible elements of this collection

enumerateJoin

public Enumeration<Join> enumerateJoin()

Method enumerateJoin.

Returns:

an Enumeration over all possible elements of this collection

getColumn

public Column getColumn(int index)
                 throws IndexOutOfBoundsException

Method getColumn.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.filter.Column at the given index

Throws:

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

getColumn

public Column[] getColumn()

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

getColumnCollection

public List<Column> getColumnCollection()

Method getColumnCollection.Returns a reference to '_columnList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getColumnCount

public int getColumnCount()

Method getColumnCount.

Returns:

the size of this collection

getJoin

public Join getJoin(int index)
             throws IndexOutOfBoundsException

Method getJoin.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.filter.Join at the given index

Throws:

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

getJoin

public Join[] getJoin()

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

getJoinCollection

public List<Join> getJoinCollection()

Method getJoinCollection.Returns a reference to '_joinList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getJoinCount

public int getJoinCount()

Method getJoinCount.

Returns:

the size of this collection

getKey

public String getKey()

Returns the value of field 'key'.

Returns:

the value of field 'Key'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getVisible

public String getVisible()

Returns the value of field 'visible'.

Returns:

the value of field 'Visible'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateColumn

public Iterator<Column> iterateColumn()

Method iterateColumn.

Returns:

an Iterator over all possible elements in this collection

iterateJoin

public Iterator<Join> iterateJoin()

Method iterateJoin.

Returns:

an Iterator over all possible elements in this collection

marshal

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

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

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

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllColumn

public void removeAllColumn()

removeAllJoin

public void removeAllJoin()

removeColumn

public boolean removeColumn(Column vColumn)

Method removeColumn.

Parameters:

vColumn -

Returns:

true if the object was removed from the collection.

removeColumnAt

public Column removeColumnAt(int index)

Method removeColumnAt.

Parameters:

index -

Returns:

the element removed from the collection

removeJoin

public boolean removeJoin(Join vJoin)

Method removeJoin.

Parameters:

vJoin -

Returns:

true if the object was removed from the collection.

removeJoinAt

public Join removeJoinAt(int index)

Method removeJoinAt.

Parameters:

index -

Returns:

the element removed from the collection

setColumn

public void setColumn(int index,
                      Column vColumn)
               throws IndexOutOfBoundsException

Parameters:

index -

vColumn -

Throws:

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

setColumn

public void setColumn(Column[] vColumnArray)

Parameters:

vColumnArray -

setColumn

public void setColumn(List<Column> vColumnList)

Sets the value of '_columnList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vColumnList - the Vector to copy.

setColumnCollection

public void setColumnCollection(List<Column> columnList)

Deprecated.

Sets the value of '_columnList' by setting it to the given Vector. No type checking is performed.

Parameters:

columnList - the Vector to set.

setJoin

public void setJoin(int index,
                    Join vJoin)
             throws IndexOutOfBoundsException

Parameters:

index -

vJoin -

Throws:

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

setJoin

public void setJoin(Join[] vJoinArray)

Parameters:

vJoinArray -

setJoin

public void setJoin(List<Join> vJoinList)

Sets the value of '_joinList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vJoinList - the Vector to copy.

setJoinCollection

public void setJoinCollection(List<Join> joinList)

Deprecated.

Sets the value of '_joinList' by setting it to the given Vector. No type checking is performed.

Parameters:

joinList - the Vector to set.

setKey

public void setKey(String key)

Sets the value of field 'key'.

Parameters:

key - the value of field 'key'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setVisible

public void setVisible(String visible)

Sets the value of field 'visible'.

Parameters:

visible - the value of field 'visible'.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.filter.Tabl

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

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

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema