java.lang.Object
- org.pentaho.reporting.libraries.formula.function.DefaultFunctionDescription

All Implemented Interfaces:

java.io.Serializable, FunctionDescription
```
public class DefaultFunctionDescription
extends java.lang.Object
implements FunctionDescription
```
Creation-Date: 05.11.2006, 15:13:03

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

DefaultFunctionDescription(java.lang.String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCanonicalName()`
`FunctionCategory`	`getCategory()`
`java.lang.Object`	`getDefaultValue(int position)`	Returns the default value for an optional parameter.
`java.lang.String`	`getDescription(java.util.Locale locale)`
`java.lang.String`	`getDisplayName(java.util.Locale locale)`
`int`	`getParameterCount()`
`java.lang.String`	`getParameterDescription(int position, java.util.Locale locale)`
`java.lang.String`	`getParameterDisplayName(int position, java.util.Locale locale)`
`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 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultFunctionDescription
```
public DefaultFunctionDescription(java.lang.String name)
```
- Method Detail
  - getCanonicalName
```
public java.lang.String getCanonicalName()
```
    Specified by:
    
    getCanonicalName in interface FunctionDescription
  - getValueType
```
public Type getValueType()
```
    Specified by:
    
    getValueType in interface FunctionDescription
  - getCategory
```
public FunctionCategory getCategory()
```
    Specified by:
    
    getCategory in interface FunctionDescription
  - getParameterCount
```
public int getParameterCount()
```
    Specified by:
    
    getParameterCount in interface FunctionDescription
  - 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;
    
    Specified by:
    
    getParameterType in interface FunctionDescription
    
    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.
    
    Specified by:
    
    isParameterMandatory in interface FunctionDescription
    
    Returns:
  - getDisplayName
```
public java.lang.String getDisplayName(java.util.Locale locale)
```
    Specified by:
    
    getDisplayName in interface FunctionDescription
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Specified by:
    
    getDescription in interface FunctionDescription
  - isVolatile
```
public boolean isVolatile()
```
    Specified by:
    
    isVolatile in interface FunctionDescription
  - isInfiniteParameterCount
```
public boolean isInfiniteParameterCount()
```
    Specified by:
    
    isInfiniteParameterCount in interface FunctionDescription
  - getParameterDisplayName
```
public java.lang.String getParameterDisplayName(int position,
                                                java.util.Locale locale)
```
    Specified by:
    
    getParameterDisplayName in interface FunctionDescription
  - getParameterDescription
```
public java.lang.String getParameterDescription(int position,
                                                java.util.Locale locale)
```
    Specified by:
    
    getParameterDescription in interface FunctionDescription
  - 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
    
    Parameters:
    
    position -
    
    Returns:

Class DefaultFunctionDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultFunctionDescription

Method Detail

getCanonicalName

getValueType

getCategory

getParameterCount

getParameterType

isParameterMandatory

getDisplayName

getDescription

isVolatile

isInfiniteParameterCount

getParameterDisplayName

getParameterDescription

getDefaultValue