public static class UdfTest.PlusOrMinusOneUdf extends Object implements UserDefinedFunction
UserDefinedFunction.Argument
Constructor and Description |
---|
PlusOrMinusOneUdf(String name) |
Modifier and Type | Method and Description |
---|---|
Object |
execute(Evaluator evaluator,
UserDefinedFunction.Argument[] arguments)
Applies this function to a set of arguments, and returns a result.
|
String |
getDescription()
Returns a description of the user-defined function.
|
String |
getName()
Returns the name with which the user-defined function will be used
from within MDX expressions.
|
Type[] |
getParameterTypes()
Returns an array of the types of the parameters of this function.
|
String[] |
getReservedWords()
Returns a list of reserved words used by this function.
|
Type |
getReturnType(Type[] parameterTypes)
Returns the return-type of this function.
|
Syntax |
getSyntax()
Returns the syntactic type of the user-defined function.
|
public PlusOrMinusOneUdf(String name)
public String getName()
UserDefinedFunction
getName
in interface UserDefinedFunction
public String getDescription()
UserDefinedFunction
getDescription
in interface UserDefinedFunction
public Syntax getSyntax()
UserDefinedFunction
Syntax.Function
.getSyntax
in interface UserDefinedFunction
public Type getReturnType(Type[] parameterTypes)
UserDefinedFunction
getReturnType
in interface UserDefinedFunction
parameterTypes
- Parameter typespublic String[] getReservedWords()
UserDefinedFunction
getReservedWords
in interface UserDefinedFunction
public Type[] getParameterTypes()
UserDefinedFunction
getParameterTypes
in interface UserDefinedFunction
public Object execute(Evaluator evaluator, UserDefinedFunction.Argument[] arguments)
UserDefinedFunction
execute
in interface UserDefinedFunction
evaluator
- Evaluator containts the runtime context, in particular
the current member of each dimension.arguments
- Expressions which yield the arguments of this function.
Most user-defined functions will evaluate all arguments before using
them. Functions such as IIf
do not evaluate all
arguments; this technique is called lazy evaluation.