Package hec.hecmath.computation

Class Variable

java.lang.Object

hec.hecmath.computation.Variable

All Implemented Interfaces:

Constants, Evaluable, Setable, Updatable, UpdatableListener

public class Variable
extends Object
implements Evaluable, Setable

Nested Class Summary

Nested classes/interfaces inherited from interface hec.hecmath.computation.Constants

Constants.LogicTestOperator, Constants.MathOperator, Constants.Notation, Constants.Precedence, Constants.QualityOperator, Constants.QualityTestOperator, Constants.TextOperator, Constants.TextTestOperator, Constants.ValueTestOperator

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowDenormal
protected static boolean	allowDenormalByDefault
protected boolean	containsQuality
protected boolean	containsText
protected boolean	containsValue
protected boolean	exceptionOnUndefined
protected static boolean	exceptionOnUndefinedByDefault
protected String	name
protected int	quality
protected String	text
static final String	textStringPattern
protected static Variable	theInstance
protected boolean	tolerateUndefined
protected static boolean	tolerateUndefinedByDefault
protected Set<UpdatableListener>	updateListeners
protected Object	updateListenersLock
protected double	value
static final String	variableNamePattern

Fields inherited from interface hec.hecmath.computation.Constants

BINARY, CONSTANT, TERNARY, UNARY, VARIADIC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Variable()
	Variable(String name)
	Variable(String name, double value)
	Variable(String name, double value, int quality)
	Variable(String name, Object valueObj)
	Variable(String name, Object value, Object quality)

Method Summary

Modifier and Type	Method	Description
void	dataUpdated(Updatable u)
double	evaluate()
String	evaluateToString()
boolean	getAllowDenormal()
static boolean	getAllowDenormalByDefault()
boolean	getExceptionOnUndefined()
static boolean	getExceptionOnUndefinedByDefault()
String	getName()
int	getQuality()
boolean	getTolerateUndefined()
static boolean	getTolerateUndefinedByDefault()
boolean	hasQuality()
static boolean	isVariableName(String text)
static double	normalize(double value)
void	notifyListeners()
void	registerAsListener(Updatable u)
void	registerListener(UpdatableListener listener)
void	reset()
void	setAllowDenormal(boolean setting)
static void	setAllowDenormalByDefault(boolean setting)
void	setExceptionOnUndefined(boolean setting)
static void	setExceptionOnUndefinedByDefault(boolean setting)
protected void	setName(String name)
void	setQuality(int quality)
void	setQuality(Integer quality)
void	setQuality(String quality)
void	setText(String text)
void	setTolerateUndefined(boolean setting)
static void	setTolerateUndefinedByDefault(boolean setting)
void	setValue(double value)
void	setValue(int value)
void	setValue(Double value)
void	setValue(Integer value)
void	setValue(String value)
void	setValueAndQuality(double value, int quality)
void	setValueAndQuality(Object valueObj, Object qualityObj)
String	toNotation(Constants.Notation notation)
String	toString()
void	unregisterAsListener()
void	unregisterAsListener(Updatable u)
void	unregisterListener(UpdatableListener listener)

Methods inherited from class java.lang.Object

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

Field Details

variableNamePattern

public static final String variableNamePattern

See Also:

• Constant Field Values

textStringPattern

public static final String textStringPattern

See Also:

• Constant Field Values

theInstance

protected static Variable theInstance

tolerateUndefinedByDefault

protected static boolean tolerateUndefinedByDefault

exceptionOnUndefinedByDefault

protected static boolean exceptionOnUndefinedByDefault

allowDenormalByDefault

protected static boolean allowDenormalByDefault

updateListeners

protected Set<UpdatableListener> updateListeners

updateListenersLock

protected Object updateListenersLock

name

protected String name

containsValue

protected boolean containsValue

containsQuality

protected boolean containsQuality

containsText

protected boolean containsText

value

protected double value

quality

protected int quality

text

protected String text

tolerateUndefined

protected boolean tolerateUndefined

exceptionOnUndefined

protected boolean exceptionOnUndefined

allowDenormal

protected boolean allowDenormal

Constructor Details

Variable

protected Variable()

Variable

public Variable(String name)
         throws ComputationException

Throws:

ComputationException

Variable

public Variable(String name,
 double value)
         throws ComputationException

Throws:

ComputationException

Variable

public Variable(String name,
 double value,
 int quality)
         throws ComputationException

Throws:

ComputationException

Variable

public Variable(String name,
 Object valueObj)
         throws ComputationException

