com.ibm.as400.resource
Class ProgramMap

java.lang.Object
  |
  +--com.ibm.as400.resource.ProgramMap

All Implemented Interfaces:

java.io.Serializable

public class ProgramMap

extends java.lang.Object

implements java.io.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 Summary

ProgramMap()

Method Summary

void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName) Adds a map entry.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, int[] indices) Adds a map entry.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, int[] indices, ValueMap valueMap) Adds a map entry.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, java.lang.String countName) Adds a map entry for array elements.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, java.lang.String countName, ValueMap map) Adds a map entry for array elements.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, ValueMap valueMap) Adds a map entry.
void	add(java.lang.Object id, java.lang.String programName, java.lang.String dataName, ValueMap valueMap, ResourceLevel level) Adds a map entry.
java.lang.Object[]	getIDs() Returns the list of IDs in the map.
java.lang.Object[]	getValues(java.lang.Object[] ids, AS400 system, ProgramCallDocument document, java.lang.String programName, int[] indices) Get a set of values from the PCML document and map them to the appropriate logical values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgramMap

public ProgramMap()

Method Detail

add

public void add(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName)

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(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                ValueMap valueMap)

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(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                ValueMap valueMap,
                ResourceLevel level)

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(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                int[] indices)

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(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                java.lang.String countName,
                ValueMap map)

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.

valueMap - The value map, or null if there is none.

add

public void add(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                java.lang.String countName)

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(java.lang.Object id,
                java.lang.String programName,
                java.lang.String dataName,
                int[] indices,
                ValueMap valueMap)

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 java.lang.Object[] getIDs()

Returns the list of IDs in the map.

Returns:

The list of IDs.

getValues

public java.lang.Object[] getValues(java.lang.Object[] ids,
                                    AS400 system,
                                    ProgramCallDocument document,
                                    java.lang.String programName,
                                    int[] indices)
                             throws PcmlException

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.