Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.jfree.formula.function.userdefined.MappedFunctionDescription
Constructor Summary | |
Method Summary | |
FunctionCategory | |
Object |
|
String |
|
String |
|
int | |
String |
|
String |
|
Type |
|
Type | |
boolean | |
boolean |
|
boolean |
public FunctionCategory getCategory()
- Specified by:
- getCategory in interface FunctionDescription
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
- Parameters:
position
-
- Returns:
public String getDescription(Locale locale)
- Specified by:
- getDescription in interface FunctionDescription
public String getDisplayName(Locale locale)
- Specified by:
- getDisplayName in interface FunctionDescription
public int getParameterCount()
- Specified by:
- getParameterCount in interface FunctionDescription
public String getParameterDescription(int position, Locale locale)
- Specified by:
- getParameterDescription in interface FunctionDescription
public String getParameterDisplayName(int position, Locale locale)
- Specified by:
- getParameterDisplayName in interface FunctionDescription
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.
public boolean isInfiniteParameterCount()
- Specified by:
- isInfiniteParameterCount in interface FunctionDescription
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: