org.sigpath.bioimport.reaction2
Class Compartment

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

All Implemented Interfaces:

Serializable

public class Compartment
extends Object
implements Serializable

Class Compartment.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Compartment()

Method Summary

void	addInContactWith(InContactWith vInContactWith) Method addInContactWith
void	addInContactWith(int index, InContactWith vInContactWith) Method addInContactWith
void	clearInContactWith() Method clearInContactWith
void	deleteValue() Method deleteValue
Enumeration	enumerateInContactWith() Method enumerateInContactWith
String	getDescription() Returns the value of field 'description'.
String	getId() Returns the value of field 'id'.
InContactWith[]	getInContactWith() Method getInContactWith
InContactWith	getInContactWith(int index) Method getInContactWith
int	getInContactWithCount() Method getInContactWithCount
String	getName() Returns the value of field 'name'.
Object	getOutside() Returns the value of field 'outside'.
UnitType	getUnit() Returns the value of field 'unit'.
double	getValue() Returns the value of field 'value'.
boolean	hasValue() Method hasValue
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeInContactWith(InContactWith vInContactWith) Method removeInContactWith
void	setDescription(String description) Sets the value of field 'description'.
void	setId(String id) Sets the value of field 'id'.
void	setInContactWith(InContactWith[] inContactWithArray) Method setInContactWith
void	setInContactWith(int index, InContactWith vInContactWith) Method setInContactWith
void	setName(String name) Sets the value of field 'name'.
void	setOutside(Object outside) Sets the value of field 'outside'.
void	setUnit(UnitType unit) Sets the value of field 'unit'.
void	setValue(double value) Sets the value of field 'value'.
static Compartment	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

Compartment

public Compartment()

Method Detail

addInContactWith

public void addInContactWith(InContactWith vInContactWith)
                      throws IndexOutOfBoundsException

Method addInContactWith

Parameters:

vInContactWith -

Throws:

IndexOutOfBoundsException

addInContactWith

public void addInContactWith(int index,
                             InContactWith vInContactWith)
                      throws IndexOutOfBoundsException

Method addInContactWith

Parameters:

index -

vInContactWith -

Throws:

IndexOutOfBoundsException

clearInContactWith

public void clearInContactWith()

Method clearInContactWith

deleteValue

public void deleteValue()

Method deleteValue

enumerateInContactWith

public Enumeration enumerateInContactWith()

Method enumerateInContactWith

Returns:

Enumeration

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

getId

public String getId()

Returns the value of field 'id'.

Returns:

String

getInContactWith

public InContactWith getInContactWith(int index)
                               throws IndexOutOfBoundsException

Method getInContactWith

Parameters:

index -

Returns:

InContactWith

Throws:

IndexOutOfBoundsException

getInContactWith

public InContactWith[] getInContactWith()

Method getInContactWith

Returns:

InContactWith

getInContactWithCount

public int getInContactWithCount()

Method getInContactWithCount

Returns:

int

getName

public String getName()

Returns the value of field 'name'.

Returns:

String

getOutside

public Object getOutside()

Returns the value of field 'outside'.

Returns:

Object

getUnit

public UnitType getUnit()

Returns the value of field 'unit'. The field 'unit' has the following description: Selects units for the reaction parameter

Returns:

UnitType

getValue

public double getValue()

Returns the value of field 'value'. The field 'value' has the following description: Defines the value of a reaction parameter

Returns:

double

hasValue

public boolean hasValue()

Method hasValue

Returns:

boolean

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

removeInContactWith

public boolean removeInContactWith(InContactWith vInContactWith)

Method removeInContactWith

Parameters:

vInContactWith -

Returns:

boolean

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'.

setId

public void setId(String id)

Sets the value of field 'id'.

Parameters:

id - the value of field 'id'.

setInContactWith

public void setInContactWith(int index,
                             InContactWith vInContactWith)
                      throws IndexOutOfBoundsException

Method setInContactWith

Parameters:

index -

vInContactWith -

Throws:

IndexOutOfBoundsException

setInContactWith

public void setInContactWith(InContactWith[] inContactWithArray)

Method setInContactWith

Parameters:

inContactWithArray -

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setOutside

public void setOutside(Object outside)

Sets the value of field 'outside'.

Parameters:

outside - the value of field 'outside'.

setUnit

public void setUnit(UnitType unit)

Sets the value of field 'unit'. The field 'unit' has the following description: Selects units for the reaction parameter

Parameters:

unit - the value of field 'unit'.

setValue

public void setValue(double value)

Sets the value of field 'value'. The field 'value' has the following description: Defines the value of a reaction parameter

Parameters:

value - the value of field 'value'.

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

Compartment

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Method validate

Throws:

ValidationException