org.pentaho.reporting.libraries.formula.function.datetime
Class DateFunctionDescription

java.lang.Object
  org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
      org.pentaho.reporting.libraries.formula.function.datetime.DateFunctionDescription

All Implemented Interfaces:

Serializable, FunctionDescription

public class DateFunctionDescription
extends AbstractFunctionDescription

Creation-Date: 04.11.2006, 18:59:11

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

DateFunctionDescription()

Method Summary

FunctionCategory	getCategory()
int	getParameterCount()
Type	getParameterType(int position) Returns the parameter type at the given position using the function metadata.
Type	getValueType()
boolean	isParameterMandatory(int position) Defines, whether the parameter at the given position is mandatory.

Methods inherited from class org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isDeprecated, isExperimental, isInfiniteParameterCount, isVolatile

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFunctionDescription

public DateFunctionDescription()

Method Detail

getValueType

public Type getValueType()

getParameterCount

public int getParameterCount()

getParameterType

public Type getParameterType(int position)

Description copied from interface: FunctionDescription

Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;

Parameters:

position - The parameter index.

Returns:

The parameter type.

isParameterMandatory

public boolean isParameterMandatory(int position)

Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while optional parameters need not to be filled in.

Returns:

true, as all parameters are mandatory.

getCategory

public FunctionCategory getCategory()