Package com.appliedolap.essbase

Class EssMdxFunction

java.lang.Object

com.appliedolap.essbase.EssMdxFunction

public final class EssMdxFunction
extends Object

One MDX function the server understands, as the server itself describes it.

A bean with nothing but accessors on purpose: this is reference material rather than anything addressable, so there is no server object behind it to act on. That shape also means a caller can hand it straight to a generic property table without a dedicated view.

Constructor Summary

Constructors

Constructor	Description
EssMdxFunction(String group, String name, String syntax, String comment)

Method Summary

Modifier and Type	Method	Description
String	getComment()	A sentence on what it does.
String	getGroup()	The group the server files this function under - Member, Set, Tuple, Number and so on.
String	getName()	The function name, e.g.
String	getSyntax()	How to call it, e.g.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EssMdxFunction

public EssMdxFunction(String group,
 String name,
 String syntax,
 String comment)

Method Details

getGroup

public String getGroup()

The group the server files this function under - Member, Set, Tuple, Number and so on.

getName

public String getName()

The function name, e.g. Ancestor.

getSyntax

public String getSyntax()

How to call it, e.g. Ancestor ( member , layer | index [, hierarchy ] ), with optional parts in square brackets and alternatives separated by a pipe.

getComment

public String getComment()

A sentence on what it does.

toString

public String toString()

Overrides:

toString in class Object