mondrian.udf
Class CurrentDateMemberExactUdf

java.lang.Object
  mondrian.udf.CurrentDateMemberUdf
      mondrian.udf.CurrentDateMemberExactUdf

All Implemented Interfaces:

UserDefinedFunction

public class CurrentDateMemberExactUdf
extends CurrentDateMemberUdf

User-defined function CurrentDateMember. Arguments to the function are as follows:

CurrentDateMember(<Hierarchy>, <FormatString>) returns <Member>

The function returns the member from the specified hierarchy that matches the current date, to the granularity specified by the <FormatString>. The format string conforms to the format string implemented by Format.

Version:

$Id: //open/mondrian/src/main/mondrian/udf/CurrentDateMemberExactUdf.java#7 $

Author:

Zelaine Fong

Nested Class Summary

Nested classes/interfaces inherited from interface mondrian.spi.UserDefinedFunction

UserDefinedFunction.Argument

Constructor Summary

CurrentDateMemberExactUdf()

Method Summary

java.lang.String	getDescription() Returns a description of the user-defined function.
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.

Methods inherited from class mondrian.udf.CurrentDateMemberUdf

execute, getName, getReturnType, getSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrentDateMemberExactUdf

public CurrentDateMemberExactUdf()

Method Detail

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

Overrides:

getDescription in class CurrentDateMemberUdf

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

Overrides:

getParameterTypes in class CurrentDateMemberUdf

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

Overrides:

getReservedWords in class CurrentDateMemberUdf