com.spss.psapi.runtime

Interface Operator



  • public interface Operator
    This defines an operator.
    Since:
    PSAPI 18.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface and Description
      static interface  Operator.Builder 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.List<java.lang.String> getCategories()
      Returns the set of categories the operator belongs to.
      java.lang.String getDescription()
      Returns the human-readable description.
      ParameterGroupDefinition getGroupDefinition(java.lang.String name)
      Returns the parameter group definition for the specified name or null.
      java.util.List<java.lang.String> getGroupNames()
      Returns the list of primary parameter group names.
      java.lang.String getLabel()
      Returns the human-readable label.
      java.lang.String getName()
      Returns the operator name.
      ParameterDefinition getParameterDefinition(java.lang.String name)
      Returns the parameter definition for the specified parameter or null.
      java.util.List<java.lang.String> getParameterNames()
      Returns the list of parameter names.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the operator name.
        Returns:
        the operator name
      • getLabel

        java.lang.String getLabel()
        Returns the human-readable label.
        Returns:
        the label
      • getDescription

        java.lang.String getDescription()
        Returns the human-readable description.
        Returns:
        the description
      • getCategories

        java.util.List<java.lang.String> getCategories()
        Returns the set of categories the operator belongs to.
        Returns:
        the categories
      • getParameterNames

        java.util.List<java.lang.String> getParameterNames()
        Returns the list of parameter names.
        Returns:
        the list of parameter names
      • getParameterDefinition

        ParameterDefinition getParameterDefinition(java.lang.String name)
        Returns the parameter definition for the specified parameter or null.
        Parameters:
        name - the parameter name
        Returns:
        the parameter definition or null
      • getGroupNames

        java.util.List<java.lang.String> getGroupNames()
        Returns the list of primary parameter group names. Primary groups have no parent group.
        Returns:
        the list of primary parameter group names
      • getGroupDefinition

        ParameterGroupDefinition getGroupDefinition(java.lang.String name)
        Returns the parameter group definition for the specified name or null.
        Parameters:
        name - the group name
        Returns:
        the parameter group definition or null

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