mondrian.olap.fun
Class AbstractAggregateFunDef

java.lang.Object
  org.eigenbase.xom.XMLUtil
      org.eigenbase.xom.XOMUtil
          mondrian.olap.Util
              mondrian.olap.fun.FunUtil
                  mondrian.olap.fun.FunDefBase
                      mondrian.olap.fun.AbstractAggregateFunDef

All Implemented Interfaces:

FunDef

Direct Known Subclasses:

AggregateFunDef, AvgFunDef, CorrelationFunDef, CountFunDef, MedianFunDef, MinMaxFunDef, NthQuartileFunDef, PercentileFunDef, StdevFunDef, StdevPFunDef, SumFunDef, VarFunDef, VarPFunDef

public class AbstractAggregateFunDef
extends FunDefBase

Abstract base class for all aggregate functions (Aggregate, Sum, Avg, et cetera).

Since:

2005/8/14

Version:

$Id: //open/mondrian-release/3.0/src/main/mondrian/olap/fun/AbstractAggregateFunDef.java#2 $

Author:

jhyde

Nested Class Summary

Nested classes/interfaces inherited from class mondrian.olap.fun.FunUtil

FunUtil.SetWrapper

Nested classes/interfaces inherited from class mondrian.olap.Util

Util.ErrorCellValue, Util.PropertyList

Field Summary

Fields inherited from class mondrian.olap.fun.FunDefBase

flags, parameterCategories, returnCategory, signature

Fields inherited from class mondrian.olap.fun.FunUtil

BooleanNull, DoubleEmpty, DoubleNull, emptyStringArray, IntegerNull, NullMember

Fields inherited from class mondrian.olap.Util

EmptyValue, JdbcVersion, nl, nullValue, PreJdk15, Retrowoven

Constructor Summary

AbstractAggregateFunDef(FunDef dummyFunDef)

Method Summary

protected Iterable	evaluateCurrentIterable(IterCalc iterCalc, Evaluator evaluator)
protected static List	evaluateCurrentList(ListCalc listCalc, Evaluator evaluator) Evaluates the list of members or tuples used in computing the aggregate.
protected Exp	validateArg(Validator validator, Exp[] args, int i, int category) Validates an argument to a call to this function.

Methods inherited from class mondrian.olap.fun.FunDefBase

castType, compileCall, createCall, getDescription, getName, getParameterCategories, getResultType, getReturnCategory, getSignature, getSyntax, unparse

Methods inherited from class mondrian.olap.fun.FunUtil

addMembers, addMembers, addUnique, ancestor, appendTuple, avg, checkCompatible, checkFlag, checkIterListResultStyles, checkListResultStyles, compareHierarchically, compareSiblingMembers, compareValues, compareValues, compareValues, correlation, count, cousin, covariance, createDummyFunDef, decodeCategory, decodeParameterCategories, decodeReturnCategory, decodeSyntacticType, dimensionMembers, equalTuple, evaluateMembers, evaluateMembers, evaluateSet, evaluateSet, evaluateTuples, getLiteralArg, getLiteralArg, getNonEmptyLevelMembers, getNonEmptyMemberChildren, hierarchize, hierarchyMembers, isAncestorOf, isMemberType, levelMembers, makeNullMember, makeNullTuple, max, memberRange, min, newEvalException, newEvalException, percentile, periodsToDate, quartile, removeCalculatedMembers, resolveFunArgs, searchValuesDesc, sign, sortMembers, sortTuples, sortValuesDesc, stdev, sum, sumDouble, sumDouble, toPercent, tupleContainsNullMember, var

Methods inherited from class mondrian.olap.Util

addDatabaseTime, addLevelCalculatedMembers, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, camelToUpper, caseSensitiveCompareName, cast, cast, commaList, compareKey, compareName, convertStackToString, createExpr, createRandom, createSimpleValidator, createUdf, dbTimeMillis, deprecated, enumSetAllOf, enumSetNoneOf, enumSetOf, equal, equalName, equals, equals, getAnnotation, getErrorMessage, getErrorMessage, getFirstDescendantOnLevel, getMemberOrdinalInParent, hash, hash, hashArray, implode, isEmpty, isNull, isSorted, isValidProperty, lookup, lookup, lookup, lookup, lookupCompound, lookupCompound, lookupHierarchyLevel, lookupHierarchyRootMember, lookupHierarchyRootMember, lookupProperty, makeBigDecimalFromDouble, makeFqName, makeFqName, makeFqName, maskVersion, mdxEncodeString, needToImplement, newError, newError, newInternal, newInternal, nonDbTimeMillis, normalizeName, parseCommaList, parseConnectString, parseIdentifier, printMemory, printMemory, quoteForMdx, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quotePattern, readFully, readURL, readURL, readURL, readURL, replace, replace, replaceProperties, singleQuoteString, singleQuoteString, toMap, toURL, unexpected, union, union, uniquify, unparse, unparse, wildcardToRegexp

Methods inherited from class org.eigenbase.xom.XOMUtil

addAll, addAll, addChild, addChild, addChildren, addElement, concatenate, createDefaultParser, discard, discard, discard, discard, discard, discard, discard, discard, discard, getFirstInstance, toList, toVector, wrapperToXml

Methods inherited from class org.eigenbase.xom.XMLUtil

getFirstTagName, printAtt, printAtt, printAtt, printAtt, printPCDATA, printPCDATA, printPCDATA, quoteAtt, quoteAtt, quoteAtt, quoteAtt, quotePCDATA, stringEncodeXML, stringHasXMLSpecials

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAggregateFunDef

public AbstractAggregateFunDef(FunDef dummyFunDef)

Method Detail

validateArg

protected Exp validateArg(Validator validator,
                          Exp[] args,
                          int i,
                          int category)

Description copied from class: FunDefBase

Validates an argument to a call to this function.

The default implementation of this method adds an implicit conversion to the correct type. Derived classes may override.

Overrides:

validateArg in class FunDefBase

Parameters:

validator - Validator

args - Arguments to this function

i - Ordinal of argument

category - Expected category of argument

Returns:

Validated argument

evaluateCurrentList

protected static List evaluateCurrentList(ListCalc listCalc,
                                          Evaluator evaluator)

Evaluates the list of members or tuples used in computing the aggregate. If the measure for aggregation has to ignore unrelated dimensions this method will push unrelated dimension members to top level member. This behaviour is driven by the ignoreUnrelatedDimensions property on a base cube usage specified in the virtual cube.Keeps track of the number of iterations that will be required to iterate over the members or tuples needed to compute the aggregate within the current context. In doing so, also determines if the cross product of all iterations across all parent evaluation contexts will exceed the limit set in the properties file.

Parameters:

listCalc - calculator used to evaluate the member list

evaluator - current evalutor

Returns:

list of evaluated members or tuples

evaluateCurrentIterable

protected Iterable evaluateCurrentIterable(IterCalc iterCalc,
                                           Evaluator evaluator)