ExpressionOperator (Oracle Application Server TopLink API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Application Server TopLink API Reference
10g (9.0.4.3)
B10491-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
`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`	`Case`
`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 selector and strings to print.

Method Summary
`static ExpressionOperator`	`abs()` INTERNAL: Build operator.
`static ExpressionOperator`	`acos()` INTERNAL: Build operator.
`static ExpressionOperator`	`addDate()` INTERNAL: Build operator.
`static ExpressionOperator`	`addMonths()` INTERNAL: Build operator.
`static void`	`addOperator(ExpressionOperator exOperator)` ADVANCED: Add an operator to the global list of operators.
`static ExpressionOperator`	`and()` INTERNAL: Create the AND operator.
`java.lang.Object`	`applyFunction(java.lang.Object source, java.util.Vector arguments)` INTERNAL: Apply this to an object in memory.
`static ExpressionOperator`	`ascending()` INTERNAL: Create the ASCENDING operator.
`static ExpressionOperator`	`ascii()` INTERNAL: Build operator.
`static ExpressionOperator`	`asin()` INTERNAL: Build operator.
`static ExpressionOperator`	`atan()` INTERNAL: Build operator.
`static ExpressionOperator`	`average()` INTERNAL: Create the AVERAGE operator.
`void`	`bePostfix()` ADVANCED: Tell the operator to be postfix, i.e. its strings start printing after those of its first argument.
`void`	`bePrefix()` ADVANCED: Tell the operator to be pretfix, i.e. its strings start printing before those of its first argument.
`void`	`beRepeating()` INTERNAL: Make this a repeating argument.
`static ExpressionOperator`	`between()` INTERNAL: Create the BETWEEN Operator
`static ExpressionOperator`	`caseStatement()` INTERNAL: Build operator.
`static ExpressionOperator`	`ceil()` INTERNAL: Build operator.
`static ExpressionOperator`	`charIndex()` INTERNAL: Build operator.
`static ExpressionOperator`	`charLength()` INTERNAL: Build operator.
`static ExpressionOperator`	`chr()` INTERNAL: Build operator.
`static ExpressionOperator`	`concat()` INTERNAL: Build operator.
`boolean`	`conformBetween(java.lang.Object left, java.lang.Object right)` INTERNAL: Compare bewteen in memory.
`boolean`	`conformLike(java.lang.Object left, java.lang.Object right)` INTERNAL: Compare like in memory.
`static ExpressionOperator`	`cos()` INTERNAL: Build operator.
`static ExpressionOperator`	`cosh()` INTERNAL: Build operator.
`static ExpressionOperator`	`cot()` INTERNAL: Build operator.
`static ExpressionOperator`	`count()` INTERNAL: Create the COUNT operator.
`static ExpressionOperator`	`dateDifference()` INTERNAL: Build operator.
`static ExpressionOperator`	`dateName()` INTERNAL: Build operator.
`static ExpressionOperator`	`datePart()` INTERNAL: Build operator.
`static ExpressionOperator`	`dateToString()` INTERNAL: Build operator.
`static ExpressionOperator`	`decode()` INTERNAL: Build operator.
`static ExpressionOperator`	`deref()` INTERNAL: Build operator.
`static ExpressionOperator`	`descending()` INTERNAL: Create the DESCENDING operator.
`static ExpressionOperator`	`difference()` INTERNAL: Build operator.
`static ExpressionOperator`	`distinct()` INTERNAL: Create the DISTINCT operator.
`boolean`	`doesRelationConform(java.lang.Object left, java.lang.Object right)` INTERNAL: Compare the values in memory.
`static ExpressionOperator`	`equalOuterJoin()` INTERNAL: Initialize the outer join operator Note: This is merely a shell which is incomplete, and so will be replaced by the platform's operator when we go to print.
`boolean`	`equals(java.lang.Object object)` PUBLIC: Test for equality
`static ExpressionOperator`	`exists()` INTERNAL: Create the EXISTS operator.
`static ExpressionOperator`	`exp()` INTERNAL: Build operator.
`Expression`	`expressionFor(Expression base)` INTERNAL: Create an expression for this operator, using the given base.
`Expression`	`expressionFor(Expression base, java.lang.Object value)` INTERNAL: Create an expression for this operator, using the given base and a single argument.
`Expression`	`expressionForArguments(Expression base, java.util.Vector arguments)` INTERNAL: Create an expression for this operator, using the given base and arguments.
`static ExpressionOperator`	`floor()` INTERNAL: Build operator.
`static java.util.Hashtable`	`getAllOperators()` ADVANCED: Return the hashtable of all operators.
`java.lang.String[]`	`getDatabaseStrings()` INTERNAL:
`static ExpressionOperator`	`getInverse(ExpressionOperator operator)` INTERNAL: Return the inverse of a given operator, if applicable e.g. for isNull return notNull.
`static java.util.Hashtable`	`getInverses()` INTERNAL: Return the hashtable mapping operators to their inverses.
`java.lang.Class`	`getNodeClass()` INTERNAL:
`static ExpressionOperator`	`getOperator(java.lang.Integer selector)` INTERNAL: Lookup the operator with the given name.
`int`	`getSelector()` INTERNAL: Return the selector id.
`int`	`getType()` ADVANCED: Return the type of function.
`static ExpressionOperator`	`greatest()` INTERNAL: Build operator.
`static ExpressionOperator`	`hexToRaw()` INTERNAL: Build operator.
`static ExpressionOperator`	`ifNull()` INTERNAL: Build operator.
`static ExpressionOperator`	`in()` INTERNAL: Create the IN operator.
`static ExpressionOperator`	`initcap()` INTERNAL: Build operator.
`static java.util.Hashtable`	`initializeOperators()` INTERNAL:
`static ExpressionOperator`	`instring()` INTERNAL: Build operator.
`boolean`	`isAggregateOperator()` Aggregate functions are function in the select such as COUNT.
`boolean`	`isComparisonOperator()` Comparison functions are functions such as = and >.
`boolean`	`isComplete()` INTERNAL: If we have all the required information, this operator is complete and can be used as is.
`boolean`	`isFunctionOperator()` General functions are any normal function such as UPPER.
`boolean`	`isLogicalOperator()` Logical functions are functions such as and and or.
`static ExpressionOperator`	`isNull()` INTERNAL: Create the ISNULL operator.
`boolean`	`isOrderOperator()` Order functions are used in the order by such as ASC.
`boolean`	`isPrefix()` ADVANCED: Return true if this is a prefix operator.
`static ExpressionOperator`	`lastDay()` INTERNAL: Build operator.
`static ExpressionOperator`	`least()` INTERNAL: Build operator.
`static ExpressionOperator`	`leftPad()` INTERNAL: Build operator.
`static ExpressionOperator`	`leftTrim()` INTERNAL: Build operator.
`static ExpressionOperator`	`length()` INTERNAL: Build operator.
`static ExpressionOperator`	`like()` INTERNAL: Create the LIKE operator.
`static ExpressionOperator`	`likeEscape()` INTERNAL: Create the LIKE operator.
`static ExpressionOperator`	`ln()` INTERNAL: Build operator.
`static ExpressionOperator`	`log()` INTERNAL: Build operator.
`static ExpressionOperator`	`maximum()` INTERNAL: Create the MAXIMUM operator.
`static ExpressionOperator`	`minimum()` INTERNAL: Create the MINIMUM operator.
`static ExpressionOperator`	`mod()` INTERNAL: Build operator.
`static ExpressionOperator`	`monthsBetween()` INTERNAL: Build operator.
`Expression`	`newExpressionForArgument(Expression base, java.lang.Object singleArgument)` INTERNAL: Create a new expression.
`Expression`	`newExpressionForArguments(Expression base, java.util.Vector arguments)` INTERNAL: The general case.
`static ExpressionOperator`	`newTime()` INTERNAL: Build operator.
`static ExpressionOperator`	`nextDay()` INTERNAL: Build operator.
`ExpressionOperator`	`not()` INTERNAL: Return the opposite of this operator
`static ExpressionOperator`	`notExists()` INTERNAL: Create the NOT EXISTS operator.
`static ExpressionOperator`	`notIn()` INTERNAL: Create the NOTIN operator.
`static ExpressionOperator`	`notLike()` INTERNAL: Create the NOTLIKE operator.
`static ExpressionOperator`	`notNull()` INTERNAL: Create the NOTNULL operator.
`static ExpressionOperator`	`notOperator()` INTERNAL: Create the NOT operator.
`static ExpressionOperator`	`or()` INTERNAL: Create the OR operator.
`static ExpressionOperator`	`power()` INTERNAL: Build operator.
`void`	`printCollection(java.util.Vector items, oracle.toplink.internal.expressions.ExpressionSQLPrinter printer)` INTERNAL: Print the collection onto the SQL stream.
`void`	`printDuo(Expression first, Expression second, oracle.toplink.internal.expressions.ExpressionSQLPrinter printer)` INTERNAL: For performance, special case printing two children, since it's by far the most common
`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.
`static ExpressionOperator`	`ref()` INTERNAL: Build operator.
`static ExpressionOperator`	`refToHex()` INTERNAL: Build operator.
`static ExpressionOperator`	`replace()` INTERNAL: Build operator.
`static ExpressionOperator`	`replicate()` INTERNAL: Build operator.
`boolean`	`representsEqualToNull(java.lang.Object singleArgument)` INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.
`boolean`	`representsEqualToNull(java.util.Vector arguments)` INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.
`boolean`	`representsNotEqualToNull(java.lang.Object singleArgument)` INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.
`boolean`	`representsNotEqualToNull(java.util.Vector arguments)` INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.
`static void`	`resetOperators()` INTERNAL: Reset all the operators.
`static ExpressionOperator`	`reverse()` INTERNAL: Build operator.
`static ExpressionOperator`	`right()` INTERNAL: Build operator.
`static ExpressionOperator`	`rightPad()` INTERNAL: Build operator.
`static ExpressionOperator`	`rightTrim()` INTERNAL: Build operator.
`static ExpressionOperator`	`round()` INTERNAL: Build operator.
`static ExpressionOperator`	`roundDate()` INTERNAL: Build operator.
`void`	`setArgumentIndices(int[] indices)` ADVANCED: Sets the ordering of arguments to use when building the SQL function.
`void`	`setNodeClass(java.lang.Class nodeClass)` ADVANCED: Set the node class for this operator.
`void`	`setSelector(int selector)` ADVANCED: Sets the unique identifier.
`void`	`setType(int type)` ADVANCED: Set the type of function.
`static ExpressionOperator`	`sign()` INTERNAL: Build operator.
`static ExpressionOperator`	`simpleAggregate(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple aggregate given a Java name and a single String for the database (parentheses will be added automatically).
`static ExpressionOperator`	`simpleFunction(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple function given a Java name and a single String for the database (parentheses will be added automatically).
`static ExpressionOperator`	`simpleLogical(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple logical given a Java name and a single String for the database (parentheses will be added automatically).
`static ExpressionOperator`	`simpleLogicalNoParens(int selector, java.lang.String dbString)` INTERNAL: e.g.: ...
`static ExpressionOperator`	`simpleMath(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple math operatin, i.e. +, -, *, /
`static ExpressionOperator`	`simpleOrdering(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple ordering given a Java name and a single String for the database (parentheses will be added automatically).
`static ExpressionOperator`	`simpleRelation(int selector, java.lang.String databaseName)` INTERNAL: Create an operator for a simple relation given a Java name and a single String for the database (parentheses will be added automatically).
`static ExpressionOperator`	`simpleThreeArgumentFunction(int selector, java.lang.String dbString)` INTERNAL: Build operator.
`static ExpressionOperator`	`simpleTwoArgumentFunction(int selector, java.lang.String dbString)` INTERNAL: Build operator.
`static ExpressionOperator`	`sin()` INTERNAL: Build operator.
`static ExpressionOperator`	`sinh()` INTERNAL: Build operator.
`static ExpressionOperator`	`soundex()` INTERNAL: Build operator.
`static ExpressionOperator`	`sqrt()` INTERNAL: Build operator.
`static ExpressionOperator`	`standardDeviation()` INTERNAL: Build operator.
`static ExpressionOperator`	`substring()` INTERNAL: Build operator.
`static ExpressionOperator`	`sum()` INTERNAL: Create the SUM operator.
`static ExpressionOperator`	`sybaseAddMonthsOperator()` INTERNAL: Function, to add months to a date.
`static ExpressionOperator`	`sybaseAtan2Operator()` INTERNAL: Build operator.
`static ExpressionOperator`	`sybaseInStringOperator()` INTERNAL: Build instring operator
`static ExpressionOperator`	`tan()` INTERNAL: Build operator.
`static ExpressionOperator`	`tanh()` INTERNAL: Build operator.
`static ExpressionOperator`	`toDate()` INTERNAL: Build operator.
`static ExpressionOperator`	`today()` INTERNAL: Build operator.
`static ExpressionOperator`	`toLowerCase()` INTERNAL: Create the toLowerCase operator.
`static ExpressionOperator`	`toNumber()` INTERNAL: Build operator.
`java.lang.String`	`toString()` Print a debug representation of this operator.
`static ExpressionOperator`	`toUpperCase()` INTERNAL: Create the TOUPPERCASE operator.
`static ExpressionOperator`	`translate()` INTERNAL: Build operator.
`static ExpressionOperator`	`trim()` INTERNAL: Build operator.
`static ExpressionOperator`	`trunc()` INTERNAL: Build operator.
`static ExpressionOperator`	`truncateDate()` INTERNAL: Build operator.
`static ExpressionOperator`	`value()` INTERNAL: Build operator.
`static ExpressionOperator`	`variance()` INTERNAL: Build 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

See Also:: Constant Field Values

ComparisonOperator

public static final int ComparisonOperator

See Also:: Constant Field Values

AggregateOperator

public static final int AggregateOperator

See Also:: Constant Field Values

OrderOperator

public static final int OrderOperator

See Also:: Constant Field Values

FunctionOperator

public static final int FunctionOperator

See Also:: Constant Field Values

And

public static final int And

Logical operators

See Also:: Constant Field Values

Or

public static final int Or

See Also:: Constant Field Values

Not

public static final int Not

See Also:: Constant Field Values

Equal

public static final int Equal

Comparison operators

See Also:: Constant Field Values

NotEqual

public static final int NotEqual

See Also:: Constant Field Values

EqualOuterJoin

public static final int EqualOuterJoin

See Also:: Constant Field Values

LessThan

public static final int LessThan

See Also:: Constant Field Values

LessThanEqual

public static final int LessThanEqual

See Also:: Constant Field Values

GreaterThan

public static final int GreaterThan

See Also:: Constant Field Values

GreaterThanEqual

public static final int GreaterThanEqual

See Also:: Constant Field Values

Like

public static final int Like

See Also:: Constant Field Values

NotLike

public static final int NotLike

See Also:: Constant Field Values

In

public static final int In

See Also:: Constant Field Values

NotIn

public static final int NotIn

See Also:: Constant Field Values

Between

public static final int Between

See Also:: Constant Field Values

NotBetween

public static final int NotBetween

See Also:: Constant Field Values

IsNull

public static final int IsNull

See Also:: Constant Field Values

NotNull

public static final int NotNull

See Also:: Constant Field Values

Exists

public static final int Exists

See Also:: Constant Field Values

NotExists

public static final int NotExists

See Also:: Constant Field Values

LikeEscape

public static final int LikeEscape

See Also:: Constant Field Values

Decode

public static final int Decode

See Also:: Constant Field Values

Case

public static final int Case

See Also:: Constant Field Values

Count

public static final int Count

Aggregate operators

See Also:: Constant Field Values

Sum

public static final int Sum

See Also:: Constant Field Values

Average

public static final int Average

See Also:: Constant Field Values

Maximum

public static final int Maximum

See Also:: Constant Field Values

Minimum

public static final int Minimum

See Also:: Constant Field Values

StandardDeviation

public static final int StandardDeviation

See Also:: Constant Field Values

Variance

public static final int Variance

See Also:: Constant Field Values

Distinct

public static final int Distinct

See Also:: Constant Field Values

Ascending

public static final int Ascending

Ordering operators

See Also:: Constant Field Values

Descending

public static final int Descending

See Also:: Constant Field Values

ToUpperCase

public static final int ToUpperCase

Function operators

See Also:: Constant Field Values

ToLowerCase

public static final int ToLowerCase

See Also:: Constant Field Values

Chr

public static final int Chr

See Also:: Constant Field Values

Concat

public static final int Concat

See Also:: Constant Field Values

HexToRaw

public static final int HexToRaw

See Also:: Constant Field Values

Initcap

public static final int Initcap

See Also:: Constant Field Values

Instring

public static final int Instring

See Also:: Constant Field Values

Soundex

public static final int Soundex

See Also:: Constant Field Values

LeftPad

public static final int LeftPad

See Also:: Constant Field Values

LeftTrim

public static final int LeftTrim

See Also:: Constant Field Values

Replace

public static final int Replace

See Also:: Constant Field Values

RightPad

public static final int RightPad

See Also:: Constant Field Values

RightTrim

public static final int RightTrim

See Also:: Constant Field Values

Substring

public static final int Substring

See Also:: Constant Field Values

ToNumber

public static final int ToNumber

See Also:: Constant Field Values

Translate

public static final int Translate

See Also:: Constant Field Values

Trim

public static final int Trim

See Also:: Constant Field Values

Ascii

public static final int Ascii

See Also:: Constant Field Values

Length

public static final int Length

See Also:: Constant Field Values

CharIndex

public static final int CharIndex

See Also:: Constant Field Values

CharLength

public static final int CharLength

See Also:: Constant Field Values

Difference

public static final int Difference

See Also:: Constant Field Values

Reverse

public static final int Reverse

See Also:: Constant Field Values

Replicate

public static final int Replicate

See Also:: Constant Field Values

Right

public static final int Right

See Also:: Constant Field Values

AddMonths

public static final int AddMonths

See Also:: Constant Field Values

DateToString

public static final int DateToString

See Also:: Constant Field Values

LastDay

public static final int LastDay

See Also:: Constant Field Values

MonthsBetween

public static final int MonthsBetween

See Also:: Constant Field Values

NextDay

public static final int NextDay

See Also:: Constant Field Values

RoundDate

public static final int RoundDate

See Also:: Constant Field Values

ToDate

public static final int ToDate

See Also:: Constant Field Values

Today

public static final int Today

See Also:: Constant Field Values

AddDate

public static final int AddDate

See Also:: Constant Field Values

DateName

public static final int DateName

See Also:: Constant Field Values

DatePart

public static final int DatePart

See Also:: Constant Field Values

DateDifference

public static final int DateDifference

See Also:: Constant Field Values

TruncateDate

public static final int TruncateDate

See Also:: Constant Field Values

NewTime

public static final int NewTime

See Also:: Constant Field Values

Nvl

public static final int Nvl

See Also:: Constant Field Values

Ceil

public static final int Ceil

See Also:: Constant Field Values

Cos

public static final int Cos

See Also:: Constant Field Values

Cosh

public static final int Cosh

See Also:: Constant Field Values

Abs

public static final int Abs

See Also:: Constant Field Values

Acos

public static final int Acos

See Also:: Constant Field Values

Asin

public static final int Asin

See Also:: Constant Field Values

Atan

public static final int Atan

See Also:: Constant Field Values

Exp

public static final int Exp

See Also:: Constant Field Values

Sqrt

public static final int Sqrt

See Also:: Constant Field Values

Floor

public static final int Floor

See Also:: Constant Field Values

Ln

public static final int Ln

See Also:: Constant Field Values

Log

public static final int Log

See Also:: Constant Field Values

Mod

public static final int Mod

See Also:: Constant Field Values

Power

public static final int Power

See Also:: Constant Field Values

Round

public static final int Round

See Also:: Constant Field Values

Sign

public static final int Sign

See Also:: Constant Field Values

Sin

public static final int Sin

See Also:: Constant Field Values

Sinh

public static final int Sinh

See Also:: Constant Field Values

Tan

public static final int Tan

See Also:: Constant Field Values

Tanh

public static final int Tanh

See Also:: Constant Field Values

Trunc

public static final int Trunc

See Also:: Constant Field Values

Greatest

public static final int Greatest

See Also:: Constant Field Values

Least

public static final int Least

See Also:: Constant Field Values

Add

public static final int Add

See Also:: Constant Field Values

Subtract

public static final int Subtract

See Also:: Constant Field Values

Divide

public static final int Divide

See Also:: Constant Field Values

Multiply

public static final int Multiply

See Also:: Constant Field Values

Atan2

public static final int Atan2

See Also:: Constant Field Values

Cot

public static final int Cot

See Also:: Constant Field Values

Deref

public static final int Deref

See Also:: Constant Field Values

Ref

public static final int Ref

See Also:: Constant Field Values

RefToHex

public static final int RefToHex

See Also:: Constant Field Values

Value

public static final int Value

See Also:: Constant Field Values

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 selector and strings to print.

Method Detail

abs

public static ExpressionOperator abs()

INTERNAL: Build operator.

acos

public static ExpressionOperator acos()

INTERNAL: Build operator.

addDate

public static ExpressionOperator addDate()

INTERNAL: Build operator.

addMonths

public static ExpressionOperator addMonths()

INTERNAL: Build operator.

addOperator

public static void addOperator(ExpressionOperator exOperator)

ADVANCED: Add an operator to the global list of operators.

and

public static ExpressionOperator and()

INTERNAL: Create the AND operator.

applyFunction

public java.lang.Object applyFunction(java.lang.Object source,
                                      java.util.Vector arguments)

INTERNAL: Apply this to an object in memory. Throw an error if the function is not supported.

ascending

public static ExpressionOperator ascending()

INTERNAL: Create the ASCENDING operator.

ascii

public static ExpressionOperator ascii()

INTERNAL: Build operator.

asin

public static ExpressionOperator asin()

INTERNAL: Build operator.

atan

public static ExpressionOperator atan()

INTERNAL: Build operator.

average

public static ExpressionOperator average()

INTERNAL: Create the AVERAGE operator.

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.

beRepeating

public void beRepeating()

INTERNAL: Make this a repeating argument. Currently unused.

between

public static ExpressionOperator between()

INTERNAL: Create the BETWEEN Operator

caseStatement

public static ExpressionOperator caseStatement()

INTERNAL: Build operator. Note: This operator works differently from other operators.

See Also:: Expression.caseStatement()

ceil

public static ExpressionOperator ceil()

INTERNAL: Build operator.

charIndex

public static ExpressionOperator charIndex()

INTERNAL: Build operator.

charLength

public static ExpressionOperator charLength()

INTERNAL: Build operator.

chr

public static ExpressionOperator chr()

INTERNAL: Build operator.

concat

public static ExpressionOperator concat()

INTERNAL: Build operator.

conformBetween

public boolean conformBetween(java.lang.Object left,
                              java.lang.Object right)

INTERNAL: Compare bewteen in memory.

conformLike

public boolean conformLike(java.lang.Object left,
                           java.lang.Object right)

INTERNAL: Compare like in memory. This only works for % not _.

cos

public static ExpressionOperator cos()

INTERNAL: Build operator.

cosh

public static ExpressionOperator cosh()

INTERNAL: Build operator.

cot

public static ExpressionOperator cot()

INTERNAL: Build operator.

count

public static ExpressionOperator count()

INTERNAL: Create the COUNT operator.

dateDifference

public static ExpressionOperator dateDifference()

INTERNAL: Build operator.

dateName

public static ExpressionOperator dateName()

INTERNAL: Build operator.

datePart

public static ExpressionOperator datePart()

INTERNAL: Build operator.

dateToString

public static ExpressionOperator dateToString()

INTERNAL: Build operator.

decode

public static ExpressionOperator decode()

INTERNAL: Build operator. Note: This operator works differently from other operators.

See Also:: Expression.decode()

deref

public static ExpressionOperator deref()

INTERNAL: Build operator.

descending

public static ExpressionOperator descending()

INTERNAL: Create the DESCENDING operator.

difference

public static ExpressionOperator difference()

INTERNAL: Build operator.

distinct

public static ExpressionOperator distinct()

INTERNAL: Create the DISTINCT operator.

doesRelationConform

public boolean doesRelationConform(java.lang.Object left,
                                   java.lang.Object right)

INTERNAL: Compare the values in memory. Used for in-memory querying, all operators are not support.

equalOuterJoin

public static ExpressionOperator equalOuterJoin()

INTERNAL: Initialize the outer join operator Note: This is merely a shell which is incomplete, and so will be replaced by the platform's operator when we go to print. We need to create this here so that the expression class is correct, normally it assumes functions for unknown operators.

equals

public boolean equals(java.lang.Object object)

PUBLIC: Test for equality

exists

public static ExpressionOperator exists()

INTERNAL: Create the EXISTS operator.

exp

public static ExpressionOperator exp()

INTERNAL: Build operator.

expressionFor

public Expression expressionFor(Expression base)

INTERNAL: Create an expression for this operator, using the given base.

expressionFor

public Expression expressionFor(Expression base,
                                java.lang.Object value)

INTERNAL: Create an expression for this operator, using the given base and a single argument.

expressionForArguments

public Expression expressionForArguments(Expression base,
                                         java.util.Vector arguments)

INTERNAL: Create an expression for this operator, using the given base and arguments.

floor

public static ExpressionOperator floor()

INTERNAL: Build operator.

getAllOperators

public static java.util.Hashtable getAllOperators()

ADVANCED: Return the hashtable of all operators.

getDatabaseStrings

public java.lang.String[] getDatabaseStrings()

INTERNAL:

getInverse

public static ExpressionOperator getInverse(ExpressionOperator operator)

INTERNAL: Return the inverse of a given operator, if applicable e.g. for isNull return notNull. Used in the implementation of the NOT operator, since it's not always enough to just add a NOT in the SQL.

getInverses

public static java.util.Hashtable getInverses()

INTERNAL: Return the hashtable mapping operators to their inverses.

getNodeClass

public java.lang.Class getNodeClass()

INTERNAL:

getOperator

public static ExpressionOperator getOperator(java.lang.Integer selector)

INTERNAL: Lookup the operator with the given name.

getSelector

public int getSelector()

INTERNAL: Return the selector id.

getType

public int getType()

ADVANCED: Return the type of function. This must be one of the static function types defined in this class.

greatest

public static ExpressionOperator greatest()

INTERNAL: Build operator.

hexToRaw

public static ExpressionOperator hexToRaw()

INTERNAL: Build operator.

ifNull

public static ExpressionOperator ifNull()

INTERNAL: Build operator.

in

public static ExpressionOperator in()

INTERNAL: Create the IN operator.

initcap

public static ExpressionOperator initcap()

INTERNAL: Build operator.

initializeOperators

public static java.util.Hashtable initializeOperators()

INTERNAL:

instring

public static ExpressionOperator instring()

INTERNAL: Build operator.

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

isComplete

public boolean isComplete()

INTERNAL: If we have all the required information, this operator is complete and can be used as is. Otherwise we will need to look up a platform- specific operator.

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.

isNull

public static ExpressionOperator isNull()

INTERNAL: Create the ISNULL operator.

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.

lastDay

public static ExpressionOperator lastDay()

INTERNAL: Build operator.

least

public static ExpressionOperator least()

INTERNAL: Build operator.

leftPad

public static ExpressionOperator leftPad()

INTERNAL: Build operator.

leftTrim

public static ExpressionOperator leftTrim()

INTERNAL: Build operator.

length

public static ExpressionOperator length()

INTERNAL: Build operator.

like

public static ExpressionOperator like()

INTERNAL: Create the LIKE operator.

likeEscape

public static ExpressionOperator likeEscape()

INTERNAL: Create the LIKE operator.

ln

public static ExpressionOperator ln()

INTERNAL: Build operator.

log

public static ExpressionOperator log()

INTERNAL: Build operator.

maximum

public static ExpressionOperator maximum()

INTERNAL: Create the MAXIMUM operator.

minimum

public static ExpressionOperator minimum()

INTERNAL: Create the MINIMUM operator.

mod

public static ExpressionOperator mod()

INTERNAL: Build operator.

monthsBetween

public static ExpressionOperator monthsBetween()

INTERNAL: Build operator.

newExpressionForArgument

public Expression newExpressionForArgument(Expression base,
                                           java.lang.Object singleArgument)

INTERNAL: Create a new expression. Optimized for the single argument case.

newExpressionForArguments

public Expression newExpressionForArguments(Expression base,
                                            java.util.Vector arguments)

INTERNAL: The general case.

newTime

public static ExpressionOperator newTime()

INTERNAL: Build operator.

nextDay

public static ExpressionOperator nextDay()

INTERNAL: Build operator.

not

public ExpressionOperator not()

INTERNAL: Return the opposite of this operator

notExists

public static ExpressionOperator notExists()

INTERNAL: Create the NOT EXISTS operator.

notIn

public static ExpressionOperator notIn()

INTERNAL: Create the NOTIN operator.

notLike

public static ExpressionOperator notLike()

INTERNAL: Create the NOTLIKE operator.

notNull

public static ExpressionOperator notNull()

INTERNAL: Create the NOTNULL operator.

notOperator

public static ExpressionOperator notOperator()

INTERNAL: Create the NOT operator.

or

public static ExpressionOperator or()

INTERNAL: Create the OR operator.

power

public static ExpressionOperator power()

INTERNAL: Build operator.

printCollection

public void printCollection(java.util.Vector items,
                            oracle.toplink.internal.expressions.ExpressionSQLPrinter printer)

INTERNAL: Print the collection onto the SQL stream.

printDuo

public void printDuo(Expression first,
Expression second,
                     oracle.toplink.internal.expressions.ExpressionSQLPrinter printer)

INTERNAL: For performance, special case printing two children, since it's by far the most common

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.

ref

public static ExpressionOperator ref()

INTERNAL: Build operator.

refToHex

public static ExpressionOperator refToHex()

INTERNAL: Build operator.

replace

public static ExpressionOperator replace()

INTERNAL: Build operator.

replicate

public static ExpressionOperator replicate()

INTERNAL: Build operator.

representsEqualToNull

public boolean representsEqualToNull(java.lang.Object singleArgument)

INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially. Also special-cased for performance.

representsEqualToNull

public boolean representsEqualToNull(java.util.Vector arguments)

INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.

representsNotEqualToNull

public boolean representsNotEqualToNull(java.lang.Object singleArgument)

INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially. Also special-cased for performance.

representsNotEqualToNull

public boolean representsNotEqualToNull(java.util.Vector arguments)

INTERNAL: Test if this operator instance represents a comparison to null, which we have to print specially.

resetOperators

public static void resetOperators()

INTERNAL: Reset all the operators.

reverse

public static ExpressionOperator reverse()

INTERNAL: Build operator.

right

public static ExpressionOperator right()

INTERNAL: Build operator.

rightPad

public static ExpressionOperator rightPad()

INTERNAL: Build operator.

rightTrim

public static ExpressionOperator rightTrim()

INTERNAL: Build operator.

round

public static ExpressionOperator round()

INTERNAL: Build operator.

roundDate

public static ExpressionOperator roundDate()

INTERNAL: Build operator.

setArgumentIndices

public void setArgumentIndices(int[] indices)

ADVANCED: Sets the ordering of arguments to use when building the SQL function.

If you have an expression of the form emp.get("firstName").getFunction(MyFunctions.LOCATE, args) the underlying field F_NAME will itself be an argument, and by default will appear first. One use of this method could be to make it appear second or last.

Parameters:: indices - length equal to number of arguments plus one, and values a permutation of 0, 1, ..., length - 1.

setNodeClass

public void setNodeClass(java.lang.Class nodeClass)

ADVANCED: Set the node class for this operator. For user-defined functions this is set automatically.

setSelector

public void setSelector(int selector)

ADVANCED: Sets the unique identifier.

Once a call to addOperator is made this unique id is used to access this operator. The values from 0 to 200 are reserved for predefined operators like between or greaterThan.

See Also:: Expression.getFunction(int)

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, and by default is ExpressionOperator.FunctionOperator.

sign

public static ExpressionOperator sign()

INTERNAL: Build operator.

simpleAggregate

public static ExpressionOperator simpleAggregate(int selector,
                                                 java.lang.String databaseName)

INTERNAL: Create an operator for a simple aggregate given a Java name and a single String for the database (parentheses will be added automatically).

simpleFunction

public static ExpressionOperator simpleFunction(int selector,
                                                java.lang.String databaseName)

INTERNAL: Create an operator for a simple function given a Java name and a single String for the database (parentheses will be added automatically).

simpleLogical

public static ExpressionOperator simpleLogical(int selector,
                                               java.lang.String databaseName)

INTERNAL: Create an operator for a simple logical given a Java name and a single String for the database (parentheses will be added automatically).

simpleMath

public static ExpressionOperator simpleMath(int selector,
                                            java.lang.String databaseName)

INTERNAL: Create an operator for a simple math operatin, i.e. +, -, *, /

simpleOrdering

public static ExpressionOperator simpleOrdering(int selector,
                                                java.lang.String databaseName)

INTERNAL: Create an operator for a simple ordering given a Java name and a single String for the database (parentheses will be added automatically).

simpleRelation

public static ExpressionOperator simpleRelation(int selector,
                                                java.lang.String databaseName)

INTERNAL: Create an operator for a simple relation given a Java name and a single String for the database (parentheses will be added automatically).

simpleThreeArgumentFunction

public static ExpressionOperator simpleThreeArgumentFunction(int selector,
                                                             java.lang.String dbString)

INTERNAL: Build operator.

simpleTwoArgumentFunction

public static ExpressionOperator simpleTwoArgumentFunction(int selector,
                                                           java.lang.String dbString)

INTERNAL: Build operator.

simpleLogicalNoParens

public static ExpressionOperator simpleLogicalNoParens(int selector,
                                                       java.lang.String dbString)

INTERNAL: e.g.: ... "Bob" CONCAT "Smith" ... Parentheses will not be addded. [RMB - March 5 2000]

sin

public static ExpressionOperator sin()

INTERNAL: Build operator.

sinh

public static ExpressionOperator sinh()

INTERNAL: Build operator.

soundex

public static ExpressionOperator soundex()

INTERNAL: Build operator.

sqrt

public static ExpressionOperator sqrt()

INTERNAL: Build operator.

standardDeviation

public static ExpressionOperator standardDeviation()

INTERNAL: Build operator.

substring

public static ExpressionOperator substring()

INTERNAL: Build operator.

sum

public static ExpressionOperator sum()

INTERNAL: Create the SUM operator.

sybaseAddMonthsOperator

public static ExpressionOperator sybaseAddMonthsOperator()

INTERNAL: Function, to add months to a date.

sybaseAtan2Operator

public static ExpressionOperator sybaseAtan2Operator()

INTERNAL: Build operator.

sybaseInStringOperator

public static ExpressionOperator sybaseInStringOperator()

INTERNAL: Build instring operator

tan

public static ExpressionOperator tan()

INTERNAL: Build operator.

tanh

public static ExpressionOperator tanh()

INTERNAL: Build operator.

toDate

public static ExpressionOperator toDate()

INTERNAL: Build operator.

today

public static ExpressionOperator today()

INTERNAL: Build operator.

toLowerCase

public static ExpressionOperator toLowerCase()

INTERNAL: Create the toLowerCase operator.

toNumber

public static ExpressionOperator toNumber()

INTERNAL: Build operator.

toString

public java.lang.String toString()

Print a debug representation of this operator.

toUpperCase

public static ExpressionOperator toUpperCase()

INTERNAL: Create the TOUPPERCASE operator.

translate

public static ExpressionOperator translate()

INTERNAL: Build operator.

trim

public static ExpressionOperator trim()

INTERNAL: Build operator.

trunc

public static ExpressionOperator trunc()

INTERNAL: Build operator.

truncateDate

public static ExpressionOperator truncateDate()

INTERNAL: Build operator.

value

public static ExpressionOperator value()

INTERNAL: Build operator.

variance

public static ExpressionOperator variance()

INTERNAL: Build operator.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.toplink.expressions Class ExpressionOperator

LogicalOperator

ComparisonOperator

AggregateOperator

OrderOperator

FunctionOperator

And

Or

Not

Equal

NotEqual

EqualOuterJoin

LessThan

LessThanEqual

GreaterThan

GreaterThanEqual

Like

NotLike

In

NotIn

Between

NotBetween

IsNull

NotNull

Exists

NotExists

LikeEscape

Decode

Case

Count

Sum

Average

Maximum

Minimum

StandardDeviation

Variance

Distinct

Ascending

Descending

ToUpperCase

ToLowerCase

Chr

Concat

HexToRaw

Initcap

Instring

Soundex

LeftPad

LeftTrim

Replace

RightPad

RightTrim

Substring

ToNumber

Translate

Trim

Ascii

Length

CharIndex

CharLength

Difference

Reverse

Replicate

Right

AddMonths

DateToString

LastDay

MonthsBetween

NextDay

RoundDate

ToDate

Today

AddDate

DateName

DatePart

DateDifference

TruncateDate

NewTime

Nvl

Ceil

oracle.toplink.expressions
Class ExpressionOperator