Throws:

ComputationException

Variable

public Variable(String name,
 Object value,
 Object quality)
         throws ComputationException

Throws:

ComputationException

Method Details

getTolerateUndefinedByDefault

public static boolean getTolerateUndefinedByDefault()

setTolerateUndefinedByDefault

public static void setTolerateUndefinedByDefault(boolean setting)

getExceptionOnUndefinedByDefault

public static boolean getExceptionOnUndefinedByDefault()

setExceptionOnUndefinedByDefault

public static void setExceptionOnUndefinedByDefault(boolean setting)

getAllowDenormalByDefault

public static boolean getAllowDenormalByDefault()

setAllowDenormalByDefault

public static void setAllowDenormalByDefault(boolean setting)

normalize

public static double normalize(double value)

isVariableName

public static boolean isVariableName(String text)

reset

public void reset()

setValue

public void setValue(double value)
              throws ComputationException

Specified by:

setValue in interface Setable

Throws:

ComputationException

setValue

public void setValue(int value)
              throws ComputationException

Specified by:

setValue in interface Setable

Throws:

ComputationException

setValue

public void setValue(Double value)
              throws ComputationException

Specified by:

setValue in interface Setable

Throws:

ComputationException

setValue

public void setValue(Integer value)
              throws ComputationException

Specified by:

setValue in interface Setable

Throws:

ComputationException

setValue

public void setValue(String value)
              throws ComputationException

Specified by:

setValue in interface Setable

Throws:

ComputationException

setQuality

public void setQuality(int quality)
                throws ComputationException

Throws:

ComputationException

setQuality

public void setQuality(Integer quality)
                throws ComputationException

Throws:

ComputationException

setQuality

public void setQuality(String quality)
                throws ComputationException

Throws:

ComputationException

setValueAndQuality

public void setValueAndQuality(double value,
 int quality)
                        throws ComputationException

Throws:

ComputationException

setValueAndQuality

public void setValueAndQuality(Object valueObj,
 Object qualityObj)
                        throws ComputationException

Throws:

ComputationException

setText

public void setText(String text)
             throws ComputationException

Throws:

ComputationException

evaluate

public double evaluate()
                throws ComputationException

Specified by:

evaluate in interface Evaluable

Throws:

ComputationException

evaluateToString

public String evaluateToString()
                        throws ComputationException

Specified by:

evaluateToString in interface Evaluable

Throws:

ComputationException

hasQuality

public boolean hasQuality()

getQuality

public int getQuality()
               throws ComputationException

Throws:

ComputationException

setName

protected void setName(String name)
                throws ComputationException

Throws:

ComputationException

getName

public String getName()

toString

public String toString()

Specified by:

toString in interface Evaluable

Overrides:

toString in class Object

toNotation

public String toNotation(Constants.Notation notation)
                  throws ComputationException

Specified by:

toNotation in interface Evaluable

Throws:

ComputationException

getTolerateUndefined

public boolean getTolerateUndefined()

Specified by:

getTolerateUndefined in interface Evaluable

getExceptionOnUndefined

public boolean getExceptionOnUndefined()

Specified by:

getExceptionOnUndefined in interface Evaluable

getAllowDenormal

public boolean getAllowDenormal()

Specified by:

getAllowDenormal in interface Evaluable

setTolerateUndefined

public void setTolerateUndefined(boolean setting)

Specified by:

setTolerateUndefined in interface Evaluable

setExceptionOnUndefined

public void setExceptionOnUndefined(boolean setting)

Specified by:

setExceptionOnUndefined in interface Evaluable

setAllowDenormal

public void setAllowDenormal(boolean setting)

Specified by:

setAllowDenormal in interface Evaluable

registerListener

public void registerListener(UpdatableListener listener)

Specified by:

registerListener in interface Updatable

unregisterListener

public void unregisterListener(UpdatableListener listener)

Specified by:

unregisterListener in interface Updatable

notifyListeners

public void notifyListeners()

Specified by:

notifyListeners in interface Updatable

registerAsListener

public void registerAsListener(Updatable u)

Specified by:

registerAsListener in interface UpdatableListener

unregisterAsListener

public void unregisterAsListener(Updatable u)

Specified by:

unregisterAsListener in interface UpdatableListener

unregisterAsListener

public void unregisterAsListener()

Specified by:

unregisterAsListener in interface UpdatableListener

dataUpdated

public void dataUpdated(Updatable u)

Specified by:

dataUpdated in interface UpdatableListener