oracle.olapi.syntax
Class BetweenCondition

java.lang.Object
  oracle.olapi.syntax.SyntaxObject
      oracle.olapi.syntax.DataObject
          oracle.olapi.syntax.Expression
              oracle.olapi.syntax.Condition
                  oracle.olapi.syntax.BetweenCondition

All Implemented Interfaces:

FunctionArgument

public final class BetweenCondition
extends Condition

A Condition that represents a BETWEEN condition, which determines whether a value is in a specific range of values. A BetweenCondition evaluates to true if the base expression is greater than or equal to the start expression and is less than or equal to the end expression.

Constructor Summary

BetweenCondition(TypedExpression baseExpression, TypedExpression startExpression, TypedExpression endExpression)
Creates a new BetweenCondition that has the specified base, start, and end expressions and determines whether the base value is in the range of values.

BetweenCondition(TypedExpression baseExpression, TypedExpression startExpression, TypedExpression endExpression, boolean negate)
Creates a new BetweenCondition that has the specified base, start, and end expressions.

Method Summary

TypedExpression	getBaseExpression() Gets the TypedExpression that has the value that is the base of the condition.
TypedExpression	getEndExpression() Gets the TypedExpression that has the value that is the end of the range of values to compare to the base value.
TypedExpression	getStartExpression() Gets the TypedExpression that has the value that is the start of the range of values to compare to the base value.
boolean	isNegated() Indicates whether this BetweenCondition determines that the base value is in the specified range or is not in the range.
java.lang.Object	visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitBetweenCondition method of the SyntaxObjectVisitor and passes that method this BetweenCondition and an Object.

Methods inherited from class oracle.olapi.syntax.Condition

and, isCompositeObject, not, or

Methods inherited from class oracle.olapi.syntax.SyntaxObject

equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BetweenCondition

public BetweenCondition(TypedExpression baseExpression,
                        TypedExpression startExpression,
                        TypedExpression endExpression,
                        boolean negate)

Creates a new BetweenCondition that has the specified base, start, and end expressions. The negate parameter specifies whether to determine that the base value is in the range or is not in the range.

Parameters:

baseExpression - A TypedExpression that has the base value of the condition.

startExpression - A TypedExpression that has the value that is the start of the range.

endExpression - A TypedExpression that has the value that is the end of the range.

negate - A boolean that is true to determine if the base value is not in the range or false to determine if the base value is in the range.

BetweenCondition

public BetweenCondition(TypedExpression baseExpression,
                        TypedExpression startExpression,
                        TypedExpression endExpression)

Creates a new BetweenCondition that has the specified base, start, and end expressions and determines whether the base value is in the range of values.

Parameters:

baseExpression - A TypedExpression that has the base value of the condition.

startExpression - A TypedExpression that has the value that is the start of the range.

endExpression - A TypedExpression that has the value that is the end of the range.

Method Detail

visit

public java.lang.Object visit(SyntaxObjectVisitor visitor,
                              java.lang.Object context)

Calls the visitBetweenCondition method of the SyntaxObjectVisitor and passes that method this BetweenCondition and an Object.

Specified by:

visit in class SyntaxObject

Parameters:

visitor - A SyntaxObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitBetweenCondition method.

getBaseExpression

public TypedExpression getBaseExpression()

Gets the TypedExpression that has the value that is the base of the condition.

Returns:

A TypedExpression that has the value to compare to the start and end values.

getStartExpression

public TypedExpression getStartExpression()

Gets the TypedExpression that has the value that is the start of the range of values to compare to the base value.

Returns:

A TypedExpression that has the value that is the start of the range of values.

getEndExpression

public TypedExpression getEndExpression()

Gets the TypedExpression that has the value that is the end of the range of values to compare to the base value.

Returns:

A TypedExpression that has the value that is the end of the range of values.

isNegated

public boolean isNegated()

Indicates whether this BetweenCondition determines that the base value is in the specified range or is not in the range.

Returns:

A boolean that is true if this BetweenCondition determines whether the base value is not in the range or is false if it determines that the base value is in the range.