com.spss.psapi.data

Interface GlobalValues



  • public interface GlobalValues
    This defines the set of global values which are usually computed by a stream via a "setglobals" node.
    Since:
    PSAPI 16.0.0
    Author:
    Julian Clinton
    See Also:
    ProcessorStream.getGlobalValues()
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface and Description
      static class  GlobalValues.Type
      This defines the set of global value types than can be accessed from the global values table.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.Iterator<java.lang.String> fieldNameIterator()
      Returns an iterator for each field name with at least one global value.
      java.lang.Object getValue(GlobalValues.Type type, java.lang.String fieldName)
      Returns the global value for the specified type and field name or null if no value can be located.
      java.util.Map<GlobalValues.Type,java.lang.Object> getValues(java.lang.String fieldName)
      Returns a map containing the known entries for the specified field name or null of no entries for the field exist.
    • Method Detail

      • getValue

        java.lang.Object getValue(GlobalValues.Type type,
                                java.lang.String fieldName)
        Returns the global value for the specified type and field name or null if no value can be located. The returned value is generally expected to be a number although future functionality may return different value types.
        Parameters:
        type - the type of value
        fieldName - the field name
        Returns:
        the associated global value or null
      • getValues

        java.util.Map<GlobalValues.Type,java.lang.Object> getValues(java.lang.String fieldName)
        Returns a map containing the known entries for the specified field name or null of no entries for the field exist.
        Parameters:
        fieldName -
        Returns:
        a map or null
      • fieldNameIterator

        java.util.Iterator<java.lang.String> fieldNameIterator()
        Returns an iterator for each field name with at least one global value.
        Returns:
        a field name iterator

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