Package mondrian.olap.fun

Defines the set of MDX built-in functions.

Interface Summary

Interface	Description
Resolver	A Resolver converts a function name, invocation type, and set of arguments into a FunDef.
Resolver.Conversion	Description of an implicit conversion that occurred while resolving an operator call.
UdfResolver.UdfFactory	Factory for UserDefinedFunction.

Class Summary

Class	Description
AbstractAggregateFunDef	Abstract base class for all aggregate functions (Aggregate, Sum, Avg, et cetera).
AddCalculatedMembersFunDef	Definition of the AddCalculatedMembers MDX function.
AggregateFunDef	Definition of the AGGREGATE MDX function.
AggregateFunDef.AggregateCalc
AncestorFunDef	Definition of the Ancestor MDX function.
AncestorsFunDef	Definition of the Ancestors MDX function.
AsFunDef	Definition of the AS MDX operator.
AvgFunDef	Definition of the Avg MDX function.
BuiltinFunTable	BuiltinFunTable contains a list of all built-in MDX functions.
CacheFunDef	Definition of the Cache system function, which is smart enough to evaluate its argument only once.
CacheFunDef.CacheFunResolver
CaseMatchFunDef	Definition of the matched CASE MDX operator.
CaseTestFunDef	Definition of the tested CASE MDX operator.
CastFunDef	Definition of the CAST MDX operator.
CoalesceEmptyFunDef	Definition of the CoalesceEmpty MDX function.
CorrelationFunDef	Definition of the Correlation MDX function.
CountFunDef	Definition of the Count MDX function.
CovarianceFunDef	Definition of the Covariance and CovarianceN MDX functions.
CrossJoinFunDef	Definition of the CrossJoin MDX function.
CrossJoinTest	CrossJoint tests the collation order of positive and negative infinity, and Double.NaN.
CrossJoinTest.NullFunDef
CrossJoinTest.TestFunDef
CustomizedFunctionTable	Interface to build a customized function table, selecting functions from the set of supported functions in an instance of BuiltinFunTable.
DescendantsFunDef	Definition of the Descendants MDX function.
DimensionDimensionFunDef	Definition of the <Dimension>.Dimension MDX builtin function.
DimensionsNumericFunDef	Definition of the Dimensions(<Numeric Expression>) MDX builtin function.
DimensionsStringFunDef	Definition of the Dimensions(<String Expression>) MDX builtin function.
DistinctFunDef	Definition of the Distinct MDX function.
DistinctFunDef.CalcImpl
DrilldownLevelFunDef	Definition of the DrilldownLevel MDX function.
DrilldownLevelTopBottomFunDef	Definition of the DrilldownLevelTop and DrilldownLevelBottom MDX builtin functions.
DrilldownMemberFunDef	Definition of the DrilldownMember MDX function.
ExceptFunDef	Definition of the Except MDX function.
ExistsFunDef	Definition of the EXISTS MDX function.
ExtractFunDef	Definition of the Extract MDX function.
FilterFunDef	Definition of the Filter MDX function.
FormatFunDef	Definition of the Format MDX function.
FunctionTest	FunctionTest tests the functions defined in BuiltinFunTable.
FunDefBase	FunDefBase is the default implementation of FunDef.
FunInfo	Support class for the CmdRunner allowing one to view available functions and their syntax.
FunTableImpl	Abstract implementation of FunTable.
FunUtil	FunUtil contains a set of methods useful within the mondrian.olap.fun package.
FunUtil.DescendingValueComparator	Compares cell values, so that larger values compare first.
FunUtil.ObjIntPair<T>	Tuple consisting of an object and an integer.
FunUtil.OrderKey
FunUtil.Quicksorter<T>	A functional for FunUtil.partialSort(T[], java.util.Comparator<T>, int).
FunUtil.SetWrapper
FunUtil.SortKeySpec
FunUtil.TupleExpMemoComparator
GenerateFunDef	Definition of the Generate MDX function.
GlobalFunTable	Global function table contains builtin functions and global user-defined functions.
HeadTailFunDef	Definition of the Head and Tail MDX builtin functions.
HierarchizeFunDef	Definition of the Hierarchize MDX function.
HierarchyCurrentMemberFunDef	Definition of the <Hierarchy>.CurrentMember MDX builtin function.
HierarchyCurrentMemberFunDef.CalcImpl	Compiled implementation of the Hierarchy.CurrentMember function that evaluates the hierarchy expression first.
HierarchyCurrentMemberFunDef.FixedCalcImpl	Compiled implementation of the Hierarchy.CurrentMember function that uses a fixed hierarchy.
HierarchyDimensionFunDef	Definition of the <Hierarchy>.Dimension MDX builtin function.
HierarchyDimensionFunDef.CalcImpl
IifFunDef	Definition of the Iif MDX function.
IntersectFunDef	Definition of the INTERSECT MDX function.
IsEmptyFunDef	Definition of the IsEmpty MDX function.
IsFunDef	Definition of the IS MDX function.
IsNullFunDef	Definition of the IS NULL MDX function.
JavaFunDef	MDX function which is implemented by a Java method.
LastPeriodsFunDef	Definition of the LastPeriods MDX function.
LeadLagFunDef	Definition of the Lead and Lag MDX functions.
LevelDimensionFunDef	Definition of the <Level>.Dimension MDX builtin function.
LevelHierarchyFunDef	Definition of the <Level>.Hierarchy MDX builtin function.
LevelHierarchyFunDef.CalcImpl
LevelMembersFunDef	Definition of the <Level>.Members MDX function.
LinReg	Abstract base class for definitions of linear regression functions.
LinReg.InterceptFunDef	Definition of the LinRegIntercept MDX function.
LinReg.PointFunDef	Definition of the LinRegPoint MDX function.
LinReg.R2FunDef	Definition of the LinRegR2 MDX function.
LinReg.SlopeFunDef	Definition of the LinRegSlope MDX function.
LinReg.Value
LinReg.VarianceFunDef	Definition of the LinRegVariance MDX function.
MedianFunDef	Definition of the Median MDX functions.
MemberDimensionFunDef	Definition of the <Measure>.Dimension MDX builtin function.
MemberExtractingVisitor	Visitor which collects any non-measure base members encountered while traversing an expression.
MemberHierarchyFunDef	Definition of the <Member>.Hierarchy MDX builtin function.
MemberHierarchyFunDef.CalcImpl
MemberLevelFunDef	Definition of the <Member>.Level MDX builtin function.
MemberLevelFunDef.CalcImpl
MemberOrderKeyFunDef	Definition of the <Member>.OrderKey MDX builtin function.
MemberOrderKeyFunDef.CalcImpl
MinMaxFunDef	Definition of the Min and Max MDX functions.
MultiResolver	A MultiResolver considers several overloadings of the same function.
NamedSetCurrentFunDef	Definition of the <Named Set>.Current MDX builtin function.
NamedSetCurrentOrdinalFunDef	Definition of the <Named Set>.CurrentOrdinal MDX builtin function.
NativizeSetFunDef	Definition of the NativizeSet MDX function.
NativizeSetFunDef.AddFormulasVisitor
NativizeSetFunDef.CrossJoinAnalyzer
NativizeSetFunDef.FindLevelsVisitor
NativizeSetFunDef.NativeListCalc
NativizeSetFunDef.NonNativeCalc
NativizeSetFunDef.NonNativeIterCalc
NativizeSetFunDef.NonNativeListCalc
NativizeSetFunDef.Range
NativizeSetFunDef.RangeIterator
NativizeSetFunDef.TransformFromFormulasVisitor
NativizeSetFunDef.TransformToFormulasVisitor
NativizeSetFunDefTest	Unit test for the NativizeSet function.
NonEmptyCrossJoinFunDef	Definition of the NonEmptyCrossJoin MDX function.
OpeningClosingPeriodFunDef	Definition of the OpeningPeriod and ClosingPeriod builtin functions.
OrderFunDef	Definition of the Order MDX function.
ParallelPeriodFunDef	Definition of the ParallelPeriod MDX function.
ParameterFunDef	A ParameterFunDef is a pseudo-function describing calls to Parameter and ParamRef functions.
ParameterFunDef.ParameterResolver	Resolves calls to the Parameter MDX function.
ParameterFunDef.ParamRefResolver	Resolves calls to the ParamRef MDX function.
ParenthesesFunDef	ParenthesesFunDef implements the parentheses operator as if it were a function.
PartialSortTest	PartialSortTest is a unit test for the partial-sort algorithm FunUtil.partialSort(T[], java.util.Comparator<T>, int), which supports MDX functions like TopCount and BottomCount.
PartialSortTest.Item
PercentileFunDef	Definition of the Percentile MDX function.
PeriodsToDateFunDef	Definition of the PeriodsToDate MDX function.
PropertiesFunDef	Definition of the Properties MDX function.
RangeFunDef	Definition of the MDX <Member> : <Member> operator, which returns the set of members between a given pair of members.
RankFunDef	Definition of the RANK MDX function.
RankFunDef.RankedMemberList	Data structure which contains a list and can return the position of an element in the list in O(log N).
RankFunDef.RankedTupleList	Data structure which contains a list and can return the position of an element in the list in O(log N).
ReflectiveMultiResolver	Resolver which uses reflection to instantiate a FunDef.
ResolvedFunCallFinder	Visitor class used to locate a resolved function call within an expression
ResolverBase	ResolverBase provides a skeleton implementation of interface Resolver
ResultStyleCompiler	The ResultStyleCompiler can be used to assure that the use of the container ResultStyle: ITERABLE, LIST and MUTABLE_LIST; can be requested by any Calc.
ResultStyleCompiler.MultiCalc	Calc with three child Calcs, one for ITERABLE, LIST and MUTABLE_LIST, which are evaluated during the normal evaluation process.
SetFunDef	SetFunDef implements the 'set' function (whose syntax is the brace operator, { ...
SetFunDef.ExprIterCalc	Compiled expression that evaluates one or more expressions, each of which yields a tuple or a set of tuples, and returns the result as a tuple iterator.
SetFunDef.SetListCalc	Compiled expression to implement the MDX set function, { ...
SetFunDefTest	Unit test for the set constructor function { ...
SetItemFunDef	Definition of the <Set>.Item MDX function.
SetToStrFunDef	Definition of the SetToStr MDX function.
SimpleResolver	A SimpleResolver resolves a single, non-overloaded function.
SortTest	SortTest tests the collation order of positive and negative infinity, and Double.NaN.
StdevFunDef	Definition of the Stdev builtin MDX function, and its alias Stddev.
StdevPFunDef	Definition of the StdevP builtin MDX function, and its alias StddevP.
StrToMemberFunDef	Definition of the StrToMember MDX function.
StrToSetFunDef	Definition of the StrToSet MDX builtin function.
StrToTupleFunDef	Definition of the StrToTuple MDX function.
SubsetFunDef	Definition of the Subset MDX function.
SumFunDef	Definition of the Sum MDX function.
TestMember	Mock implementation of Member for testing.
ToggleDrillStateFunDef	Definition of the ToggleDrillState MDX function.
TopBottomCountFunDef	Definition of the TopCount and BottomCount MDX builtin functions.
TopBottomPercentSumFunDef	Definition of the TopPercent, BottomPercent, TopSum and BottomSum MDX builtin functions.
TupleFunDef	TupleFunDef implements the '(...)' operator which builds tuples, as in ([Time].CurrentMember, [Stores].[USA].[California]).
TupleFunDef.CalcImpl
TupleItemFunDef	Definition of the <Tuple>.Item MDX function.
TupleToStrFunDef	Definition of the TupleToStr MDX function.
UdfResolver	Resolver for user-defined functions.
UdfResolver.ClassUdfFactory	Implementation of UdfResolver.UdfFactory that instantiates a given class using a public default constructor.
UnionFunDef	Definition of the Union MDX function.
UnionFunDefTest	Tests for UnionFunDef
UnorderFunDef	Definition of the Unorder MDX function.
ValidMeasureFunDef	Definition of the ValidMeasure MDX function.
ValidMeasureFunDefTest	Tests for ValidMeasureFunDef Created by Yury_Bakhmutski on 9/2/2015.
ValueFunDef	A ValueFunDef is a pseudo-function to evaluate a member or a tuple.
VarFunDef	Definition of the Var MDX builtin function (and its synonym Variance).
VarPFunDef	Definition of the VarP MDX builtin function (and its synonym VarianceP).
VisualTotalsFunDef	Definition of the VisualTotals MDX function.
VisualTotalsFunDef.VisualTotalMember	Calculated member for VisualTotals function.
VisualTotalsTest	VisualTotalsTest tests the internal functions defined in VisualTotalsFunDef.
XtdFunDef	Definition of Ytd, Qtd, Mtd, and Wtd MDX builtin functions.

Enum Summary

Enum	Description
DescendantsFunDef.Flag	Enumeration of the flags allowed to the DESCENDANTS function.
FunUtil.Flag	Enumeration of the flags allowed to the ORDER MDX function.
NativizeSetFunDef.NativeElementType

Exception Summary

Exception	Description
MondrianEvaluationException	Thrown while evaluating a cell expression

Annotation Types Summary

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