fr.ifremer.isisfish.simulator.sensitivity

Class Factor

java.lang.Object

fr.ifremer.isisfish.simulator.sensitivity.Factor

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

FactorGroup

public class Factor
extends Object
implements Serializable, Cloneable

Facteur de variation des parametres de simulation. La classe doit être Serializable avec ses valeurs pour permettre l'export XML.

Version:

$Revision: 1.0 $ Last update : $Date: 19 févr. 2009 $ By : $Author: chatellier $

Author:

chatellier

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cardinality Cardinality
protected String	comment Commentaire du facteur.
protected Domain	domain Domaine du facteur.
protected String	equationVariableName Variable name in case of equation factor (must be java valid identifier)
protected Object	identifier The identifier used to compute value.
protected String	name Nom du facteur.
protected Object	nominalValue Value that this factor got in the database
protected String	path Path permettant d'identifier l'objet et la propriete de l'objet a mettre a jour.
protected Object	value Factor value.

Constructor Summary

Constructors

Constructor and Description
Factor(String name) Constructor with name.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(FactorVisitor visitor) Accept a new visitor.
Object	clone()
int	getCardinality()
String	getComment() Get comment.
Object	getDisplayedValue() Get the factor value for displaying (for example in R).
Domain	getDomain() Get domain.
String	getEquationVariableName() Get variable name.
String	getName() Get name.
Object	getNominalValue()
String	getPath() Get path.
Object	getValue() Get value.
void	setCardinality(int cardinality)
void	setComment(String comment) Set comment.
void	setDomain(Domain domain) Set domain.
void	setEquationVariableName(String equationVariableName) Set variable name.
void	setName(String name) Set name.
void	setNominalValue(Object nominalValue)
void	setPath(String path) Set path.
void	setValue(Object value) Set value.
void	setValueForIdentifier(Object valueIdentifier) Set value for label.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Nom du facteur.

comment

protected String comment

Commentaire du facteur.

identifier

protected Object identifier

The identifier used to compute value.

domain

protected Domain domain

Domaine du facteur. Ensemble des valeurs possibles a prendre en compte. La clé est un label qui permet d'identifier la valeur. Le domain peut etre :

• discret : i.e un ensemble de valeurs
• continu : i.e, une borne min, max

See Also:

ContinuousDomain, DiscreteDomain

nominalValue

protected Object nominalValue

Value that this factor got in the database

value

protected Object value

Factor value.

path

protected String path

Path permettant d'identifier l'objet et la propriete de l'objet a mettre a jour. Par exemple: topiaID#gear aura pour effet de recuperer l'objet correspondant au topiaID fournit et d'appeler le propriete setGear(value) dessus.

cardinality

protected int cardinality

Cardinality

equationVariableName

protected String equationVariableName

Variable name in case of equation factor (must be java valid identifier)

Constructor Detail

Factor

public Factor(String name)

Constructor with name.

Parameters:

name - factor name

Method Detail

getName

public String getName()

Get name.

Returns:

the name

setName

public void setName(String name)

Set name.

Parameters:

name - the name to set

getComment

public String getComment()

Get comment.

Returns:

the comment

setComment

public void setComment(String comment)

Set comment.

Parameters:

comment - comment to set

getDomain

public Domain getDomain()

Get domain.

Returns:

the domain

setDomain

public void setDomain(Domain domain)

Set domain.

Parameters:

domain - the domain to set

getValue

public Object getValue()

Get value.

Returns:

the value

getDisplayedValue

public Object getDisplayedValue()

Get the factor value for displaying (for example in R).

Returns:

the value

setValue

public void setValue(Object value)

Set value.

Parameters:

value - new value

setValueForIdentifier

public void setValueForIdentifier(Object valueIdentifier)

Set value for label.

Parameters:

valueIdentifier - new value identifier to get

getPath

public String getPath()

Get path.

Returns:

the path

setPath

public void setPath(String path)

Set path. Warning, path need to be always a valid entity property reference.

Parameters:

path - the path to set

getNominalValue

public Object getNominalValue()

setNominalValue

public void setNominalValue(Object nominalValue)

getCardinality

public int getCardinality()

setCardinality

public void setCardinality(int cardinality)

getEquationVariableName

public String getEquationVariableName()

Get variable name.

Returns:

the variableName

setEquationVariableName

public void setEquationVariableName(String equationVariableName)

Set variable name.

Parameters:

equationVariableName - the variableName to set

accept

public void accept(FactorVisitor visitor)

Accept a new visitor.

Parameters:

visitor -

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object