heart.alsvfd

Class Value

java.lang.Object

heart.alsvfd.Value

All Implemented Interfaces:

ExpressionBuilderInterface, ExpressionInterface

Direct Known Subclasses:

Any, Null, Range, SetValue, SimpleNumeric, SimpleSymbolic

public abstract class Value
extends java.lang.Object
implements ExpressionInterface, ExpressionBuilderInterface

An abstract class representing a Value in ALSV(FD) logic. Values can be of five types in ALSV(FD): simple symbolic, simple numeric range symbolic, range numeric and set. This is a base class for all of the more specific classes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY A meta value ID representing any value.
static java.lang.String	NULL A meta value ID representing a state of absolute lack of knowledge about the attribute value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Value() This is the constructor that is invoked every time a Value is being created.

Method Summary

Modifier and Type	Method and Description
Value	add(Value v, Type t) A method that should be used to calculate sum between a value represented by an object that calls the method and a value given as a parameter.
ExpressionInterface	build(java.util.Map<java.lang.String,Attribute> atts)
protected void	checkDomain(Value v, Type t) Checks if current instance and specified value are in the domain
abstract Value	clone()
Value	div(Value v, Type t) A method that should be used to calculate integral between a value represented by an object that calls the method and a value given as a parameter.
abstract boolean	eq(Value v, Type t) A method that should be used to compare two values for equality.
boolean	equals(java.lang.Object obj)
Value	evaluate(WorkingMemory wm)
Type	evaluateType(WorkingMemory wm) A value should always return null for the type.
Value	except(Value v, Type t) An abstract method that should be used to calculate set that subtracts the value given as the parameter from the set.
Value	factorial() A method that should be used to calculate factorial of the value represented by an object that calls the method.
float	getCertaintyFactor() A method used to get the certainty factor of a value.
long	getTimestamp() Returns the time when the value was achieved.
boolean	gt(Value v, Type t) A method that should be used to compare two values.
boolean	gte(Value v, Type t) A method that should be used to compare two values.
abstract int	hashCode()
boolean	in(Value v, Type t) An operator that should be used to check membership of a value of an object that calls the method within a value given by the parameter.
Value	intersect(Value v, Type t) A method that should be used to calculate intersection with the value given as a parameter.
abstract boolean	isInTheDomain(Type t) A method that searches for a value in a domain of Type.
boolean	lt(Value v, Type t) A method that should be used to compare two values.
boolean	lte(Value v, Type t) A method that should be used to compare two values.
Value	mod(Value v, Type t) A method that should be used to calculate modulo integral between a value represented by an object that calls the method and a value given as a parameter.
Value	mul(Value v, Type t) A method that should be used to calculate multiplication between a value represented by an object that calls the method and a value given as a parameter.
abstract boolean	neq(Value v, Type t) A method that should be used to compare two values for not equality.
boolean	notin(Value v, Type t) An operator that should be used to check membership of a value of an object that calls the method within a value given by the parameter.
boolean	notsim(Value v, Type t) A method that should be used to check if the value has a nonempty intersection with a value given as a parameter.
Value	pow(Value v, Type t) A method that should be used to calculate power of a value represented by an object that calls the method to the value given as a parameter.
Value	powerset() An abstract method that should be used to calculate powerset of a value represented by an object that calls the method.
void	setCertaintyFactor(float certaintyFactor) Sets the certainty factor of a value.
void	setTimestamp(long timestamp) Sets the timestamp of the value.
boolean	sim(Value v, Type t) A method that should be used to check if the value has a nonempty intersection with a value given as a parameter.
Value	staticEvaluate(java.util.Map<java.lang.String,Attribute> atts)
Value	sub(Value v, Type t) A method that should be used to calculate difference between a value represented by an object that calls the method and a value given as a parameter.
boolean	subset(Value v, Type t) A method that should be used to check is the value is a subset of value given as a parameter.
boolean	supset(Value v, Type t) A method that should be used to check if the value is a superset of a value given as a parameter.
Value	union(Value v, Type t) A method that should be used to calculate a sum of two sets.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANY

