com.spss.psapi.core

Interface ParameterDefinition



  • public interface ParameterDefinition
    Describes a parameter which affects the behaviour of some Modeler API objects. A parameter definition is obtained from a ParameterProvider. The parameter name is unique within the provider.

    Parameters are modified through the provider. A ParameterDefinition instance may be a snapshot of a parameter definition at the time it was obtained from the provider and need not reflect subsequent modifications.

    Since:
    PSAPI 11.1
    Version:
    1.0
    Author:
    Robert Duncan
    See Also:
    ParameterProvider
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object getFalseFlag()
      Returns the false indicator for this flag parameter.
      java.lang.Object getLowerBound()
      Returns a lower bound on the valid values of this parameter.
      java.lang.String getParameterLabel()
      Returns a label for this parameter.
      java.lang.String getParameterName()
      Returns the name of this parameter.
      ParameterStorage getParameterStorage()
      Returns the storage type of this parameter.
      ParameterType getParameterType()
      Returns the measure of this parameter.
      java.lang.Object getParameterValue()
      Returns the value of this parameter.
      java.lang.Object[] getSetValues()
      Returns the valid values of this parameter.
      java.lang.Object getTrueFlag()
      Returns the true indicator for this flag parameter.
      java.lang.Object getUpperBound()
      Returns an upper bound on the valid values of this parameter.
      boolean isValidValue(java.lang.Object value)
      Returns true if the specified value is valid for this parameter.
    • Method Detail

      • getParameterName

        java.lang.String getParameterName()
        Returns the name of this parameter. The name is unique within the parameter provider.
        Returns:
        the parameter name
      • getParameterLabel

        java.lang.String getParameterLabel()
        Returns a label for this parameter. The default label is the empty string.
        Returns:
        the parameter label
      • getParameterValue

        java.lang.Object getParameterValue()
        Returns the value of this parameter.
        Returns:
        the parameter value
      • getParameterStorage

        ParameterStorage getParameterStorage()
        Returns the storage type of this parameter.
        Returns:
        the parameter storage type
      • getParameterType

        ParameterType getParameterType()
        Returns the measure of this parameter.
        Returns:
        the parameter measure
      • getLowerBound

        java.lang.Object getLowerBound()
        Returns a lower bound on the valid values of this parameter. Returns null if the parameter type is other than ParameterType.RANGE or if no lower bound has been declared for the range.
        Returns:
        the lower bound of the parameter value range
      • getUpperBound

        java.lang.Object getUpperBound()
        Returns an upper bound on the valid values of this parameter. Returns null if the parameter type is other than ParameterType.RANGE or if no upper bound has been declared for the range.
        Returns:
        the upper bound of the parameter value range
      • getSetValues

        java.lang.Object[] getSetValues()
        Returns the valid values of this parameter. Returns null if the parameter type is other than ParameterType.SET or if no values have been declared for the set.
        Returns:
        the valid values of the parameter
      • getTrueFlag

        java.lang.Object getTrueFlag()
        Returns the true indicator for this flag parameter. Returns null if the parameter type is other than ParameterType.FLAG or if no true value has been declared for the flag.
        Returns:
        the true value of the parameter
      • getFalseFlag

        java.lang.Object getFalseFlag()
        Returns the false indicator for this flag parameter. Returns null if the parameter type is other than ParameterType.FLAG or if no false value has been declared for the flag.
        Returns:
        the false value of the parameter
      • isValidValue

        boolean isValidValue(java.lang.Object value)
        Returns true if the specified value is valid for this parameter. The value must be compatible with the parameter storage type and with the parameter values when they are specified.
        Parameters:
        value - the value
        Returns:
        true if the value is valid for the parameter

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.