uk.ac.essex.ia.opview.xml
Class Operators

java.lang.Object
  uk.ac.essex.ia.opview.xml.Operators

All Implemented Interfaces:

java.io.Serializable

public class Operators
extends java.lang.Object
implements java.io.Serializable

Class Operators.

See Also:

Serialized Form

Constructor Summary

Operators()

Method Summary

void	addOperatorGroup(int index, OperatorGroup vOperatorGroup)
void	addOperatorGroup(OperatorGroup vOperatorGroup)
java.util.Enumeration<? extends OperatorGroup>	enumerateOperatorGroup() Method enumerateOperatorGroup.
OperatorGroup[]	getOperatorGroup() Method getOperatorGroup.Returns the contents of the collection in an Array.
OperatorGroup	getOperatorGroup(int index) Method getOperatorGroup.
int	getOperatorGroupCount() Method getOperatorGroupCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends OperatorGroup>	iterateOperatorGroup() Method iterateOperatorGroup.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllOperatorGroup()
boolean	removeOperatorGroup(OperatorGroup vOperatorGroup) Method removeOperatorGroup.
OperatorGroup	removeOperatorGroupAt(int index) Method removeOperatorGroupAt.
void	setOperatorGroup(int index, OperatorGroup vOperatorGroup)
void	setOperatorGroup(OperatorGroup[] vOperatorGroupArray)
static Operators	unmarshal(java.io.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

Operators

public Operators()

Method Detail

addOperatorGroup

public void addOperatorGroup(OperatorGroup vOperatorGroup)
                      throws java.lang.IndexOutOfBoundsException

Parameters:

vOperatorGroup -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addOperatorGroup

public void addOperatorGroup(int index,
                             OperatorGroup vOperatorGroup)
                      throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vOperatorGroup -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateOperatorGroup

public java.util.Enumeration<? extends OperatorGroup> enumerateOperatorGroup()

Method enumerateOperatorGroup.

Returns:

an Enumeration over all possible elements of this collection

getOperatorGroup

public OperatorGroup getOperatorGroup(int index)
                               throws java.lang.IndexOutOfBoundsException

Method getOperatorGroup.

Parameters:

index -

Returns:

the value of the uk.ac.essex.ia.opview.xml.OperatorGroup at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getOperatorGroup

public OperatorGroup[] getOperatorGroup()

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

getOperatorGroupCount

public int getOperatorGroupCount()

Method getOperatorGroupCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateOperatorGroup

public java.util.Iterator<? extends OperatorGroup> iterateOperatorGroup()

Method iterateOperatorGroup.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

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

removeAllOperatorGroup

public void removeAllOperatorGroup()

removeOperatorGroup

public boolean removeOperatorGroup(OperatorGroup vOperatorGroup)

Method removeOperatorGroup.

Parameters:

vOperatorGroup -

Returns:

true if the object was removed from the collection.

removeOperatorGroupAt

public OperatorGroup removeOperatorGroupAt(int index)

Method removeOperatorGroupAt.

Parameters:

index -

Returns:

the element removed from the collection

setOperatorGroup

public void setOperatorGroup(int index,
                             OperatorGroup vOperatorGroup)
                      throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vOperatorGroup -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setOperatorGroup

public void setOperatorGroup(OperatorGroup[] vOperatorGroupArray)

Parameters:

vOperatorGroupArray -

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled uk.ac.essex.ia.opview.xml.Operators

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