Package mondrian.udf

Class 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.
    Author:
    Zelaine Fong
    • Constructor Detail

      • CurrentDateStringUdf

        public CurrentDateStringUdf()
    • Method Detail

      • 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.
      • 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
      • 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