public static final java.lang.String ANY

A meta value ID representing any value. This value is one of the ALSV(FD) values that an attribute can take. It means that the attribute have some value, but we do not know what and it does not matter. It is not equivalent to null, which means that there is no knowledge about the value of a variable. This value is considered with respect to domains of attributes, so comparing "a lt any" is not always true, as "a" may be the biggest value in the domain. Any value is different form null value. Null means that we have no knowledge about the value.

See Also:

Constant Field Values

NULL

public static final java.lang.String NULL

A meta value ID representing a state of absolute lack of knowledge about the attribute value.

See Also:

Constant Field Values

Constructor Detail

Value

protected Value()

This is the constructor that is invoked every time a Value is being created. It sets the timestamp of a value to the current system time.

Method Detail

eq

public abstract boolean eq(Value v,
                           Type t)
                    throws java.lang.UnsupportedOperationException,
                           NotInTheDomainException,
                           UnknownValueException

A method that should be used to compare two values for equality. If one or two of the values equal ANY, function will return true immediately.

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the values are equal or at least one equals ANY, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

neq

public abstract boolean neq(Value v,
                            Type t)
                     throws java.lang.UnsupportedOperationException,
                            NotInTheDomainException,
                            UnknownValueException

A method that should be used to compare two values for not equality. It is opposite to eq(heart.alsvfd.Value, heart.xtt.Type).

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if values are different, or in case when parameter v equals null, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

gt

public boolean gt(Value v,
                  Type t)
           throws java.lang.UnsupportedOperationException,
                  NotInTheDomainException,
                  UnknownValueException

A method that should be used to compare two values. It checks weather the value represented by an object that calls the method is greater than the value of a parameter. The method should be implemented in simple classes that operates on numbers like SimpleNumeric, but also in simple classes that introduce order in domain, like SimpleSymbolic with ordered domain.

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the Value v is greater than the value of an object, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

gte

public boolean gte(Value v,
                   Type t)
            throws java.lang.UnsupportedOperationException,
                   NotInTheDomainException,
                   UnknownValueException

A method that should be used to compare two values. It checks weather the value represented by an object that calls the method is greater or equal to the value of a parameter. The method should be implemented in simple classes that operates on numbers like SimpleNumeric, but also in simple classes that introduce order in domain, like SimpleSymbolic with ordered domain.

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the Value v is greater or equal the value of an object, or in case when one or both of compared values are equal to ANY, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

lt

public boolean lt(Value v,
                  Type t)
           throws java.lang.UnsupportedOperationException,
                  NotInTheDomainException,
                  UnknownValueException

A method that should be used to compare two values. It checks weather the value represented by an object that calls the method is less than the value of a parameter. The method should be implemented in simple classes that operates on numbers like SimpleNumeric, but also in simple classes that introduce order in domain, like SimpleSymbolic with ordered domain.

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the Value v is less than the value of an object, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

lte

public boolean lte(Value v,
                   Type t)
            throws java.lang.UnsupportedOperationException,
                   NotInTheDomainException,
                   UnknownValueException

A method that should be used to compare two values. It checks weather the value represented by an object that calls the method is less or equal to the value of a parameter. The method should be implemented in simple classes that operates on numbers like SimpleNumeric, but also in simple classes that introduce order in domain, like SimpleSymbolic with ordered domain.

Parameters:

v - - a value to compare

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the Value v is less than or equal the value of an object, or in case when one or both of compared values are equal to ANY, false otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

in

public boolean in(Value v,
                  Type t)
           throws java.lang.UnsupportedOperationException,
                  NotInTheDomainException,
                  UnknownValueException

An operator that should be used to check membership of a value of an object that calls the method within a value given by the parameter. The value of the parameter is intended to be a SetValue.

