oracle.toplink.expressions
Class ExpressionOperator

java.lang.Object
  |
  +--oracle.toplink.expressions.ExpressionOperator
All Implemented Interfaces:
java.io.Serializable

public class ExpressionOperator
extends java.lang.Object
implements java.io.Serializable

Purpose: ADVANCED: The expression operator is used internally to define SQL operations and functions. It is possible for an advanced user to define their own operators.

See Also:
Serialized Form

Field Summary
TypeField
static int Abs
           
static int Acos
           
static int Add
           
static int AddDate
           
static int AddMonths
           
static int AggregateOperator
           
static int And
          Logical operators
static int Ascending
          Ordering operators
static int Ascii
           
static int Asin
           
static int Atan
           
static int Atan2
           
static int Average
           
static int Between
           
static int Ceil
           
static int CharIndex
           
static int CharLength
           
static int Chr
           
static int ComparisonOperator
           
static int Concat
           
static int Cos
           
static int Cosh
           
static int Cot
           
static int Count
          Aggregate operators
static int DateDifference
           
static int DateName
           
static int DatePart
           
static int DateToString
           
static int Decode
           
static int Deref
           
static int Descending
           
static int Difference
           
static int Distinct
           
static int Divide
           
static int Equal
          Comparison operators
static int EqualOuterJoin
           
static int Exists
           
static int Exp
           
static int Floor
           
static int FunctionOperator
           
static int GreaterThan
           
static int GreaterThanEqual
           
static int Greatest
           
static int HexToRaw
           
static int In
           
static int Initcap
           
static int Instring
           
static int IsNull
           
static int LastDay
           
static int Least
           
static int LeftPad
           
static int LeftTrim
           
static int Length
           
static int LessThan
           
static int LessThanEqual
           
static int Like
           
static int LikeEscape
           
static int Ln
           
static int Log
           
static int LogicalOperator
          Operator types
static int Maximum
           
static int Minimum
           
static int Mod
           
static int MonthsBetween
           
static int Multiply
           
static int NewTime
           
static int NextDay
           
static int Not
           
static int NotBetween
           
static int NotEqual
           
static int NotExists
           
static int NotIn
           
static int NotLike
           
static int NotNull
           
static int Nvl
           
static int Or
           
static int OrderOperator
           
static int Power
           
static int Ref
           
static int RefToHex
           
static int Replace
           
static int Replicate
           
static int Reverse
           
static int Right
           
static int RightPad
           
static int RightTrim
           
static int Round
           
static int RoundDate
           
static int Sign
           
static int Sin
           
static int Sinh
           
static int Soundex
           
static int Sqrt
           
static int StandardDeviation
           
static int Substring
           
static int Subtract
           
static int Sum
           
static int Tan
           
static int Tanh
           
static int ToDate
           
static int Today
           
static int ToLowerCase
           
static int ToNumber
           
static int ToUpperCase
          Function operators
static int Translate
           
static int Trim
           
static int Trunc
           
static int TruncateDate
           
static int Value
           
static int Variance
           
 
Constructor Summary
ExpressionOperator()
          ADVANCED: Create a new operator.
ExpressionOperator(int selector, java.util.Vector newDatabaseStrings)
          ADVANCED: Create a new operator with the given name(s) and strings to print.
 
Method Summary
TypeMethod
static void addOperator(ExpressionOperator exOperator)
          ADVANCED: Add an operator to the global list of operators.
 void bePostfix()
          ADVANCED: Tell the operator to be postfix, i.e.
 void bePrefix()
          ADVANCED: Tell the operator to be pretfix, i.e.
 boolean equals(java.lang.Object object)
          PUBLIC: Test for equality
static java.util.Hashtable getAllOperators()
          ADVANCED: Return the hashtable of all operators.
 int getType()
          ADVANCED: Return the type of function.
 boolean isAggregateOperator()
          Aggregate functions are function in the select such as COUNT.
 boolean isComparisonOperator()
          Comparison functions are functions such as = and >.
 boolean isFunctionOperator()
          General functions are any normal function such as UPPER.
 boolean isLogicalOperator()
          Logical functions are functions such as and and or.
 boolean isOrderOperator()
          Order functions are used in the order by such as ASC.
 boolean isPrefix()
          ADVANCED: Return true if this is a prefix operator.
 void printsAs(java.lang.String s)
          ADVANCED: Set the single string for this operator.
 void printsAs(java.util.Vector dbStrings)
          ADVANCED: Set the strings for this operator.
 void setArgumentIndices(int[] indices)
          ADVANCED: Set the array of indexes to use when building the SQL function.
 void setNodeClass(java.lang.Class nodeClass)
          ADVANCED: Set the node class for this operator.
 void setType(int type)
          ADVANCED: Set the type of function.
 java.lang.String toString()
          Print a debug representation of this operator.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LogicalOperator

public static final int LogicalOperator
Operator types

ComparisonOperator

public static final int ComparisonOperator

AggregateOperator

public static final int AggregateOperator

OrderOperator

public static final int OrderOperator

FunctionOperator

public static final int FunctionOperator

And

public static final int And
Logical operators

Or

public static final int Or

Not

public static final int Not

Equal

public static final int Equal
Comparison operators

NotEqual

public static final int NotEqual

EqualOuterJoin

public static final int EqualOuterJoin

LessThan

public static final int LessThan

LessThanEqual

public static final int LessThanEqual

GreaterThan

public static final int GreaterThan

GreaterThanEqual

public static final int GreaterThanEqual

Like

public static final int Like

NotLike

