mondrian.olap

Interface FunTable

All Known Implementing Classes:

BuiltinFunTable, CustomizedFunctionTable, FunTableImpl, GlobalFunTable

public interface FunTable

List of all MDX functions.

A function table can resolve a function call, using a particular Syntax and set of arguments, to a function definition (FunDef).

Author:

jhyde, 3 March, 2002

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FunTable.Builder Builder that assists with the construction of a function table by providing callbacks to define functions.

Method Summary

Modifier and Type	Method and Description
void	defineFunctions(FunTable.Builder builder) This method is called from the constructor, to define the set of functions and reserved words recognized.
List<FunInfo>	getFunInfoList() Returns a list of FunInfo objects.
List<String>	getReservedWords() Returns a list of words (String) which may not be used as identifiers.
List<Resolver>	getResolvers() Returns a list of Resolver objects.
List<Resolver>	getResolvers(String name, Syntax syntax) Returns a list of resolvers for an operator with a given name and syntax.
boolean	isProperty(String s) Returns whether a string is a property-style (postfix) operator.
boolean	isReserved(String s) Returns whether a string is a reserved word.

Method Detail

isReserved

boolean isReserved(String s)

Returns whether a string is a reserved word.

isProperty

boolean isProperty(String s)

Returns whether a string is a property-style (postfix) operator. This is used during parsing to disambiguate functions from unquoted member names.

getReservedWords

List<String> getReservedWords()

Returns a list of words (String) which may not be used as identifiers.

getResolvers

List<Resolver> getResolvers()

Returns a list of Resolver objects.

getResolvers

List<Resolver> getResolvers(String name,
                            Syntax syntax)

Returns a list of resolvers for an operator with a given name and syntax. Never returns null; if there are no resolvers, returns the empty list.

Parameters:

name - Operator name

syntax - Operator syntax

Returns:

List of resolvers for the operator

getFunInfoList

List<FunInfo> getFunInfoList()

Returns a list of FunInfo objects.

defineFunctions

void defineFunctions(FunTable.Builder builder)

This method is called from the constructor, to define the set of functions and reserved words recognized.

The implementing class calls FunTable.Builder methods to declare functions and reserved words.

Derived class can override this method to add more functions. It must call the base method.

Parameters:

builder - Builder