mondrian.olap.fun

Class FunInfo

java.lang.Object

mondrian.olap.fun.FunInfo

All Implemented Interfaces:

Comparable<FunInfo>

public class FunInfo
extends Object
implements Comparable<FunInfo>

Support class for the CmdRunner allowing one to view available functions and their syntax.

Author:

Richard M. Emberson

Constructor Summary

Constructors

Constructor and Description
FunInfo(FunDef funDef)
FunInfo(MultiResolver multiResolver)
FunInfo(Resolver resolver)
FunInfo(String name, String description, String flags)

Method Summary

Modifier and Type	Method and Description
int	compareTo(FunInfo fi)
boolean	equals(Object obj)
String	getDescription() Returns the description of this function.
String	getName() Returns the name of this function.
int[][]	getParameterCategories() Returns the types of the arguments of this function.
int[]	getReturnCategories() Returns the type of value returned by this function.
String[]	getSignatures()
Syntax	getSyntax() Returns the syntactic type of the function.
int	hashCode()
(package private) static FunInfo	make(Resolver resolver)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunInfo

FunInfo(FunDef funDef)

FunInfo

FunInfo(MultiResolver multiResolver)

FunInfo

FunInfo(Resolver resolver)

FunInfo

FunInfo(String name,
        String description,
        String flags)

Method Detail

make

static FunInfo make(Resolver resolver)

getSignatures

public String[] getSignatures()

getSyntax

public Syntax getSyntax()

Returns the syntactic type of the function.

getName

public String getName()

Returns the name of this function.

getDescription

public String getDescription()

Returns the description of this function.

getReturnCategories

public int[] getReturnCategories()

Returns the type of value returned by this function. Values are the same as those returned by Exp.getCategory().

getParameterCategories

public int[][] getParameterCategories()

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.

compareTo

public int compareTo(FunInfo fi)

Specified by:

compareTo in interface Comparable<FunInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object