public static final int NotLike

In

public static final int In

NotIn

public static final int NotIn

Between

public static final int Between

NotBetween

public static final int NotBetween

IsNull

public static final int IsNull

NotNull

public static final int NotNull

Exists

public static final int Exists

NotExists

public static final int NotExists

LikeEscape

public static final int LikeEscape

Decode

public static final int Decode

Count

public static final int Count
Aggregate operators

Sum

public static final int Sum

Average

public static final int Average

Maximum

public static final int Maximum

Minimum

public static final int Minimum

StandardDeviation

public static final int StandardDeviation

Variance

public static final int Variance

Distinct

public static final int Distinct

Ascending

public static final int Ascending
Ordering operators

Descending

public static final int Descending

ToUpperCase

public static final int ToUpperCase
Function operators

ToLowerCase

public static final int ToLowerCase

Chr

public static final int Chr

Concat

public static final int Concat

HexToRaw

public static final int HexToRaw

Initcap

public static final int Initcap

Instring

public static final int Instring

Soundex

public static final int Soundex

LeftPad

public static final int LeftPad

LeftTrim

public static final int LeftTrim

Replace

public static final int Replace

RightPad

public static final int RightPad

RightTrim

public static final int RightTrim

Substring

public static final int Substring

ToNumber

public static final int ToNumber

Translate

public static final int Translate

Trim

public static final int Trim

Ascii

public static final int Ascii

Length

public static final int Length

CharIndex

public static final int CharIndex

CharLength

public static final int CharLength

Difference

public static final int Difference

Reverse

public static final int Reverse

Replicate

public static final int Replicate

Right

public static final int Right

AddMonths

public static final int AddMonths

DateToString

public static final int DateToString

LastDay

public static final int LastDay

MonthsBetween

public static final int MonthsBetween

NextDay

public static final int NextDay

RoundDate

public static final int RoundDate

ToDate

public static final int ToDate

Today

public static final int Today

AddDate

public static final int AddDate

DateName

public static final int DateName

DatePart

public static final int DatePart

DateDifference

public static final int DateDifference

TruncateDate

public static final int TruncateDate

NewTime

public static final int NewTime

Nvl

public static final int Nvl

Ceil

public static final int Ceil

Cos

public static final int Cos

Cosh

public static final int Cosh

Abs

public static final int Abs

Acos

public static final int Acos

Asin

public static final int Asin

Atan

public static final int Atan

Exp

public static final int Exp

Sqrt

public static final int Sqrt

Floor

public static final int Floor

Ln

public static final int Ln

Log

public static final int Log

Mod

public static final int Mod

Power

public static final int Power

Round

public static final int Round

Sign

public static final int Sign

Sin

public static final int Sin

Sinh

public static final int Sinh

Tan

public static final int Tan

Tanh

public static final int Tanh

Trunc

public static final int Trunc

Greatest

public static final int Greatest

Least

public static final int Least

Add

public static final int Add

Subtract

public static final int Subtract

Divide

public static final int Divide

Multiply

public static final int Multiply

Atan2

public static final int Atan2

Cot

public static final int Cot

Deref

public static final int Deref

Ref

public static final int Ref

RefToHex

public static final int RefToHex

Value

public static final int Value
Constructor Detail

ExpressionOperator

public ExpressionOperator()
ADVANCED: Create a new operator.

ExpressionOperator

public ExpressionOperator(int selector,
                          java.util.Vector newDatabaseStrings)
ADVANCED: Create a new operator with the given name(s) and strings to print.
Method Detail

addOperator

public static void addOperator(ExpressionOperator exOperator)
ADVANCED: Add an operator to the global list of operators.

bePostfix

public void bePostfix()
ADVANCED: Tell the operator to be postfix, i.e. its strings start printing after those of its first argument.

bePrefix

public void bePrefix()
ADVANCED: Tell the operator to be pretfix, i.e. its strings start printing before those of its first argument.

equals

public boolean equals(java.lang.Object object)
PUBLIC: Test for equality
Overrides:
equals in class java.lang.Object

getAllOperators

public static java.util.Hashtable getAllOperators()
ADVANCED: Return the hashtable of all operators.

getType

public int getType()
ADVANCED: Return the type of function. This must be one of the static function types defined in this class.

isAggregateOperator

public boolean isAggregateOperator()
Aggregate functions are function in the select such as COUNT.

isComparisonOperator

public boolean isComparisonOperator()
Comparison functions are functions such as = and >.

isFunctionOperator

public boolean isFunctionOperator()
General functions are any normal function such as UPPER.

isLogicalOperator

public boolean isLogicalOperator()
Logical functions are functions such as and and or.

isOrderOperator

public boolean isOrderOperator()
Order functions are used in the order by such as ASC.

isPrefix

public boolean isPrefix()
ADVANCED: Return true if this is a prefix operator.

printsAs

public void printsAs(java.lang.String s)
ADVANCED: Set the single string for this operator.

printsAs

public void printsAs(java.util.Vector dbStrings)
ADVANCED: Set the strings for this operator.

setArgumentIndices

public void setArgumentIndices(int[] indices)
ADVANCED: Set the array of indexes to use when building the SQL function.

setNodeClass

public void setNodeClass(java.lang.Class nodeClass)
ADVANCED: Set the node class for this operator. For user-defined functions this is normally FunctionExpression.class.

setType

public void setType(int type)
ADVANCED: Set the type of function. This must be one of the static function types defined in this class.

toString

public java.lang.String toString()
Print a debug representation of this operator.
Overrides:
toString in class java.lang.Object