heart.alsvfd

Class SimpleSymbolic

java.lang.Object

heart.alsvfd.Value

heart.alsvfd.SimpleSymbolic

All Implemented Interfaces:

ExpressionBuilderInterface, ExpressionInterface

public class SimpleSymbolic
extends Value

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOT_ORDERED_ERROR_MESSAGE

Fields inherited from class heart.alsvfd.Value

ANY, NULL

Constructor Summary

Constructors

Constructor and Description
SimpleSymbolic()
SimpleSymbolic(SimpleSymbolic otherValue)
SimpleSymbolic(java.lang.String value)
SimpleSymbolic(java.lang.String value, java.lang.Integer order)
SimpleSymbolic(java.lang.String value, java.lang.Integer order, float certaintyFactor)

Method Summary

Modifier and Type	Method and Description
Value	clone()
boolean	eq(Value v, Type t) A method that should be used to compare two values for equality.
static SimpleSymbolic	findInTheDomain(SimpleNumeric v, Type t) A method that searches for a value in a domain of Type.
static SimpleSymbolic	findInTheDomain(SimpleSymbolic v, Type t) A method that searches for a value in a domain of Type.
static SimpleSymbolic	findInTheDomain(Value v, Type t) A method that searches for a value in a domain of Type.
java.lang.Integer	getOrder()
java.lang.String	getValue()
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.
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.
boolean	isInTheDomain(Type t) A method that searches for a value in a domain of Type.
boolean	isOrdered()
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.
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.
void	setOrder(java.lang.Integer order)
void	setValue(java.lang.String value)
java.lang.String	toString()

Methods inherited from class heart.alsvfd.Value

add, build, checkDomain, div, equals, evaluate, evaluateType, except, factorial, getCertaintyFactor, getTimestamp, intersect, mod, mul, notsim, pow, powerset, setCertaintyFactor, setTimestamp, sim, staticEvaluate, sub, subset, supset, union

Methods inherited from class java.lang.Object

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

Field Detail

NOT_ORDERED_ERROR_MESSAGE

public static final java.lang.String NOT_ORDERED_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

SimpleSymbolic

public SimpleSymbolic()

SimpleSymbolic

public SimpleSymbolic(java.lang.String value)

SimpleSymbolic

public SimpleSymbolic(java.lang.String value,
                      java.lang.Integer order)

SimpleSymbolic

public SimpleSymbolic(java.lang.String value,
                      java.lang.Integer order,
                      float certaintyFactor)

SimpleSymbolic

public SimpleSymbolic(SimpleSymbolic otherValue)

Method Detail

eq

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

Description copied from class: Value

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

Specified by:

eq in class Value

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 Value.ANY, false otherwise.

Throws:

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

NotInTheDomainException

neq

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

Description copied from class: Value

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

Specified by:

neq in class Value

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

gt

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

Description copied from class: Value

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.

Overrides:

gt in class Value

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

Description copied from class: Value

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.

Overrides:

gte in class Value

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 Value.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

Description copied from class: Value

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.

Overrides:

lt in class Value

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

Description copied from class: Value

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.

Overrides:

lte in class Value

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 Value.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

Description copied from class: Value

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.

Overrides:

in in class Value

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

Description copied from class: Value

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 Value.in(heart.alsvfd.Value, heart.xtt.Type). The value of the parameter is intended to be a SetValue.

Overrides:

notin in class Value

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

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getOrder

public java.lang.Integer getOrder()

setOrder

public void setOrder(java.lang.Integer order)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isOrdered

public boolean isOrdered()

findInTheDomain

public static SimpleSymbolic findInTheDomain(Value v,
                                             Type t)

A method that searches for a value in a domain of Type. The method will return the value with its ordered number if exists.

Parameters:

v - a value to be searched in the domain

t - a type that contains a value

Returns:

a copy of a value from a domain that matches value given as a parameter. If no match is found null is returned.

findInTheDomain

public static SimpleSymbolic findInTheDomain(SimpleSymbolic v,
                                             Type t)

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.

Parameters:

v - a value to be searched in the domain

t - a type that contains a value

Returns:

a copy of a value from a domain that matches value given as a parameter. If no match is found null is returned.

findInTheDomain

public static SimpleSymbolic findInTheDomain(SimpleNumeric v,
                                             Type t)

A method that searches for a value in a domain of Type. This is useful if symbolic field in SimpleSymbolic value is not known. The method will return the value with its symbolic number if exists.

Parameters:

v - a value to be searched in the domain

t - a type that contains a value

Returns:

a copy of a value from a domain that matches value given as a parameter. If no match is found null is returned.

isInTheDomain

public boolean isInTheDomain(Type t)

Description copied from class: Value

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.

Specified by:

isInTheDomain in class Value

Returns:

true if the value is in the domain, false otherwise

hashCode

public int hashCode()

Specified by:

hashCode in class Value

clone

public Value clone()

Specified by:

clone in class Value