com.ibm.as400.resource

Class ProgramMap

  • All Implemented Interfaces:
    Serializable

    Deprecated. 
    Use packages com.ibm.as400.access and com.ibm.as400.access.list instead.

    public class ProgramMap
    extends Object
    implements Serializable
    The ProgramMap class represents a map between logical values such as Resource attribute values and data in a PCML document. Each logical value is referred to by a logical ID in the map. A logical value may map to multiple pieces of data in a PCML document.

    This class is intended as a helper class for implementing subclasses of Resource.

    See Also:
    Serialized Form
    • Constructor Detail

      • ProgramMap

        public ProgramMap()
        Deprecated. 

    • Method Detail

      • add

        public void add(Object id,
               String programName,
               String dataName)
        Deprecated. 
        Adds a map entry.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               ValueMap valueMap)
        Deprecated. 
        Adds a map entry.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
        valueMap - The value map, or null if there is none.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               ValueMap valueMap,
               ResourceLevel level)
        Deprecated. 
        Adds a map entry.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
        valueMap - The value map, or null if there is none.
        level - The level where this entry is valid, or null if this entry is always valid.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               int[] indices)
        Deprecated. 
        Adds a map entry.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
        indices - The indices in the PCML definition, or null if there are none.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               String countName,
               ValueMap map)
        Deprecated. 
        Adds a map entry for array elements.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
        countName - The data name in the PCML defintion which specifies the size of the array.
        map - The value map, or null if there is none.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               String countName)
        Deprecated. 
        Adds a map entry for array elements.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition.
        dataName - The data name in the PCML definition.
        countName - The data name in the PCML defintion which specifies the size of the array.
      • add

        public void add(Object id,
               String programName,
               String dataName,
               int[] indices,
               ValueMap valueMap)
        Deprecated. 
        Adds a map entry.
        Parameters:
        id - Identifies the logical value.
        programName - The program name in the PCML definition, or null if it will be filled in later.
        dataName - The data name in the PCML definition.
        indices - The indices in the PCML definition, or null if there are none.
        valueMap - The value map, or null if there is none.
      • getIDs

        public Object[] getIDs()
        Deprecated. 
        Returns the list of IDs in the map.
        Returns:
        The list of IDs.
      • getValues

        public Object[] getValues(Object[] ids,
                         AS400 system,
                         ProgramCallDocument document,
                         String programName,
                         int[] indices)
                           throws PcmlException
        Deprecated. 
        Get a set of values from the PCML document and map them to the appropriate logical values.
        Parameters:
        ids - Identifies the logical values.
        system - The system.
        document - The PCML document.
        programName - The PCML program name, or null if the program name is specified as part of the entry.
        indices - The indices, or null if not applicable, or if the indices are specified as part of the entry.
        Throws:
        PcmlException