org.jfree.formula.function.logical
Class IfFunctionDescription

java.lang.Object
  extended by org.jfree.formula.function.AbstractFunctionDescription
      extended by org.jfree.formula.function.logical.IfFunctionDescription
All Implemented Interfaces:
FunctionDescription

public class IfFunctionDescription
extends AbstractFunctionDescription

Creation-Date: 04.11.2006, 18:28:55

Author:
Thomas Morgner

Constructor Summary
IfFunctionDescription()
           
 
Method Summary
 FunctionCategory getCategory()
           
 java.lang.Object getDefaultValue(int position)
          Returns the default value for an optional parameter.
 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.jfree.formula.function.AbstractFunctionDescription
getBundle, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isInfiniteParameterCount, isVolatile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IfFunctionDescription

public IfFunctionDescription()
Method Detail

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.

getValueType

public Type getValueType()

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:

getDefaultValue

public java.lang.Object getDefaultValue(int position)
Returns the default value for an optional parameter. If the value returned here is null, then this either means, that the parameter is mandatory or that the default value is computed by the expression itself.

Specified by:
getDefaultValue in interface FunctionDescription
Overrides:
getDefaultValue in class AbstractFunctionDescription
Parameters:
position -
Returns:

getCategory

public FunctionCategory getCategory()