org.sigpath.datamodel.models
Class Compartment

java.lang.Object
  org.sigpath.datamodel.models.Compartment

public class Compartment
extends Object

Class describing a compartment

Author:

Francois Le Fevre

Constructor Summary

Compartment()
Default constructor.

Compartment(SPDBManager dbm)
Constructs a new compartment.

Method Summary

void	addInContactWith(Compartment compartment)
String	getDescription()
Collection	getIncontactWith()
Iterator	getIncontactWithIterator()
String	getIncontactWithName()
String	getName() Return the compartment name.
Compartment	getOutSide()
Parameter	getVolume() Return the volume of this compartment.
boolean	isInContactWith(Compartment compartment) Test if this compartment is in contact with a compartment.
void	removeInContactWith(Compartment compartment) Removes compartment from the list of compartments this compartment is in contact with.
void	setDescription(String description)
void	setName(String name) Sets the name of this compartment.
void	setOutSide(Compartment outSide)
void	setVolume(Parameter volume)

Methods inherited from class java.lang.Object

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

Constructor Detail

Compartment

public Compartment()

Default constructor.

Compartment

public Compartment(SPDBManager dbm)

Constructs a new compartment.

Method Detail

getName

public String getName()

Return the compartment name.

setName

public void setName(String name)

Sets the name of this compartment.

getOutSide

public Compartment getOutSide()

getVolume

public Parameter getVolume()

Return the volume of this compartment.

addInContactWith

public void addInContactWith(Compartment compartment)

getIncontactWith

public Collection getIncontactWith()

getIncontactWithName

public String getIncontactWithName()

getIncontactWithIterator

public Iterator getIncontactWithIterator()

isInContactWith

public boolean isInContactWith(Compartment compartment)

Test if this compartment is in contact with a compartment.

Parameters:

compartment - Compartment.

Returns:

True if this compartment is in contact with compartment, False otherwise.

removeInContactWith

public void removeInContactWith(Compartment compartment)

Removes compartment from the list of compartments this compartment is in contact with.

Parameters:

compartment - The other compartment.

setOutSide

public void setOutSide(Compartment outSide)

setVolume

public void setVolume(Parameter volume)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)