org.sigpath.bioimport.reaction2
Class ModelCompartments

java.lang.Object
  org.sigpath.bioimport.reaction2.ModelCompartments

All Implemented Interfaces:

Serializable

public class ModelCompartments
extends Object
implements Serializable

Groups compartments of a model

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ModelCompartments()

Method Summary

void	addCompartment(Compartment vCompartment) Method addCompartment
void	addCompartment(int index, Compartment vCompartment) Method addCompartment
void	clearCompartment() Method clearCompartment
Enumeration	enumerateCompartment() Method enumerateCompartment
Compartment[]	getCompartment() Method getCompartment
Compartment	getCompartment(int index) Method getCompartment
int	getCompartmentCount() Method getCompartmentCount
String	getDescription() Returns the value of field 'description'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeCompartment(Compartment vCompartment) Method removeCompartment
void	setCompartment(Compartment[] compartmentArray) Method setCompartment
void	setCompartment(int index, Compartment vCompartment) Method setCompartment
void	setDescription(String description) Sets the value of field 'description'.
static ModelCompartments	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelCompartments

public ModelCompartments()

Method Detail

addCompartment

public void addCompartment(Compartment vCompartment)
                    throws IndexOutOfBoundsException

Method addCompartment

Parameters:

vCompartment -

Throws:

IndexOutOfBoundsException

addCompartment

public void addCompartment(int index,
                           Compartment vCompartment)
                    throws IndexOutOfBoundsException

Method addCompartment

Parameters:

index -

vCompartment -

Throws:

IndexOutOfBoundsException

clearCompartment

public void clearCompartment()

Method clearCompartment

enumerateCompartment

public Enumeration enumerateCompartment()

Method enumerateCompartment

Returns:

Enumeration

getCompartment

public Compartment getCompartment(int index)
                           throws IndexOutOfBoundsException

Method getCompartment

Parameters:

index -

Returns:

Compartment

Throws:

IndexOutOfBoundsException

getCompartment

public Compartment[] getCompartment()

Method getCompartment

Returns:

Compartment

getCompartmentCount

public int getCompartmentCount()

Method getCompartmentCount

Returns:

int

getDescription

public String getDescription()

Returns the value of field 'description'. The field 'description' has the following description: Allows you to attach a description to a reaction, molecule, compartment, model or review

Returns:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws MarshalException,
                    ValidationException

Method marshal

Parameters:

out -

Throws:

MarshalException

ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    MarshalException,
                    ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

MarshalException

ValidationException

removeCompartment

public boolean removeCompartment(Compartment vCompartment)

Method removeCompartment

Parameters:

vCompartment -

Returns:

boolean

setCompartment

public void setCompartment(int index,
                           Compartment vCompartment)
                    throws IndexOutOfBoundsException

Method setCompartment

Parameters:

index -

vCompartment -

Throws:

IndexOutOfBoundsException

setCompartment

public void setCompartment(Compartment[] compartmentArray)

Method setCompartment

Parameters:

compartmentArray -

setDescription

public void setDescription(String description)

Sets the value of field 'description'. The field 'description' has the following description: Allows you to attach a description to a reaction, molecule, compartment, model or review

Parameters:

description - the value of field 'description'.

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

ModelCompartments

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Method validate

Throws:

ValidationException