Parameters:

v - - a value to be processed

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the value is a member of the value given as a parameter, false otherwise

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

notin

public boolean notin(Value v,
                     Type t)
              throws java.lang.UnsupportedOperationException,
                     NotInTheDomainException,
                     UnknownValueException

An operator that should be used to check membership of a value of an object that calls the method within a value given by the parameter. This method is opposite to in(heart.alsvfd.Value, heart.xtt.Type). The value of the parameter is intended to be a SetValue.

Parameters:

v - - a value to be processed

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

false if the value is a member of the value given as a parameter, true otherwise or if a parameter equal {link #ANY}.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

supset

public boolean supset(Value v,
                      Type t)
               throws java.lang.UnsupportedOperationException,
                      NotInTheDomainException,
                      UnknownValueException

A method that should be used to check if the value is a superset of a value given as a parameter.

Parameters:

v - - a value to be processed. Both values should be a sets, or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the value is superset of v, false otherwise

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

subset

public boolean subset(Value v,
                      Type t)
               throws java.lang.UnsupportedOperationException,
                      NotInTheDomainException,
                      UnknownValueException

A method that should be used to check is the value is a subset of value given as a parameter.

Parameters:

v - - a value to be processed. Both values should be a sets, or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the value is subset of v, false otherwise

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

sim

public boolean sim(Value v,
                   Type t)
            throws java.lang.UnsupportedOperationException,
                   NotInTheDomainException,
                   UnknownValueException

A method that should be used to check if the value has a nonempty intersection with a value given as a parameter.

Parameters:

v - - a value to be processed. Both values should be sets or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

true if the value has non-empty intersection with parameter v, false otherwise

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

notsim

public boolean notsim(Value v,
                      Type t)
               throws java.lang.UnsupportedOperationException,
                      NotInTheDomainException,
                      UnknownValueException

A method that should be used to check if the value has a nonempty intersection with a value given as a parameter. This method is opposite to sim(heart.alsvfd.Value, heart.xtt.Type).

Parameters:

v - - a value to be processed. Both values should be sets or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

false if the value has non-empty intersection with parameter v or if a parameter equal {link #ANY}, true otherwise.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

intersect

public Value intersect(Value v,
                       Type t)
                throws java.lang.UnsupportedOperationException,
                       NotInTheDomainException,
                       UnknownValueException

A method that should be used to calculate intersection with the value given as a parameter.

Parameters:

v - - a value to be processed. Both values should be a sets, or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

A value that represent intersection between a set represented by an object and the parameter

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

union

public Value union(Value v,
                   Type t)
            throws java.lang.UnsupportedOperationException,
                   NotInTheDomainException,
                   UnknownValueException

A method that should be used to calculate a sum of two sets.

Parameters:

v - - a value to be processed. Both values should be a sets, or ranges.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

sum of a set represented by an object and the parameter

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

except

public Value except(Value v,
                    Type t)
             throws java.lang.UnsupportedOperationException,
                    NotInTheDomainException,
                    UnknownValueException

An abstract method that should be used to calculate set that subtracts the value given as the parameter from the set.

Parameters:

v - - a value to be processed. It can be both simple type or general type.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

Resulting set that represents the value of the object without the value represented by parameter v.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

mul

public Value mul(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate multiplication between a value represented by an object that calls the method and a value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

multiplication of the value represented by an object that calls the method and a value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

sub

public Value sub(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate difference between a value represented by an object that calls the method and a value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type, or ordered symbolic.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

difference between the value represented by an object that calls the method and the value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

div

public Value div(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate integral between a value represented by an object that calls the method and a value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

integral between the value represented by an object that calls the method and the value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

add

public Value add(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate sum between a value represented by an object that calls the method and a value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type, or ordered symbolic.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

sum between the value represented by an object that calls the method and the value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

pow

public Value pow(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate power of a value represented by an object that calls the method to the value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

power of value represented by an object that calls the method to the value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

mod

public Value mod(Value v,
                 Type t)
          throws java.lang.UnsupportedOperationException,
                 NotInTheDomainException,
                 UnknownValueException

A method that should be used to calculate modulo integral between a value represented by an object that calls the method and a value given as a parameter.

Parameters:

v - - a value to be processed. It should be a numerical type.

t - - a type with respect to witch the operator should work. If null, no domain is taken into consideration while evaluating.

Returns:

modulo integral between the value represented by an object that calls the method and the value given as a parameter.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

factorial

public Value factorial()
                throws java.lang.UnsupportedOperationException,
                       NotInTheDomainException,
                       UnknownValueException

A method that should be used to calculate factorial of the value represented by an object that calls the method.

Returns:

factorial of the value represented by an object that calls the method.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

powerset

public Value powerset()
               throws java.lang.UnsupportedOperationException,
                      NotInTheDomainException,
                      UnknownValueException

An abstract method that should be used to calculate powerset of a value represented by an object that calls the method.

Returns:

Resulting set that represents the powerset of a value represented by an object that calls the method.

Throws:

java.lang.UnsupportedOperationException - in cases when operator is not applicable to the values being parameters of the operation.

NotInTheDomainException

UnknownValueException

isInTheDomain

public abstract boolean isInTheDomain(Type t)
                               throws java.lang.UnsupportedOperationException,
                                      NotInTheDomainException,
                                      UnknownValueException

A method that searches for a value in a domain of Type. This is useful if ordered field in SimpleSymbolic value is not known. The method will return the value with its ordered number if exists. If Null calls this method, false is always returned. If Any calls this method true is returned if the domain is not empty.

Returns:

true if the value is in the domain, false otherwise

Throws:

NotInTheDomainException

java.lang.UnsupportedOperationException

UnknownValueException

getCertaintyFactor

public float getCertaintyFactor()

A method used to get the certainty factor of a value. The certainty factor vary from -1 to 1 representing respectively Absolute negation of the value and absolute certainty of the value.

Returns:

certainty factor associated with the value

setCertaintyFactor

public void setCertaintyFactor(float certaintyFactor)

Sets the certainty factor of a value.

Parameters:

certaintyFactor -

checkDomain

protected void checkDomain(Value v,
                           Type t)
                    throws NotInTheDomainException,
                           UnknownValueException

Checks if current instance and specified value are in the domain

Parameters:

v - - a value to be processed. It may be any of the Value implementation class.

t - - a type with respect to witch the operator should work.

Throws:

NotInTheDomainException - thrown if either this instance or v param is not in the domain

UnknownValueException

getTimestamp

public long getTimestamp()

Returns the time when the value was achieved.

Returns:

timestamp in milliseconds

setTimestamp

public void setTimestamp(long timestamp)

Sets the timestamp of the value. This represents the time in milliseconds which represents a point in time when the value was read/obtained

Parameters:

timestamp -

evaluate

public Value evaluate(WorkingMemory wm)

Specified by:

evaluate in interface ExpressionInterface

build

public ExpressionInterface build(java.util.Map<java.lang.String,Attribute> atts)
                          throws BuilderException

Specified by:

build in interface ExpressionBuilderInterface

Throws:

BuilderException

staticEvaluate

public Value staticEvaluate(java.util.Map<java.lang.String,Attribute> atts)
                     throws StaticEvaluationException

Specified by:

staticEvaluate in interface ExpressionBuilderInterface

Throws:

StaticEvaluationException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public abstract Value clone()

Overrides:

clone in class java.lang.Object

evaluateType

public Type evaluateType(WorkingMemory wm)

A value should always return null for the type. Types of values are determined by the attributes with which they are compared.

Specified by:

evaluateType in interface ExpressionInterface

Parameters:

wm - The WorkingMemory object with respect to which a type of an expression should be evaluated

Returns:

type of the expression