com.spss.psapi.core

Interface ParameterProvider

  • All Known Subinterfaces:
    CompositeProcessor, ProcessorStream


    public interface ParameterProvider
    Identifies objects that contain parameters. Parameters do not control the behaviour of the implementing class directly but provide a look-up mechanism for values that may affect the behaviour of other objects.
    Since:
    PSAPI 1.0
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ParameterDefinition getParameterDefinition(java.lang.String parameterName)
      Returns the parameter definition for the parameter with the specified name or null if no such parameter exists in this provider.
      java.lang.String getParameterLabel(java.lang.String parameterName)
      Returns the label of the named parameter or null if no such parameter exists.
      ParameterStorage getParameterStorage(java.lang.String parameterName)
      Returns the storage of the named parameter or null if no such parameter exists.
      ParameterType getParameterType(java.lang.String parameterName)
      Returns the type of the named parameter or null if no such parameter exists.
      java.lang.Object getParameterValue(java.lang.String parameterName)
      Returns the value of the named parameter or null if no such parameter exists.
      java.util.Iterator parameterIterator()
      Returns an iterator of parameter names for this object.
      void setParameterLabel(java.lang.String parameterName, java.lang.String label)
      Sets the label of the named parameter.
      void setParameterStorage(java.lang.String parameterName, ParameterStorage storage)
      Sets the storage of the named parameter.
      void setParameterType(java.lang.String parameterName, ParameterType type)
      Sets the type of the named parameter.
      void setParameterValue(java.lang.String parameterName, java.lang.Object value)
      Sets the value of the named parameter.
    • Method Detail

      • setParameterLabel

        void setParameterLabel(java.lang.String parameterName,
                             java.lang.String label)
                               throws ObjectLockedException
        Sets the label of the named parameter.
        Parameters:
        parameterName - the parameter name
        label - the parameter label
        Throws:
        ObjectLockedException - if the parameter provider is locked
        See Also:
        getParameterLabel(String)
      • getParameterLabel

        java.lang.String getParameterLabel(java.lang.String parameterName)
        Returns the label of the named parameter or null if no such parameter exists.
        Parameters:
        parameterName - the parameter name
        Returns:
        the label of the named parameter or null if no such parameter exists
        See Also:
        setParameterLabel(String, String)
      • getParameterStorage

        ParameterStorage getParameterStorage(java.lang.String parameterName)
        Returns the storage of the named parameter or null if no such parameter exists.
        Parameters:
        parameterName - the parameter name
        Returns:
        the storage of the named parameter or null if no such parameter exists
        See Also:
        setParameterStorage(String, ParameterStorage)
      • getParameterType

        ParameterType getParameterType(java.lang.String parameterName)
        Returns the type of the named parameter or null if no such parameter exists.
        Parameters:
        parameterName - the parameter name
        Returns:
        the type of the named parameter or null if no such parameter exists
        See Also:
        setParameterType(String, ParameterType)
      • setParameterValue

        void setParameterValue(java.lang.String parameterName,
                             java.lang.Object value)
                               throws ObjectLockedException
        Sets the value of the named parameter.
        Parameters:
        parameterName - the parameter name
        value - the parameter value
        Throws:
        ObjectLockedException - if the parameter provider is locked
        See Also:
        getParameterValue(String)
      • getParameterValue

        java.lang.Object getParameterValue(java.lang.String parameterName)
        Returns the value of the named parameter or null if no such parameter exists.
        Parameters:
        parameterName - the parameter name
        Returns:
        the value of the named parameter or null if no such parameter exists
        See Also:
        setParameterValue(String, Object)
      • parameterIterator

        java.util.Iterator parameterIterator()
        Returns an iterator of parameter names for this object.
        Returns:
        an iterator of parameter names for this object
      • getParameterDefinition

        ParameterDefinition getParameterDefinition(java.lang.String parameterName)
        Returns the parameter definition for the parameter with the specified name or null if no such parameter exists in this provider. The result may be a snapshot of the definition at the time the method was called and need not reflect any subsequent modifications made to the parameter through this provider.
        Parameters:
        parameterName - the parameter name
        Returns:
        a corresponding ParameterDefinition instance
        Since:
        PSAPI 3.0

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.