heart.alsvfd

Class SetValue

java.lang.Object

heart.alsvfd.Value

heart.alsvfd.SetValue

All Implemented Interfaces:

ExpressionBuilderInterface, ExpressionInterface, java.lang.Iterable<Value>

public class SetValue
extends Value
implements java.lang.Iterable<Value>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_MESSAGE
protected java.util.List<Value>	values An ArrayList representing values of a set.

Fields inherited from class heart.alsvfd.Value

ANY, NULL

Constructor Summary

Constructors

Constructor and Description
SetValue() Default constructor.
SetValue(java.util.List<Value> values) Constructor that assign values given as a parameter to values that represents the set.
SetValue(java.util.List<Value> values, float certaintyFactor) Constructor that assign values given as a parameter to values that represents the set.
SetValue(SetValue other)

Method Summary

Modifier and Type	Method and Description
void	appendValue(Value v)
void	appendValues(SetValue sv)
int	cardinality(Type t) This returns number of elements in a set.
Value	clone()
boolean	eq(Value v, Type t) A method that should be used to compare two values for equality.
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.
java.util.List<Value>	getValues()
int	hashCode()
Value	intersect(Value v, Type t) A method that should be used to calculate intersection with the value given as a parameter.
boolean	isEmpty()
boolean	isInTheDomain(Type t) A method that searches for a value in a domain of Type.
java.util.Iterator<Value>	iterator()
Value	max() Method that search for the maximum value in a set.
Value	min() Method that search for the minimum value in a set.
boolean	neq(Value v, Type t) A method that should be used to compare two values for not equality.
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.
void	setValues(java.util.List<Value> values)
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.
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.
java.lang.String	toString()
Value	union(Value v, Type t) A method that should be used to calculate a sum of two sets.

Methods inherited from class heart.alsvfd.Value

add, build, checkDomain, div, equals, evaluate, evaluateType, factorial, getCertaintyFactor, getTimestamp, gt, gte, in, lt, lte, mod, mul, notin, pow, powerset, setCertaintyFactor, setTimestamp, staticEvaluate, sub

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ERROR_MESSAGE

public static final java.lang.String ERROR_MESSAGE

See Also:

Constant Field Values

values

protected java.util.List<Value> values

An ArrayList representing values of a set.

Constructor Detail

SetValue

public SetValue()

Default constructor. It creates an empty set.

SetValue

public SetValue(SetValue other)

SetValue

public SetValue(java.util.List<Value> values)

Constructor that assign values given as a parameter to values that represents the set.

Parameters:

values - to set

SetValue

public SetValue(java.util.List<Value> values,
                float certaintyFactor)

Constructor that assign values given as a parameter to values that represents the set.

Parameters:

values - to set

certaintyFactor - A certainty factor that the set have inside given values.

Method Detail

eq

public boolean eq(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 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

UnknownValueException

neq

public boolean neq(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 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

UnknownValueException

supset

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

Description copied from class: Value

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

Overrides:

supset in class Value

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

Description copied from class: Value

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

Overrides:

subset in class Value

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

Description copied from class: Value

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

Overrides:

sim in class Value

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

Description copied from class: Value

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 Value.sim(heart.alsvfd.Value, heart.xtt.Type).

Overrides:

notsim in class Value

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

Description copied from class: Value

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

Overrides:

intersect in class Value

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

Description copied from class: Value

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

Overrides:

union in class Value

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

Description copied from class: Value

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

Overrides:

except in class Value

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

appendValue

public void appendValue(Value v)

appendValues

public void appendValues(SetValue sv)

getValues

public java.util.List<Value> getValues()

setValues

public void setValues(java.util.List<Value> values)

isEmpty

public boolean isEmpty()

max

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

Method that search for the maximum value in a set. If set contains unordered elements, an exception is thrown. The method apply only to sets containing simple values to which operators lt and gt can be applied. If the method is called on a set containing other type of elements, and UnsupportedOperationException is thrown

Returns:

maximum value of a set

Throws:

java.lang.UnsupportedOperationException

NotInTheDomainException

UnknownValueException

min

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

Method that search for the minimum value in a set. If set contains unordered elements, an exception is thrown. The method apply only to sets containing simple values to which operators lt and gt can be applied. If the method is called on a set containing other type of elements, and UnsupportedOperationException is thrown

Returns:

minimum value of a set

Throws:

java.lang.UnsupportedOperationException

NotInTheDomainException

UnknownValueException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isInTheDomain

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

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

Throws:

java.lang.UnsupportedOperationException

NotInTheDomainException

UnknownValueException

hashCode

public int hashCode()

Specified by:

hashCode in class Value

clone

public Value clone()

Specified by:

clone in class Value

cardinality

public int cardinality(Type t)
                throws java.lang.UnsupportedOperationException,
                       NotInTheDomainException,
                       UnknownValueException

This returns number of elements in a set. The set is not flatten, so a set containing three sets will have cardinality equals 3 no matter how many elements the inner sets will have.

Parameters:

t - type with respect to which the cardinality should be calculated. This is important for the numeric ranges

Returns:

number of elements in a set

Throws:

NotInTheDomainException

java.lang.UnsupportedOperationException

UnknownValueException

iterator

public java.util.Iterator<Value> iterator()

Specified by:

iterator in interface java.lang.Iterable<Value>