public final class OLAPFunctionExpression extends TypedExpression
TypedExpression
that represents an Oracle OLAP function.Constructor and Description |
---|
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified argument. |
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument[] args)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments. |
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument[] args, FunctionArgument[] hierarchyClauseArgs)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments and the specified hierarchy clause arguments. |
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments. |
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments. |
OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3, FunctionArgument arg4)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments. |
OLAPFunctionExpression(java.lang.String functionName, java.util.List<FunctionArgument> args, java.util.List<FunctionArgument> hierarchyClauseArgs)
Creates an
OLAPFunctionExpression that resolves to the specified OLAP function with the specified arguments and hierarchy clause arguments. |
Modifier and Type | Method and Description |
---|---|
FunctionArgument[] |
getArguments()
Gets the function arguments that are associated with this
OLAPFunctionExpression . |
FunctionDescriptor |
getFunctionDescriptor()
Gets the function descriptor that is associated with this
OLAPFunctionExpression . |
java.lang.String |
getFunctionName()
Gets the name of the OLAP function that this
OLAPFunctionExpression represents. |
FunctionArgument[] |
getHierarchyClauseArguments()
Gets the hierarchy clause arguments that are associated with this
OLAPFunctionExpression . |
boolean |
hasHierarchyClause()
Indicates whether this
OLAPFunctionExpression has any hierarchy clause arguments. |
boolean |
isCompositeObject()
Indicates whether this
OLAPFunctionExpression contains other SyntaxObject objects. |
java.lang.Object |
visit(SyntaxObjectVisitor visitor, java.lang.Object context)
Calls the
visitOLAPFunctionExpression method of the SyntaxObjectVisitor and passes that method this OLAPFunctionExpression and an Object . |
abs, acos, addMonths, addMonths, ascii, asciiStr, asin, atan, atan2, between, binToNum, bitAnd, cast, ceil, charToROWID, chr, chr, coalesce, compose, concat, concat, convert, convert, cos, cosh, currentDate, currentTime, dbTimeZone, decode, decompose, deref, div, div, div, div, div, dump, eq, eq, eq, eq, eq, exp, extractDay, extractHour, extractMinute, extractMonth, extractSecond, extractTimeZoneAbbr, extractTimeZoneHour, extractTimeZoneMinute, extractTimeZoneRegion, extractYear, floor, fromTZ, ge, ge, ge, ge, ge, getDataType, greatest, gt, gt, gt, gt, gt, hexToRAW, in, initcap, instr, instr2, instr4, instrB, instrC, isInfinite, isNAN, isNotNull, isNull, lastDay, le, le, le, le, le, least, length, length2, length4, lengthB, lengthC, like, like, like2, like4, likeC, ln, localTimestamp, log, lower, lpad, lt, lt, lt, lt, lt, ltrim, minus, minus, minus, minus, minus, minus, mod, monthsBetween, nanvl, ne, ne, ne, ne, ne, newTime, nextDay, nlsCharsetDeclLen, nlsCharsetID, nlsCharsetName, nlsInitcap, nlsLower, nlsSort, nlsUpper, notIn, nullIf, numToDSInterval, numToYMInterval, nvl, nvl2, oraHash, plus, plus, plus, plus, plus, power, rawToHex, rawToNHex, regexpInstr, regexpReplace, regexpSubstr, remainder, replace, round, rowIDToChar, rowIDToNChar, rpad, rtrim, scnToTimestamp, sessionTimeZone, sign, sin, sinh, soundex, sqrt, substr, substr2, substr4, substrB, substrC, sysContext, sysDate, sysExtractUTC, sysGUID, sysTimestamp, sysTypeID, tan, tanh, times, times, times, times, times, timestampToSCN, toBinaryDouble, toBinaryFloat, toChar, toChar, toCLOB, toDate, toDate, toDSInterval, toLOB, toMultiByte, toNChar, toNChar, toNCLOB, toNumber, toNumber, toNumber, toSingleByte, toTimestamp, toTimestampTZ, toYMInterval, translate, translateUsingCharCS, translateUsingNCharCS, treat, trim, trimLeading, trimTrailing, trunc, tzOffset, UID, unistr, upper, USER, userEnv, vsize, widthBucket
equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax
public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument[] args, FunctionArgument[] hierarchyClauseArgs)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments and the specified hierarchy clause arguments.functionName
- A String
that contains the name of the OLAP function.args
- An array of FunctionArgument
objects that affect the behavior of the function.hierarchyClauseArgs
- An array of FunctionArgument
that specify hierarchy clause arguments.public OLAPFunctionExpression(java.lang.String functionName, java.util.List<FunctionArgument> args, java.util.List<FunctionArgument> hierarchyClauseArgs)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments and hierarchy clause arguments.functionName
- A String
that contains the name of the OLAP function.args
- A List
of FunctionArgument
objects that affect the behavior of the function.hierarchyClauseArgs
- A List
of FunctionArgument
objects that specify hierarchy clause arguments.public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument[] args)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments.functionName
- A String
that contains the name of the OLAP function.args
- An array of FunctionArgument
objects that affect the behavior of the function.public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified argument.functionName
- A String
that contains the name of the OLAP function.arg1
- A FunctionArgument
that is the only argument of the function.public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments.functionName
- A String
that contains the name of the OLAP function.arg1
- A FunctionArgument
that is the first argument of the function.arg2
- A FunctionArgument
that is the second argument of the function.public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments.functionName
- A String
that contains the name of the OLAP function.arg1
- A FunctionArgument
that is the first argument of the function.arg2
- A FunctionArgument
that is the second argument of the function.arg3
- A FunctionArgument
that is the third argument of the function.public OLAPFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3, FunctionArgument arg4)
OLAPFunctionExpression
that resolves to the specified OLAP function with the specified arguments.functionName
- A String
that contains the name of the OLAP function.arg1
- A FunctionArgument
that is the first argument of the function.arg2
- A FunctionArgument
that is the second argument of the function.arg3
- A FunctionArgument
that is the third argument of the function.arg4
- A FunctionArgument
that is the fourth argument of the function.public java.lang.Object visit(SyntaxObjectVisitor visitor, java.lang.Object context)
visitOLAPFunctionExpression
method of the SyntaxObjectVisitor
and passes that method this OLAPFunctionExpression
and an Object
.visit
in class SyntaxObject
visitor
- A SyntaxObjectVisitor
.context
- An Object
.Object
returned by the visitOLAPFunctionExpression
method.public FunctionArgument[] getArguments()
OLAPFunctionExpression
.FunctionArgument
objects associated with this OLAPFunctionExpression
.public boolean hasHierarchyClause()
OLAPFunctionExpression
has any hierarchy clause arguments.boolean
that is true
if this OLAPFunctionExpression
has any hierarchy clause arguments or false
if it does not.public FunctionArgument[] getHierarchyClauseArguments()
OLAPFunctionExpression
.FunctionArgument
objects for the hierarchy clause associated with this OLAPFunctionExpression
..public FunctionDescriptor getFunctionDescriptor()
OLAPFunctionExpression
.FunctionDescriptor
associated with this OLAPFunctionExpression
.public java.lang.String getFunctionName()
OLAPFunctionExpression
represents.String
that contains the name of the OLAP function of this OLAPFunctionExpression
.public boolean isCompositeObject()
OLAPFunctionExpression
contains other SyntaxObject
objects.boolean
that is true
is the OLAPFunctionExpression
contains other SyntaxObject
objects or false
if it does not.