Package mondrian.olap.fun

Class TupleFunDef

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

All Implemented Interfaces:

FunDef

public class TupleFunDef
extends FunDefBase

TupleFunDef implements the '(...)' operator which builds tuples, as in ([Time].CurrentMember, [Stores].[USA].[California]).

Since:

3 March, 2002

Author:

jhyde

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TupleFunDef.CalcImpl

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

FunUtil.DescendingValueComparator

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

Util.AbstractFlatList<T>, Util.ByteMatcher, Util.ErrorCellValue, Util.Flat2List<T>, Util.Flat3List<T>, Util.Functor1<RT,PT>, Util.GcIterator<T>, Util.MemoryInfo, Util.PropertyList, Util.SqlNullSafeComparator

Field Summary

Fields inherited from class mondrian.olap.fun.FunDefBase

flags, parameterCategories, returnCategory

Fields inherited from class mondrian.olap.fun.FunUtil

BooleanNull, DoubleEmpty, DoubleNull, IntegerNull, NullMember

Fields inherited from class mondrian.olap.Util

DEBUG, EmptyValue, IBM_JVM, JdbcVersion, JVM_INSTANCE_UUID, nl, nullValue, Retrowoven

Method Summary

Modifier and Type	Method	Description
Calc	compileCall(ResolvedFunCall call, ExpCompiler compiler)	Converts a call to this function into executable objects.
int[]	getParameterCategories()	Returns the types of the arguments of this function.
Type	getResultType(Validator validator, Exp[] args)	Returns the type of a call to this function with a given set of arguments.
int	getReturnCategory()	Returns the Category code of the value returned by this function.
void	unparse(Exp[] args, PrintWriter pw)	Converts a function call into MDX source code.

Methods inherited from class mondrian.olap.fun.FunDefBase

createCall, getDescription, getName, getSignature, getSyntax, validateArg

Methods inherited from class mondrian.olap.fun.FunUtil

avg, box, box, checkIterListResultStyles, checkListResultStyles, compareHierarchically, compareSiblingMembers, compareValues, compareValues, count, decodeCategory, decodeParameterCategories, decodeReturnCategory, decodeSyntacticType, getDimensionDefaultHierarchy, getNonEmptyMemberChildren, getNonEmptyMemberChildrenWithDetails, isAncestorOf, makeNullTuple, max, min, newEvalException, newEvalException, newEvalException, quartile, resolveFunArgs, sum, sumDouble, sumDouble, tupleContainsNullMember, tupleContainsNullMember, worthCaching

Methods inherited from class mondrian.olap.Util

addAppender, addDatabaseTime, addLevelCalculatedMembers, append, appendArrays, areOccurencesEqual, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, binarySearch, bitSetBetween, camelToUpper, canCast, cancelStatement, caseSensitiveCompareName, cast, cast, castToIterable, checkCJResultLimit, close, commaList, compare, compareIntegers, compareKey, compareName, compileScript, convert, convert, convertOlap4jConnectStringToNativeMondrian, convertStackToString, copyOf, copyOf, copyOf, copyOf, copyOf, createExpr, createRandom, createRootRole, createSimpleValidator, createUdf, dbTimeMillis, deprecated, deprecated, digestMd5, digestSha256, equal, equalName, equals, equals, explain, falseFunctor, filter, flatList, flatList, flatListCopy, generateUuidString, genericArray, getAnnotation, getClosestResource, getDimensionCube, getErrorMessage, getErrorMessage, getExecutorService, getFirstDescendantOnLevel, getMatchingCause, getMemberOrdinalInParent, getMemoryInfo, getScheduledExecutorService, hash, hash, hashArray, identityFunctor, implode, intersect, isBlank, isEmpty, isNull, isSorted, isValidProperty, last, lookup, lookup, lookup, lookup, lookup, lookupCompound, lookupCompound, lookupHierarchyLevel, lookupHierarchyRootMember, lookupHierarchyRootMember, lookupProperty, makeAppender, makeBigDecimalFromDouble, makeFqName, makeFqName, makeFqName, matches, matches, mdxEncodeString, needToImplement, newElementNotFoundException, newError, newError, newIdentityHashSet, newIdentityHashSetFake, newInternal, newInternal, newTimer, nonDbTimeMillis, normalizeName, only, parseCommaList, parseConnectString, parseIdentifier, parseInterval, parseLocale, printMemory, printMemory, quoteForMdx, quoteForMdx, quoteJavaString, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quotePattern, readFully, readFully, readURL, readURL, readURL, readVirtualFile, readVirtualFileAsString, removeAppender, replace, replace, replaceProperties, safeGet, setLevel, singleQuoteString, singleQuoteString, sort, sort, threadLocalRemove, toMap, toNullValuesMap, toOlap4j, toOlap4j, toOlap4j, toURL, trueFunctor, 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

Method Details

getReturnCategory

public int getReturnCategory()

Description copied from interface: FunDef

Returns the Category code of the value returned by this function.

Specified by:

getReturnCategory in interface FunDef

Overrides:

getReturnCategory in class FunDefBase

getParameterCategories

public int[] getParameterCategories()

Description copied from interface: FunDef

Returns the types of the arguments of this function. Values are the same as those returned by Exp.getCategory(). The 0^th argument of methods and properties are the object they are applied to. Infix operators have two arguments, and prefix operators have one argument.

Specified by:

getParameterCategories in interface FunDef

Overrides:

getParameterCategories in class FunDefBase

unparse

public void unparse(Exp[] args,
 PrintWriter pw)

Description copied from interface: FunDef

Converts a function call into MDX source code.

Specified by:

unparse in interface FunDef

Overrides:

unparse in class FunDefBase

getResultType

public Type getResultType(Validator validator,
 Exp[] args)

Description copied from class: FunDefBase

Returns the type of a call to this function with a given set of arguments.

The default implementation makes the coarse assumption that the return type is in some way related to the type of the first argument. Operators whose arguments don't follow the requirements of this implementation should override this method.

If the function definition says it returns a literal type (numeric, string, symbol) then it's a fair guess that the function call returns the same kind of value.

If the function definition says it returns an object type (cube, dimension, hierarchy, level, member) then we check the first argument of the function. Suppose that the function definition says that it returns a hierarchy, and the first argument of the function happens to be a member. Then it's reasonable to assume that this function returns a member.

Overrides:

getResultType in class FunDefBase

Parameters:

validator - Validator

args - Arguments to the call to this operator

Returns:

result type of a call this function

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