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

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

All Implemented Interfaces:

java.io.Serializable

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

Class OperatorGroup.

See Also:

Serialized Form

Constructor Summary

OperatorGroup()

Method Summary

void	addOperatorGroupItem(int index, OperatorGroupItem vOperatorGroupItem)
void	addOperatorGroupItem(OperatorGroupItem vOperatorGroupItem)
java.util.Enumeration<? extends OperatorGroupItem>	enumerateOperatorGroupItem() Method enumerateOperatorGroupItem.
java.lang.String	getName() Returns the value of field 'name'.
OperatorGroupItem[]	getOperatorGroupItem() Method getOperatorGroupItem.Returns the contents of the collection in an Array.
OperatorGroupItem	getOperatorGroupItem(int index) Method getOperatorGroupItem.
int	getOperatorGroupItemCount() Method getOperatorGroupItemCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends OperatorGroupItem>	iterateOperatorGroupItem() Method iterateOperatorGroupItem.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllOperatorGroupItem()
boolean	removeOperatorGroupItem(OperatorGroupItem vOperatorGroupItem) Method removeOperatorGroupItem.
OperatorGroupItem	removeOperatorGroupItemAt(int index) Method removeOperatorGroupItemAt.
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setOperatorGroupItem(int index, OperatorGroupItem vOperatorGroupItem)
void	setOperatorGroupItem(OperatorGroupItem[] vOperatorGroupItemArray)
static OperatorGroup	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

OperatorGroup

public OperatorGroup()

Method Detail

addOperatorGroupItem

public void addOperatorGroupItem(OperatorGroupItem vOperatorGroupItem)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

vOperatorGroupItem -

Throws:

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

addOperatorGroupItem

public void addOperatorGroupItem(int index,
                                 OperatorGroupItem vOperatorGroupItem)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vOperatorGroupItem -

Throws:

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

enumerateOperatorGroupItem

public java.util.Enumeration<? extends OperatorGroupItem> enumerateOperatorGroupItem()

Method enumerateOperatorGroupItem.

Returns:

an Enumeration over all possible elements of this collection

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getOperatorGroupItem

public OperatorGroupItem getOperatorGroupItem(int index)
                                       throws java.lang.IndexOutOfBoundsException

Method getOperatorGroupItem.

Parameters:

index -

Returns:

the value of the uk.ac.essex.ia.opview.xml.OperatorGroupItem at the given inde

Throws:

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

getOperatorGroupItem

public OperatorGroupItem[] getOperatorGroupItem()

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

getOperatorGroupItemCount

public int getOperatorGroupItemCount()

Method getOperatorGroupItemCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateOperatorGroupItem

public java.util.Iterator<? extends OperatorGroupItem> iterateOperatorGroupItem()

Method iterateOperatorGroupItem.

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

removeAllOperatorGroupItem

public void removeAllOperatorGroupItem()

removeOperatorGroupItem

public boolean removeOperatorGroupItem(OperatorGroupItem vOperatorGroupItem)

Method removeOperatorGroupItem.

Parameters:

vOperatorGroupItem -

Returns:

true if the object was removed from the collection.

removeOperatorGroupItemAt

public OperatorGroupItem removeOperatorGroupItemAt(int index)

Method removeOperatorGroupItemAt.

Parameters:

index -

Returns:

the element removed from the collection

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setOperatorGroupItem

public void setOperatorGroupItem(int index,
                                 OperatorGroupItem vOperatorGroupItem)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vOperatorGroupItem -

Throws:

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

setOperatorGroupItem

public void setOperatorGroupItem(OperatorGroupItem[] vOperatorGroupItemArray)

Parameters:

vOperatorGroupItemArray -

unmarshal

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

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