org.jfree.formula.function.information

Class HasChangedFunctionDescription

Implemented Interfaces:
FunctionDescription

public class HasChangedFunctionDescription
extends AbstractFunctionDescription

Creation-Date: 31.10.2006, 17:41:12
Author:
Thomas Morgner

Constructor Summary

HasChangedFunctionDescription()

Method Summary

FunctionCategory
getCategory()
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
isInfiniteParameterCount()
boolean
isParameterMandatory(int position)
Defines, whether the parameter at the given position is mandatory.
boolean
isVolatile()

Methods inherited from class org.jfree.formula.function.AbstractFunctionDescription

getBundle, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isInfiniteParameterCount, isVolatile

Constructor Details

HasChangedFunctionDescription

public HasChangedFunctionDescription()

Method Details

getCategory

public FunctionCategory getCategory()
Specified by:
getCategory in interface FunctionDescription

getDefaultValue

public 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 interface AbstractFunctionDescription
Parameters:
position -
Returns:
null.

getParameterCount

public int getParameterCount()
Specified by:
getParameterCount in interface FunctionDescription

getParameterType

public Type getParameterType(int position)
Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;
Specified by:
getParameterType in interface FunctionDescription
Parameters:
position - The parameter index.
Returns:
The parameter type.

getValueType

public Type getValueType()
Specified by:
getValueType in interface FunctionDescription

isInfiniteParameterCount

public boolean isInfiniteParameterCount()
Specified by:
isInfiniteParameterCount in interface FunctionDescription
Overrides:
isInfiniteParameterCount in interface AbstractFunctionDescription

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.
Specified by:
isParameterMandatory in interface FunctionDescription
Returns:
false

isVolatile

public boolean isVolatile()
Specified by:
isVolatile in interface FunctionDescription
Overrides:
isVolatile in interface AbstractFunctionDescription