oracle.olapi.syntax
Class RowFunctionExpression

java.lang.Object
  oracle.olapi.syntax.SyntaxObject
      oracle.olapi.syntax.DataObject
          oracle.olapi.syntax.Expression
              oracle.olapi.syntax.TypedExpression
                  oracle.olapi.syntax.RowExpression
                      oracle.olapi.syntax.RowFunctionExpression

All Implemented Interfaces:

FunctionArgument

public final class RowFunctionExpression
extends RowExpression

A RowExpression that represents a row function, which is similar to a SQL single-row function. A SQL single-row function returns a single result row for every row of a queried table or view. These functions can appear in select lists, WHERE clauses, START WITH and CONNECT BY clauses, and HAVING clauses.

Constructor Summary

RowFunctionExpression(java.lang.String functionName)
Creates a RowFunctionExpression that resolves to the specified row function with no arguments.

RowFunctionExpression(java.lang.String functionName, FunctionArgument arg1)
Creates a RowFunctionExpression that resolves to the specified row function with the specified argument.

RowFunctionExpression(java.lang.String functionName, FunctionArgument[] args)
Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

RowFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2)
Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

RowFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3)
Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

RowFunctionExpression(java.lang.String functionName, FunctionArgument arg1, FunctionArgument arg2, FunctionArgument arg3, FunctionArgument arg4)
Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

RowFunctionExpression(java.lang.String functionName, java.util.List<FunctionArgument> args)
Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Method Summary

FunctionArgument[]	getArguments() Gets the function arguments that are associated with this RowFunctionExpression.
FunctionDescriptor	getFunctionDescriptor() Gets the function descriptor that is associated with this RowFunctionExpression.
java.lang.String	getFunctionName() Gets the name of the row function that this RowFunctionExpression represents.
java.lang.Object	visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitRowFunctionExpression method of the SyntaxObjectVisitor and passes that method this RowFunctionExpression and an Object.

Methods inherited from class oracle.olapi.syntax.RowExpression

isCompositeObject

Methods inherited from class oracle.olapi.syntax.TypedExpression

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

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

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             FunctionArgument[] args)

Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Parameters:

functionName - A String that contains the name of the row function.

args - An array of FunctionArgument objects that affect the behavior of the function.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             java.util.List<FunctionArgument> args)

Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Parameters:

functionName - A String that contains the name of the row function.

args - A List of FunctionArgument objects that affect the behavior of the function.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName)

Creates a RowFunctionExpression that resolves to the specified row function with no arguments.

Parameters:

functionName - A String that contains the name of the row function.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             FunctionArgument arg1)

Creates a RowFunctionExpression that resolves to the specified row function with the specified argument.

Parameters:

functionName - A String that contains the name of the row function.

arg1 - A FunctionArgument that is the only argument of the function.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             FunctionArgument arg1,
                             FunctionArgument arg2)

Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Parameters:

functionName - A String that contains the name of the row function.

arg1 - A FunctionArgument that is the first argument of the function.

arg2 - A FunctionArgument that is the second argument of the function.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             FunctionArgument arg1,
                             FunctionArgument arg2,
                             FunctionArgument arg3)

Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Parameters:

functionName - A String that contains the name of the row 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.

RowFunctionExpression

public RowFunctionExpression(java.lang.String functionName,
                             FunctionArgument arg1,
                             FunctionArgument arg2,
                             FunctionArgument arg3,
                             FunctionArgument arg4)

Creates a RowFunctionExpression that resolves to the specified row function with the specified arguments.

Parameters:

functionName - A String that contains the name of the row 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.

Method Detail

visit

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

Calls the visitRowFunctionExpression method of the SyntaxObjectVisitor and passes that method this RowFunctionExpression and an Object.

Specified by:

visit in class SyntaxObject

Parameters:

visitor - A SyntaxObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitRowFunctionExpression method.

getArguments

public FunctionArgument[] getArguments()

Gets the function arguments that are associated with this RowFunctionExpression.

Returns:

An array of the FunctionArgument objects associated with this RowFunctionExpression.

getFunctionDescriptor

public FunctionDescriptor getFunctionDescriptor()

Gets the function descriptor that is associated with this RowFunctionExpression.

Returns:

The FunctionDescriptor associated with this RowFunctionExpression.

getFunctionName

public java.lang.String getFunctionName()

Gets the name of the row function that this RowFunctionExpression represents.

Returns:

A String that contains the name of the row function of this RowFunctionExpression.