EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.expressions
Class ListExpressionOperator

java.lang.Object
  extended by org.eclipse.persistence.expressions.ExpressionOperator
      extended by org.eclipse.persistence.expressions.ListExpressionOperator
All Implemented Interfaces:
java.io.Serializable

public class ListExpressionOperator
extends ExpressionOperator

INTERNAL: A ListExpressionOperator is used with an ArgumentListFunctionExpression. It is capable of expanding the number of arguments it can be an operator for. It is built from a set of start strings, a repeating set of separators and a set of termination strings It typically represents a database function that has a variable list of arguments e.g. COALESCE(arg1, arg2, arg3, .... argn) In the example above "COALESCE(" is the start string, "," is the separator and ")" is the end string

See Also:
ArgumentListFunctionExpression, Expression.coalesece(), Serialized Form
Author:
tware

Field Summary
protected  boolean isComplete
           
protected  int numberOfItems
           
protected  java.lang.String[] separators
           
protected  java.lang.String[] startStrings
           
protected  java.lang.String[] terminationStrings
           
 
Fields inherited from class org.eclipse.persistence.expressions.ExpressionOperator
Abs, Acos, Add, AddDate, AddMonths, AggregateOperator, All, allOperators, And, Any, argumentIndices, Ascending, Ascii, Asin, Atan, Atan2, Average, Between, Case, CaseCondition, Ceil, CharIndex, CharLength, Chr, Coalesce, ComparisonOperator, Concat, Cos, Cosh, Cot, Count, CurrentDate, CurrentTime, databaseStrings, DateDifference, DateName, DatePart, DateToString, Decode, Deref, Descending, Difference, Distinct, Divide, Equal, EqualOuterJoin, Exists, ExistsNode, Exp, Extract, ExtractValue, Floor, FunctionOperator, GetNumberVal, GetStringVal, GreaterThan, GreaterThanEqual, Greatest, HexToRaw, In, Initcap, Instring, InSubQuery, isBindingSupported, IsFragment, IsNull, isPrefix, isRepeating, javaStrings, LastDay, Least, LeftPad, LeftTrim, LeftTrim2, Length, LessThan, LessThanEqual, Like, LikeEscape, Ln, Locate, Locate2, Log, LogicalOperator, Maximum, Minimum, Mod, MonthsBetween, Multiply, Negate, NewTime, NextDay, nodeClass, Not, NotBetween, NotEqual, NotExists, NotIn, NotInSubQuery, NotLike, NotLikeEscape, NotNull, NullIf, Nvl, Or, OrderOperator, platformOperatorNames, Power, Ref, RefToHex, Replace, Replicate, Reverse, Right, RightPad, RightTrim, RightTrim2, Round, RoundDate, SDO_FILTER, SDO_NN, SDO_RELATE, SDO_WITHIN_DISTANCE, selector, Sign, Sin, Sinh, Some, Soundex, Sqrt, StandardDeviation, Substring, SubstringSingleArg, Subtract, Sum, Tan, Tanh, ToChar, ToCharWithFormat, ToDate, Today, ToLowerCase, ToNumber, ToUpperCase, Translate, Trim, Trim2, Trunc, TruncateDate, type, Value, Variance
 
Constructor Summary
ListExpressionOperator()
           
 
Method Summary
 void copyTo(ExpressionOperator operator)
           
 java.lang.String[] getDatabaseStrings()
          INTERNAL: Recalculate the database strings each time this is called in case one has been added.
 int getNumberOfItems()
           
 java.lang.String[] getSeparators()
           
 java.lang.String[] getStartStrings()
           
 java.lang.String[] getTerminationStrings()
           
 void incrementNumberOfItems()
           
 boolean isComplete()
          INTERNAL: If we have all the required information, this operator is complete and can be used as is.
 void setIsComplete(boolean isComplete)
           
 void setNumberOfItems(int numberOfItems)
           
 void setSeparator(java.lang.String separator)
           
 void setSeparators(java.lang.String[] separators)
           
 void setStartString(java.lang.String startString)
           
 void setStartStrings(java.lang.String[] startStrings)
           
 void setTerminationString(java.lang.String terminationString)
           
 void setTerminationStrings(java.lang.String[] terminationStrings)
           
 
