org.pentaho.reporting.engine.classic.core.function.formula
Class DashboardModeFunctionDescription

java.lang.Object
  extended by org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
      extended by org.pentaho.reporting.engine.classic.core.function.formula.DashboardModeFunctionDescription
All Implemented Interfaces:
Serializable, org.pentaho.reporting.libraries.formula.function.FunctionDescription

public class DashboardModeFunctionDescription
extends org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

Todo: Document me!

Date: 13.08.2010 Time: 17:14:56

Author:
Thomas Morgner.
See Also:
Serialized Form

Constructor Summary
DashboardModeFunctionDescription()
          Default Constructor.
 
Method Summary
 org.pentaho.reporting.libraries.formula.function.FunctionCategory getCategory()
          Returns the function category.
 int getParameterCount()
          Returns the number of parameters expected by the function.
 org.pentaho.reporting.libraries.formula.typing.Type getParameterType(int position)
          Returns the parameter type of the function parameters.
 org.pentaho.reporting.libraries.formula.typing.Type getValueType()
          Returns the expected value type.
 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

DashboardModeFunctionDescription

public DashboardModeFunctionDescription()
Default Constructor.

Method Detail

getValueType

public org.pentaho.reporting.libraries.formula.typing.Type getValueType()
Returns the expected value type. This function returns a LogicalType.

Returns:
LogicalType.TYPE

getParameterCount

public int getParameterCount()
Returns the number of parameters expected by the function.

Returns:
1.

getParameterType

public org.pentaho.reporting.libraries.formula.typing.Type getParameterType(int position)
Returns the parameter type of the function parameters.

Parameters:
position - the parameter index.
Returns:
always TextType.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.

Parameters:
position - the position of the parameter.
Returns:
true, as all parameters are mandatory.

getCategory

public org.pentaho.reporting.libraries.formula.function.FunctionCategory getCategory()
Returns the function category. The function category groups functions by their expected use.

Returns:
InformationFunctionCategory.CATEGORY.