Package org.pentaho.platform.api.engine

Interface IParameterProvider

All Known Subinterfaces:
IParameterSetter
public interface IParameterProvider
A ParameterProvider is a source for input, output or resource parameters for a given action. The parameter definitions exist within the SequenceDefinition. The values for the parameters are supplied from the ParameterProvider.

  • Field Details

  • Method Details

    • getStringParameter

      String getStringParameter(String name, String defaultValue)
      Retrieve the requested parameter as type java.lang.String
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter, or the defaultValue if not found

    • getLongParameter

      long getLongParameter(String name, long defaultValue)
      Retrieve the requested parameter as primitive Java type long.
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter, or the defaultValue if not found

    • getDateParameter

      Date getDateParameter(String name, Date defaultValue)
      Retrieve the requested parameter as type java.util.Date.
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter, or the defaultValue if not found

    • getDecimalParameter

      BigDecimal getDecimalParameter(String name, BigDecimal defaultValue)
      Retrieve the requested parameter as decimal, returning a java.lang.Object.
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter, or the defaultValue if not found

    • getArrayParameter

      Object[] getArrayParameter(String name, Object[] defaultValue)
      Retrieve the requested parameter as an Object array
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter converted to an array if it wasn't already an array, or the defaultValue if not found

    • getStringArrayParameter

      String[] getStringArrayParameter(String name, String[] defaultValue)
      Retrieve the requested parameter as a String array
      Parameters:
      name - name of parameter to retrieve
      defaultValue - value to return if the named parameter can not be found
      Returns:
      value of requested parameter converted to a String array if it wasn't already a String array, or the defaultValue if not found

    • getParameterNames

      Iterator getParameterNames()
      Return list of all avialable parameter names in this provider
      Returns:
      Set of parameter names

    • getParameter

      Object getParameter(String name)
      Gets the named parameter from the provider as it's native type
      Parameters:
      name - The name of the parameter to retrieve
      Returns:
      The native object

    • hasParameter

      boolean hasParameter(String name)
      Parameters:
      name - Name of the parameter to look up
      Returns:
      true if the parameter exists in the parameter provider