mondrian.olap.fun
Class VisualTotalsFunDef

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.VisualTotalsFunDef

All Implemented Interfaces:

FunDef

public class VisualTotalsFunDef
extends FunDefBase

Definition of the VisualTotals MDX function.

Since:

Jan 16, 2006

Version:

$Id: //open/mondrian/src/main/mondrian/olap/fun/VisualTotalsFunDef.java#16 $

Author:

jhyde

Nested Class Summary

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

FunUtil.ArrayExpMemoComparator, FunUtil.DescendingValueComparator, FunUtil.Flag, FunUtil.OrderKey, FunUtil.Quicksorter<T>, FunUtil.SetWrapper, FunUtil.SortKeySpec

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

Util.ErrorCellValue, Util.PropertyList

Field Summary

(package private) static Resolver

Resolver

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

VisualTotalsFunDef(FunDef dummyFunDef)

Method Summary

Calc	compileCall(ResolvedFunCall call, ExpCompiler compiler) Converts a call to this function into executable objects.
(package private) static java.lang.String	substitute(java.lang.String namePattern, java.lang.String name) Substitutes a name into a pattern. Asterisks are replaced with the name, double-asterisks are replaced with a single asterisk.
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, createCall, getDescription, getName, getParameterCategories, getResultType, getReturnCategory, getSignature, getSyntax, unparse

Methods inherited from class mondrian.olap.fun.FunUtil

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

Methods inherited from class mondrian.olap.Util

addDatabaseTime, addLevelCalculatedMembers, append, appendArrays, areOccurencesEqual, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, camelToUpper, caseSensitiveCompareName, cast, cast, castToIterable, checkCJResultLimit, commaList, compareKey, compareName, convertStackToString, createExpr, createRandom, createSimpleValidator, createUdf, dbTimeMillis, deprecated, enumSetAllOf, enumSetNoneOf, enumSetOf, equal, equalArray, equalName, equals, equals, getAnnotation, getErrorMessage, getErrorMessage, getFirstDescendantOnLevel, getMemberOrdinalInParent, hash, hash, hashArray, implode, isBlank, isEmpty, isNull, isSorted, isValidProperty, lookup, 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, readVirtualFile, replace, replace, replaceProperties, singleQuoteString, singleQuoteString, toMap, toURL, unexpected, uniquify, unparse, unparse, wildcardToRegexp

Methods inherited from class org.eigenbase.xom.XOMUtil

addChild, addChild, addChildren, addElement, concatenate, createDefaultParser, discard, discard, discard, discard, discard, discard, discard, discard, discard, getFirstInstance, 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

Field Detail

Resolver

static final Resolver Resolver

Constructor Detail

VisualTotalsFunDef

public VisualTotalsFunDef(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

compileCall

public Calc compileCall(ResolvedFunCall call,
                        ExpCompiler compiler)

Description copied from interface: FunDef

Converts a call to this function into executable objects.

The result must implement the appropriate interface for the result type. For example, a function which returns an integer must return an object which implements IntegerCalc.

Specified by:

compileCall in interface FunDef

Overrides:

compileCall in class FunDefBase

substitute

static java.lang.String substitute(java.lang.String namePattern,
                                   java.lang.String name)

Substitutes a name into a pattern.

Asterisks are replaced with the name, double-asterisks are replaced with a single asterisk. For example,

substitute("** Subtotal - *", "Dairy")

returns

"* Subtotal - Dairy"

Parameters:

namePattern - Pattern

name - Name to substitute into pattern

Returns:

Substituted pattern