FunInfo (Pentaho Community Edition Project: mondrian 9.3.0.0-424 API)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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