Class DrillDownFunctionDescription

  • All Implemented Interfaces:
    Serializable, org.pentaho.reporting.libraries.formula.function.FunctionDescription

    public class DrillDownFunctionDescription
    extends org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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

        getBundle, getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isDeprecated, isExperimental, isInfiniteParameterCount, isVolatile
    • Constructor Detail

      • DrillDownFunctionDescription

        public DrillDownFunctionDescription()
    • 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: