heart.alsvfd

Class Range

java.lang.Object

heart.alsvfd.Value

heart.alsvfd.Range

All Implemented Interfaces:

ExpressionBuilderInterface, ExpressionInterface

public class Range
extends Value

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EQ_ERROR_MESSAGE
static java.lang.String	RANGE_SET_ERROR_MESSAGE

Fields inherited from class heart.alsvfd.Value

ANY, NULL

Constructor Summary

Constructors

Constructor and Description
Range() Default constructor.
Range(Range other) Copy constructor.
Range(SimpleNumeric from, boolean includeFrom, SimpleNumeric to, boolean includeTo)
Range(SimpleNumeric from, boolean includeFrom, SimpleNumeric to, boolean includeTo, float certaintyFactor)
Range(SimpleNumeric from, SimpleNumeric to) Range constructor that sets the range boundaries according to given parameters.
Range(SimpleNumeric from, SimpleNumeric to, float certaintyFactor) Range constructor that sets the range boundaries according to given parameters.
Range(SimpleSymbolic from, boolean includeFrom, SimpleSymbolic to, boolean includeTo)
Range(SimpleSymbolic from, boolean includeFrom, SimpleSymbolic to, boolean includeTo, float certaintyFactor)
Range(SimpleSymbolic from, SimpleSymbolic to) Range constructor that sets the range boundaries according to given parameters.
Range(SimpleSymbolic from, SimpleSymbolic to, float certaintyFactor) Range constructor that sets the range boundaries according to given parameters.

Method Summary

Modifier and Type	Method and Description
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.
Value	getFrom() Getter for a left boundary of a range.
Value	getTo() Getter for a right boundary of a range.
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	isInTheDomain(Type t) A method that searches for a value in a domain of Type.
boolean	isLeftInclusive()
boolean	isRightInclusive()
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	setLeftInclusive(boolean leftInclusive)
void	setRange(SimpleNumeric from, SimpleNumeric to) It sets the range boundaries.
void	setRange(SimpleSymbolic from, SimpleSymbolic to) It sets the range boundaries.
void	setRightInclusive(boolean rightInclusive)
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

Field Detail

RANGE_SET_ERROR_MESSAGE

public static final java.lang.String RANGE_SET_ERROR_MESSAGE

See Also:

Constant Field Values

EQ_ERROR_MESSAGE

public static final java.lang.String EQ_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

Range

public Range()

Default constructor. Sets boundaries to be null; By default the right and left inclusion of the boundaries are set to be true.

Range

public Range(Range other)

Copy constructor. It creates new range that is a copy of a range given by a parameter. The constructor is a shallow copy of the from and to values.

Parameters:

other - range to be copied

Range

public Range(SimpleNumeric from,
             SimpleNumeric to)
      throws RangeFormatException

Range constructor that sets the range boundaries according to given parameters. It also sets the boundaries to be included within a range.

Parameters:

from - A left boundary of the range

to - A right boundary of the range

Throws:

RangeFormatException

Range

public Range(SimpleNumeric from,
             SimpleNumeric to,
             float certaintyFactor)
      throws RangeFormatException

Range constructor that sets the range boundaries according to given parameters. It also sets the boundaries to be included within a range.

Parameters:

from - A left boundary of the range

to - A right boundary of the range

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

Throws:

RangeFormatException

Range

public Range(SimpleSymbolic from,
             SimpleSymbolic to)
      throws RangeFormatException

Range constructor that sets the range boundaries according to given parameters. It also sets the boundaries to be included within a range.

Parameters:

from - A left boundary of the range

to - A right boundary of the range

Throws:

RangeFormatException

Range

public Range(SimpleSymbolic from,
             SimpleSymbolic to,
             float certaintyFactor)
      throws RangeFormatException

Range constructor that sets the range boundaries according to given parameters. It also sets the boundaries to be included within a range.

Parameters:

from - A left boundary of the range

to - A right boundary of the range

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

Throws:

RangeFormatException

Range

public Range(SimpleNumeric from,
             boolean includeFrom,
             SimpleNumeric to,
             boolean includeTo)
      throws RangeFormatException

Throws:

RangeFormatException

Range

public Range(SimpleSymbolic from,
             boolean includeFrom,
             SimpleSymbolic to,
             boolean includeTo)
      throws RangeFormatException

Throws:

RangeFormatException

Range

public Range(SimpleNumeric from,
             boolean includeFrom,
             SimpleNumeric to,
             boolean includeTo,
             float certaintyFactor)
      throws RangeFormatException

Throws:

RangeFormatException

Range

public Range(SimpleSymbolic from,
             boolean includeFrom,
             SimpleSymbolic to,
             boolean includeTo,
             float certaintyFactor)
      throws RangeFormatException

Throws:

RangeFormatException

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

setRange

public void setRange(SimpleSymbolic from,
                     SimpleSymbolic to)
              throws RangeFormatException

It sets the range boundaries. Left and right inclusion is set to true.

Parameters:

from - left boundary of a range

to - right boundary of a range

Throws:

RangeFormatException

setRange

public void setRange(SimpleNumeric from,
                     SimpleNumeric to)
              throws RangeFormatException

It sets the range boundaries. Left and right inclusion is set to true.

Parameters:

from - left boundary of a range

to - right boundary of a range

Throws:

RangeFormatException

getFrom

public Value getFrom()

Getter for a left boundary of a range.

Returns:

left boundary of a range

getTo

public Value getTo()

Getter for a right boundary of a range.

Returns:

right boundary of a range

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isLeftInclusive

public boolean isLeftInclusive()

Returns:

the leftInclusive

setLeftInclusive

public void setLeftInclusive(boolean leftInclusive)
                      throws RangeFormatException

Parameters:

leftInclusive - the leftInclusive to set

Throws:

RangeFormatException

isRightInclusive

public boolean isRightInclusive()

Returns:

the rightInclusive

setRightInclusive

public void setRightInclusive(boolean rightInclusive)
                       throws RangeFormatException

Parameters:

rightInclusive - the rightInclusive to set

Throws:

RangeFormatException

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 X sets will have cardinality equals X no matter how many elements the inner sets will have.

Returns:

number of elements in a set

Throws:

NotInTheDomainException

java.lang.UnsupportedOperationException

UnknownValueException