mondrian.olap.fun
Class JavaFunDef

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

All Implemented Interfaces:

FunDef

public class JavaFunDef
extends FunDefBase

MDX function which is implemented by a Java method. When the function is executed, the method is invoked via reflection.

Since:

Jan 5, 2008

Author:

wgorman, jhyde

Nested Class Summary

static interface	JavaFunDef.Description Annotation which allows you to tag a Java method with the description of the MDX function it implements.
static interface	JavaFunDef.FunctionName Annotation which allows you to tag a Java method with the name of the MDX function it implements.
static interface	JavaFunDef.Signature Annotation which allows you to tag a Java method with the signature of the MDX function it implements.
static interface	JavaFunDef.SyntaxDef Annotation which allows you to tag a Java method with the syntax of the MDX function it implements.

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

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

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

Util.AbstractFlatList<T>, 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, signature

Fields inherited from class mondrian.olap.fun.FunUtil

BooleanNull, DoubleEmpty, DoubleNull, emptyStringArray, IntegerNull, NullMember

Fields inherited from class mondrian.olap.Util

DEBUG, EmptyValue, IBM_JVM, JdbcVersion, nl, nullValue, PreJdk15, PreJdk16, Retrowoven

Constructor Summary

JavaFunDef(String name, String desc, Syntax syntax, int returnCategory, int[] paramCategories, Method method)
Creates a JavaFunDef.

Method Summary

Calc	compileCall(ResolvedFunCall call, ExpCompiler compiler) Converts a call to this function into executable objects.
static List<FunDef>	scan(Class clazz) Scans a java class and returns a list of function definitions, one for each static method which is suitable to become an MDX function.

Methods inherited from class mondrian.olap.fun.FunDefBase

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

Methods inherited from class mondrian.olap.fun.FunUtil

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

Methods inherited from class mondrian.olap.Util

addDatabaseTime, addLevelCalculatedMembers, append, appendArrays, areOccurencesEqual, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, binarySearch, camelToUpper, canCast, cancelAndCloseStatement, caseSensitiveCompareName, cast, cast, castToIterable, checkCJResultLimit, commaList, compare, 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, executeDistributedTasks, filter, flatList, flatList, flatListCopy, generateUuidString, genericArray, getAnnotation, getDimensionCube, getErrorMessage, getErrorMessage, getExecutorService, getExecutorService, getExecutorService, getFirstDescendantOnLevel, getMatchingCause, getMemberOrdinalInParent, getMemoryInfo, getScheduledExecutorService, hash, hash, hashArray, identityFunctor, implode, intersect, isBlank, isEmpty, isNull, isSorted, isValidProperty, lookup, lookup, lookup, lookup, lookup, lookupCompound, lookupCompound, lookupHierarchyLevel, lookupHierarchyRootMember, lookupHierarchyRootMember, lookupProperty, makeBigDecimalFromDouble, makeFqName, makeFqName, makeFqName, maskVersion, matches, mdxEncodeString, needToImplement, newElementNotFoundException, newError, newError, newIdentityHashSet, newIdentityHashSetFake, newInternal, newInternal, newTimer, nonDbTimeMillis, normalizeName, parseCommaList, parseConnectString, parseIdentifier, parseLocale, printMemory, printMemory, quoteForMdx, quoteForMdx, quoteJavaString, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quotePattern, readFully, readFully, readURL, readURL, readURL, readVirtualFile, readVirtualFileAsString, replace, replace, replaceProperties, safeGet, singleQuoteString, singleQuoteString, sort, sort, threadLocalRemove, toMap, 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

Constructor Detail

JavaFunDef

public JavaFunDef(String name,
                  String desc,
                  Syntax syntax,
                  int returnCategory,
                  int[] paramCategories,
                  Method method)

Creates a JavaFunDef.

Parameters:

name - Name

desc - Description

syntax - Syntax

returnCategory - Return type

paramCategories - Parameter types

method - Java method which implements this function

Method Detail

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

scan

public static List<FunDef> scan(Class clazz)

Scans a java class and returns a list of function definitions, one for each static method which is suitable to become an MDX function.

Parameters:

clazz - Class

Returns:

List of function definitions