Methods inherited from class org.eclipse.persistence.expressions.ExpressionOperator
abs, acos, addDate, addMonths, addOperator, all, and, any, applyFunction, ascending, ascii, asin, atan, average, bePostfix, bePrefix, beRepeating, between, caseConditionStatement, caseStatement, ceil, charIndex, charLength, chr, coalesce, concat, conformBetween, conformLike, cos, cosh, cot, count, createNode, currentDate, currentTime, currentTimeStamp, dateDifference, dateName, datePart, dateToString, decode, deref, descending, difference, distinct, doesRelationConform, equalOuterJoin, equals, exists, existsNode, exp, expressionFor, expressionFor, expressionForArguments, expressionForWithBaseLast, extract, extractValue, floor, getAllOperators, getJavaStrings, getNodeClass, getNumberVal, getOperator, getPlatformOperatorName, getPlatformOperatorNames, getSelector, getStringVal, getType, greatest, hashCode, hexToRaw, ifNull, in, initcap, initializeAggregateFunctionOperators, initializeFunctionOperators, initializeLogicalOperators, initializeOperators, initializePlatformOperatorNames, initializeRelationOperators, instring, inSubQuery, isAggregateOperator, isAll, isAny, isAnyOrAll, isBindingSupported, isComparisonOperator, isFragment, isFunctionOperator, isLogicalOperator, isNull, isOrderOperator, isPrefix, lastDay, least, leftPad, leftTrim, leftTrim2, length, like, likeEscape, ln, locate, locate2, log, maximum, minimum, mod, monthsBetween, negate, newExpressionForArgument, newExpressionForArguments, newExpressionForArgumentWithBaseLast, newTime, nextDay, notExists, notIn, notInSubQuery, notLike, notLikeEscape, notNull, notOperator, nullIf, or, oracleDateName, power, printCollection, printDuo, printJavaCollection, printJavaDuo, printsAs, printsAs, printsJavaAs, printsJavaAs, ref, refToHex, replace, replicate, resetOperators, reverse, right, rightPad, rightTrim, rightTrim2, round, roundDate, setArgumentIndices, setIsBindingSupported, setNodeClass, setSelector, setType, sign, simpleAggregate, simpleFunction, simpleFunction, simpleFunctionNoParentheses, simpleLogical, simpleLogicalNoParens, simpleMath, simpleOrdering, simpleRelation, simpleRelation, simpleThreeArgumentFunction, simpleTwoArgumentFunction, sin, sinh, some, soundex, sqrt, standardDeviation, substring, substringSingleArg, sum, sybaseAddMonthsOperator, sybaseAtan2Operator, sybaseInStringOperator, sybaseLocateOperator, sybaseToCharOperator, sybaseToCharWithFormatOperator, sybaseToDateOperator, sybaseToDateToStringOperator, sybaseToNumberOperator, tan, tanh, toChar, toCharWithFormat, toDate, today, toLowerCase, toNumber, toString, toUpperCase, translate, trim, trim2, trunc, truncateDate, value, variance
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

startStrings

protected java.lang.String[] startStrings

separators

protected java.lang.String[] separators

terminationStrings

protected java.lang.String[] terminationStrings

numberOfItems

protected int numberOfItems

isComplete

protected boolean isComplete
Constructor Detail

ListExpressionOperator

public ListExpressionOperator()
Method Detail

copyTo

public void copyTo(ExpressionOperator operator)
Overrides:
copyTo in class ExpressionOperator

getDatabaseStrings

public java.lang.String[] getDatabaseStrings()
INTERNAL: Recalculate the database strings each time this is called in case one has been added.

Overrides:
getDatabaseStrings in class ExpressionOperator

getNumberOfItems

public int getNumberOfItems()

setNumberOfItems

public void setNumberOfItems(int numberOfItems)

getStartStrings

public java.lang.String[] getStartStrings()

setStartString

public void setStartString(java.lang.String startString)

setStartStrings

public void setStartStrings(java.lang.String[] startStrings)

getSeparators

public java.lang.String[] getSeparators()

setSeparator

public void setSeparator(java.lang.String separator)

setSeparators

public void setSeparators(java.lang.String[] separators)

getTerminationStrings

public java.lang.String[] getTerminationStrings()

setTerminationString

public void setTerminationString(java.lang.String terminationString)

setTerminationStrings

public void setTerminationStrings(java.lang.String[] terminationStrings)

incrementNumberOfItems

public void incrementNumberOfItems()

setIsComplete

public void setIsComplete(boolean isComplete)

isComplete

public boolean isComplete()
Description copied from class: ExpressionOperator
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.

Overrides:
isComplete in class ExpressionOperator

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference