org.pentaho.reporting.engine.classic.core.function.formula
Class EngineeringNotationFunctionDescription

java.lang.Object
  extended by org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
      extended by org.pentaho.reporting.engine.classic.core.function.formula.EngineeringNotationFunctionDescription
All Implemented Interfaces:
Serializable, org.pentaho.reporting.libraries.formula.function.FunctionDescription

public class EngineeringNotationFunctionDescription
extends org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

Function that pick a number and outputs it's engineering representation

Date: 23.07.2009 Time: 19:57:42

Author:
Pedro Alves.
See Also:
Serialized Form

Constructor Summary
EngineeringNotationFunctionDescription()
           
 
Method Summary
 org.pentaho.reporting.libraries.formula.function.FunctionCategory getCategory()
           
 int getParameterCount()
           
 org.pentaho.reporting.libraries.formula.typing.Type getParameterType(int position)
          Returns the parameter type at the given position using the function metadata.
 org.pentaho.reporting.libraries.formula.typing.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

EngineeringNotationFunctionDescription

public EngineeringNotationFunctionDescription()
Method Detail

getValueType

public org.pentaho.reporting.libraries.formula.typing.Type getValueType()

getCategory

public org.pentaho.reporting.libraries.formula.function.FunctionCategory getCategory()

getParameterCount

public int getParameterCount()

getParameterType

public org.pentaho.reporting.libraries.formula.typing.Type getParameterType(int position)
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.

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: