org.opennms.netmgt.config.filter
Class Column

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

All Implemented Interfaces:

Serializable

public class Column
extends Object
implements Serializable

Class Column.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Column()

Method Summary

void	addAlias(Alias vAlias)
void	addAlias(int index, Alias vAlias)
void	addConstraint(Constraint vConstraint)
void	addConstraint(int index, Constraint vConstraint)
Enumeration<Alias>	enumerateAlias() Method enumerateAlias.
Enumeration<Constraint>	enumerateConstraint() Method enumerateConstraint.
Alias[]	getAlias() Method getAlias.Returns the contents of the collection in an Array.
Alias	getAlias(int index) Method getAlias.
List<Alias>	getAliasCollection() Method getAliasCollection.Returns a reference to '_aliasList'.
int	getAliasCount() Method getAliasCount.
Constraint[]	getConstraint() Method getConstraint.Returns the contents of the collection in an Array.
Constraint	getConstraint(int index) Method getConstraint.
List<Constraint>	getConstraintCollection() Method getConstraintCollection.Returns a reference to '_constraintList'.
int	getConstraintCount() Method getConstraintCount.
String	getJavaType() Returns the value of field 'javaType'.
String	getName() Returns the value of field 'name'.
String	getSqlType() Returns the value of field 'sqlType'.
String	getVisible() Returns the value of field 'visible'.
boolean	isValid() Method isValid.
Iterator<Alias>	iterateAlias() Method iterateAlias.
Iterator<Constraint>	iterateConstraint() Method iterateConstraint.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
boolean	removeAlias(Alias vAlias) Method removeAlias.
Alias	removeAliasAt(int index) Method removeAliasAt.
void	removeAllAlias()
void	removeAllConstraint()
boolean	removeConstraint(Constraint vConstraint) Method removeConstraint.
Constraint	removeConstraintAt(int index) Method removeConstraintAt.
void	setAlias(Alias[] vAliasArray)
void	setAlias(int index, Alias vAlias)
void	setAlias(List<Alias> vAliasList) Sets the value of '_aliasList' by copying the given Vector.
void	setAliasCollection(List<Alias> aliasList) Deprecated.
void	setConstraint(Constraint[] vConstraintArray)
void	setConstraint(int index, Constraint vConstraint)
void	setConstraint(List<Constraint> vConstraintList) Sets the value of '_constraintList' by copying the given Vector.
void	setConstraintCollection(List<Constraint> constraintList) Deprecated.
void	setJavaType(String javaType) Sets the value of field 'javaType'.
void	setName(String name) Sets the value of field 'name'.
void	setSqlType(String sqlType) Sets the value of field 'sqlType'.
void	setVisible(String visible) Sets the value of field 'visible'.
static Column	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

Column

public Column()

Method Detail

addAlias

public void addAlias(Alias vAlias)
              throws IndexOutOfBoundsException

Parameters:

vAlias -

Throws:

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

addAlias

public void addAlias(int index,
                     Alias vAlias)
              throws IndexOutOfBoundsException

Parameters:

index -

vAlias -

Throws:

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

addConstraint

public void addConstraint(Constraint vConstraint)
                   throws IndexOutOfBoundsException

Parameters:

vConstraint -

Throws:

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

addConstraint

public void addConstraint(int index,
                          Constraint vConstraint)
                   throws IndexOutOfBoundsException

Parameters:

index -

vConstraint -

Throws:

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

enumerateAlias

public Enumeration<Alias> enumerateAlias()

Method enumerateAlias.

Returns:

an Enumeration over all possible elements of this collection

enumerateConstraint

public Enumeration<Constraint> enumerateConstraint()

Method enumerateConstraint.

Returns:

an Enumeration over all possible elements of this collection

getAlias

public Alias getAlias(int index)
               throws IndexOutOfBoundsException

Method getAlias.

Parameters:

index -

Returns:

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

Throws:

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

getAlias

public Alias[] getAlias()

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

getAliasCollection

public List<Alias> getAliasCollection()

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

Returns:

a reference to the Vector backing this class

getAliasCount

public int getAliasCount()

Method getAliasCount.

Returns:

the size of this collection

getConstraint

public Constraint getConstraint(int index)
                         throws IndexOutOfBoundsException

Method getConstraint.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.filter.Constraint at the given inde

Throws:

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

getConstraint

public Constraint[] getConstraint()

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

getConstraintCollection

public List<Constraint> getConstraintCollection()

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

Returns:

a reference to the Vector backing this class

getConstraintCount

public int getConstraintCount()

Method getConstraintCount.

Returns:

the size of this collection

getJavaType

public String getJavaType()

Returns the value of field 'javaType'.

Returns:

the value of field 'JavaType'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getSqlType

public String getSqlType()

Returns the value of field 'sqlType'.

Returns:

the value of field 'SqlType'.

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

iterateAlias

public Iterator<Alias> iterateAlias()

Method iterateAlias.

Returns:

an Iterator over all possible elements in this collection

iterateConstraint

public Iterator<Constraint> iterateConstraint()

Method iterateConstraint.

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

removeAlias

public boolean removeAlias(Alias vAlias)

Method removeAlias.

Parameters:

vAlias -

Returns:

true if the object was removed from the collection.

removeAliasAt

public Alias removeAliasAt(int index)

Method removeAliasAt.

Parameters:

index -

Returns:

the element removed from the collection

removeAllAlias

public void removeAllAlias()

removeAllConstraint

public void removeAllConstraint()

removeConstraint

public boolean removeConstraint(Constraint vConstraint)

Method removeConstraint.

Parameters:

vConstraint -

Returns:

true if the object was removed from the collection.

removeConstraintAt

public Constraint removeConstraintAt(int index)

Method removeConstraintAt.

Parameters:

index -

Returns:

the element removed from the collection

setAlias

public void setAlias(int index,
                     Alias vAlias)
              throws IndexOutOfBoundsException

Parameters:

index -

vAlias -

Throws:

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

setAlias

public void setAlias(Alias[] vAliasArray)

Parameters:

vAliasArray -

setAlias

public void setAlias(List<Alias> vAliasList)

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

Parameters:

vAliasList - the Vector to copy.

setAliasCollection

public void setAliasCollection(List<Alias> aliasList)

Deprecated.

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

Parameters:

aliasList - the Vector to set.

setConstraint

public void setConstraint(int index,
                          Constraint vConstraint)
                   throws IndexOutOfBoundsException

Parameters:

index -

vConstraint -

Throws:

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

setConstraint

public void setConstraint(Constraint[] vConstraintArray)

Parameters:

vConstraintArray -

setConstraint

public void setConstraint(List<Constraint> vConstraintList)

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

Parameters:

vConstraintList - the Vector to copy.

setConstraintCollection

public void setConstraintCollection(List<Constraint> constraintList)

Deprecated.

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

Parameters:

constraintList - the Vector to set.

setJavaType

public void setJavaType(String javaType)

Sets the value of field 'javaType'.

Parameters:

javaType - the value of field 'javaType'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setSqlType

public void setSqlType(String sqlType)

Sets the value of field 'sqlType'.

Parameters:

sqlType - the value of field 'sqlType'.

setVisible

public void setVisible(String visible)

Sets the value of field 'visible'.

Parameters:

visible - the value of field 'visible'.

unmarshal

public static Column 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.Column

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