mondrian.udf
Class CurrentDateStringUdf
java.lang.Object
mondrian.udf.CurrentDateStringUdf
- All Implemented Interfaces:
- UserDefinedFunction
public class CurrentDateStringUdf
- extends java.lang.Object
- implements UserDefinedFunction
User-defined function CurrentDateString, which returns the
current date value as a formatted string, based on a format string passed in
as a parameter. The format string conforms to the format string implemented
by Format
.
- Version:
- $Id: //open/mondrian/src/main/mondrian/udf/CurrentDateStringUdf.java#8 $
- Author:
- Zelaine Fong
Method Summary |
java.lang.Object |
execute(Evaluator evaluator,
UserDefinedFunction.Argument[] arguments)
Applies this function to a set of arguments, and returns a result. |
java.lang.String |
getDescription()
Returns a description of the user-defined function. |
java.lang.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. |
java.lang.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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CurrentDateStringUdf
public CurrentDateStringUdf()
execute
public java.lang.Object execute(Evaluator evaluator,
UserDefinedFunction.Argument[] arguments)
- Description copied from interface:
UserDefinedFunction
- Applies this function to a set of arguments, and returns a result.
- Specified by:
execute
in interface UserDefinedFunction
- Parameters:
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.
- Returns:
- The result value.
getDescription
public java.lang.String getDescription()
- Description copied from interface:
UserDefinedFunction
- Returns a description of the user-defined function.
- Specified by:
getDescription
in interface UserDefinedFunction
getName
public java.lang.String getName()
- Description copied from interface:
UserDefinedFunction
- Returns the name with which the user-defined function will be used
from within MDX expressions.
- Specified by:
getName
in interface UserDefinedFunction
getParameterTypes
public Type[] getParameterTypes()
- Description copied from interface:
UserDefinedFunction
- Returns an array of the types of the parameters of this function.
- Specified by:
getParameterTypes
in interface UserDefinedFunction
getReservedWords
public java.lang.String[] getReservedWords()
- Description copied from interface:
UserDefinedFunction
- Returns a list of reserved words used by this function.
May return an empty array or null if this function does not require
any reserved words.
- Specified by:
getReservedWords
in interface UserDefinedFunction
getReturnType
public Type getReturnType(Type[] parameterTypes)
- Description copied from interface:
UserDefinedFunction
- Returns the return-type of this function.
- Specified by:
getReturnType
in interface UserDefinedFunction
- Parameters:
parameterTypes
- Parameter types
- Returns:
- Return type
getSyntax
public Syntax getSyntax()
- Description copied from interface:
UserDefinedFunction
- Returns the syntactic type of the user-defined function.
Usually
Syntax.Function
.
- Specified by:
getSyntax
in interface UserDefinedFunction