org.pentaho.reporting.libraries.formula.function.math
Class Atan2FunctionDescription

java.lang.Object
  org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
      org.pentaho.reporting.libraries.formula.function.math.Atan2FunctionDescription

All Implemented Interfaces:

Serializable, FunctionDescription

public class Atan2FunctionDescription
extends AbstractFunctionDescription

Describes Atan2Function function.

Author:

ocke

See Also:

Atan2Function, Serialized Form

Constructor Summary

Atan2FunctionDescription()

Method Summary

FunctionCategory	getCategory()
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.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

Atan2FunctionDescription

public Atan2FunctionDescription()

Method Detail

getCategory

public FunctionCategory getCategory()

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)

Description copied from interface: FunctionDescription

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: