com.bayesia.api

Class FunctionValue

java.lang.Object

com.bayesia.api.FunctionValue

public class FunctionValue
extends java.lang.Object

The class FunctionValue the result of a function node after performing inference.

A FunctionValue can be either a String, a number or a Boolean.

Version:

4.2

Author:

Bayesia S.A.S.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone the value.
boolean	equals(java.lang.Object obj) A non-existent value is only equal to another non-existent value.
java.lang.Boolean	getBoolean() Return the Boolean corresponding to the value.
java.lang.String	getFormattedString() Return the string representation of the value formatted by the Formatter associated to the function node that have produced this value.
java.lang.Number	getNumber() Return the Number corresponding to the value.
java.lang.String	getString() Return the String corresponding to the value.
int	hashCode()
boolean	isBoolean() Test if the value is a Boolean.
boolean	isNumber() Test if the value is an instance of Number.
boolean	isRealString() Test if the value is an instance of String.
boolean	isString() Test if the value can be represented by a String.
java.lang.String	toString() Return the string representation as returned by getString.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isBoolean

public boolean isBoolean()

Test if the value is a Boolean.

Returns:

true if the value is a Boolean, false otherwise.

getBoolean

public java.lang.Boolean getBoolean()

Return the Boolean corresponding to the value. The method isBoolean should be tested before.

Returns:

a Boolean representing the value or null if the value is not a Boolean

isString

public boolean isString()

Test if the value can be represented by a String.

Returns:

always true.

isRealString

public boolean isRealString()

Test if the value is an instance of String.

Returns:

true if the value is a String, false otherwise.

getString

public java.lang.String getString()

Return the String corresponding to the value. If the value is a real String, the value is returned as is, otherwise, if the value is an instance of Boolean or Number, the result of the method toString called on the valueis return

Returns:

a String representing the value or null if the value is null

isNumber

public boolean isNumber()

Test if the value is an instance of Number.

Returns:

true if the value is a Number, false otherwise.

getNumber

public java.lang.Number getNumber()

Return the Number corresponding to the value. The method isNUmber should be tested before.

Returns:

a Number representing the value or null if the value is not a Boolean

equals

public boolean equals(java.lang.Object obj)

A non-existent value is only equal to another non-existent value.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

clone

public java.lang.Object clone()

Clone the value.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Return the string representation as returned by getString.

Overrides:

toString in class java.lang.Object

Returns:

a String representing this object

See Also:

getString()

getFormattedString

public java.lang.String getFormattedString()

Return the string representation of the value formatted by the Formatter associated to the function node that have produced this value.

Returns:

a formatted String representing this object