oracle.olapi.syntax
Class AggregationFunctionExpression

java.lang.Object
  oracle.olapi.syntax.SyntaxObject
      oracle.olapi.syntax.DataObject
          oracle.olapi.syntax.Expression
              oracle.olapi.syntax.TypedExpression
                  oracle.olapi.syntax.AggregationFunctionExpression

All Implemented Interfaces:

FunctionArgument

public final class AggregationFunctionExpression
extends TypedExpression

A TypedExpression that represents an aggregation function. With an AggregationFunctionExpression, you can aggregate measure values over specified dimension members. You specify the dimension members with an AggregateOverMembersClause. You can use an AggregationFunctionExpression as the Expression for an MdmCustomMember of an MdmModel.

Constructor Summary

AggregationFunctionExpression(java.lang.String functionName, FunctionArgument arg, AggregateOverClause overClause)
Creates an AggregationFunctionExpression that resolves to the aggregation function with the function argument and OVER clause.

AggregationFunctionExpression(java.lang.String functionName, java.util.List<FunctionArgument> args, AggregateOverClause overClause)
Creates an AggregationFunctionExpression that resolves to the aggregation function with the function arguments and OVER clause.

Method Summary

FunctionArgument[]	getArguments() Gets the function arguments that are associated with this AggregationFunctionExpression.
FunctionDescriptor	getFunctionDescriptor() Gets the function descriptor that is associated with this AggregationFunctionExpression.
java.lang.String	getFunctionName() Gets the name of the aggregation function that this AggregationFunctionExpression represents.
java.lang.String	getOperatorName() Gets the name of the aggregation operator that this AggregationFunctionExpression represents.
AggregateOverClause	getOverClause() Gets the AggregateOverClause that is associated with this AggregationFunctionExpression.
java.lang.Object	visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitAggregationFunctionExpression method of the SyntaxObjectVisitor and passes that method this AggregationFunctionExpression and an Object.

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

AggregationFunctionExpression

public AggregationFunctionExpression(java.lang.String functionName,
                                     FunctionArgument arg,
                                     AggregateOverClause overClause)

Creates an AggregationFunctionExpression that resolves to the aggregation function with the function argument and OVER clause.

Parameters:

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

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

overClause - An AggregateOverClause that specifies the values to include in the aggregation.

AggregationFunctionExpression

public AggregationFunctionExpression(java.lang.String functionName,
                                     java.util.List<FunctionArgument> args,
                                     AggregateOverClause overClause)

Creates an AggregationFunctionExpression that resolves to the aggregation function with the function arguments and OVER clause.

Parameters:

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

args - A List of FunctionArgument objects that are the arguments to the function.

overClause - An AggregateOverClause that specifies the values to include in the aggregation.

Method Detail

visit

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

Calls the visitAggregationFunctionExpression method of the SyntaxObjectVisitor and passes that method this AggregationFunctionExpression and an Object.

Specified by:

visit in class SyntaxObject

Parameters:

visitor - A SyntaxObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitAggregationFunctionExpression method.

getArguments

public FunctionArgument[] getArguments()

Gets the function arguments that are associated with this AggregationFunctionExpression.

Returns:

An array of the FunctionArgument objects associated with this AggregationFunctionExpression.

getFunctionDescriptor

public FunctionDescriptor getFunctionDescriptor()

Gets the function descriptor that is associated with this AggregationFunctionExpression.

Returns:

The FunctionDescriptor associated with this AggregationFunctionExpression.

getFunctionName

public java.lang.String getFunctionName()

Gets the name of the aggregation function that this AggregationFunctionExpression represents.

Returns:

A String that contains the name of the aggregation function of this AggregationFunctionExpression.

getOperatorName

public java.lang.String getOperatorName()

Gets the name of the aggregation operator that this AggregationFunctionExpression represents.

Returns:

A String that contains the name of the aggregation operator of this AggregationFunctionExpression.

getOverClause

public AggregateOverClause getOverClause()

Gets the AggregateOverClause that is associated with this AggregationFunctionExpression.

Returns:

The AggregateOverClause of this AggregationFunctionExpression.