CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.epi
Class Map

java.lang.Object
  extended by com.ibm.ctg.epi.Map
All Implemented Interfaces:
java.io.Serializable

public class Map
extends java.lang.Object
implements java.io.Serializable

This class represents a BMS map. It contains data about the size of the map and the location of each field within it so that it can be matched with a screen.

See Also:
Serialized Form

Constructor Summary
Map(MapData md, int[] fi, FieldData[] fd)
          Constructs a Map object with a MapData object that describes the map, an index of labelled fields and an array of FieldData objects that describe the fields within the map.
 
Method Summary
 boolean equals(java.lang.Object o)
          Returns true if the given object is a Map equivalent to this one.
 Field field(int index)
          Returns the field at the given index within this map.
 Field field(int row, int column)
          Returns the field at the given row and column within this map.
 java.lang.String[] getFieldLabels()
          Returns the names of the fields.
 java.lang.String getName()
          Returns the name of the map.
 Screen getScreen()
          Returns the screen associated with this map.
 boolean isValid()
          Returns true if map is currently valid.
 void setScreen(Screen s)
          Sets the screen associated with this map and check if it is valid.
 java.lang.String toString()
          Returns a String representation of the Map.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Map

public Map(MapData md,
           int[] fi,
           FieldData[] fd)
Constructs a Map object with a MapData object that describes the map, an index of labelled fields and an array of FieldData objects that describe the fields within the map.

Parameters:
md - a MapData object describing this map
fi - an index of labelled fields
fd - an array of FieldData objects describing the fields in this map
Method Detail

isValid

public boolean isValid()
Returns true if map is currently valid.

Returns:
true if the map is valid

setScreen

public void setScreen(Screen s)
Sets the screen associated with this map and check if it is valid.

Parameters:
s - the screen

getScreen

public Screen getScreen()
Returns the screen associated with this map.

Returns:
the screen, or null if not valid

field

public Field field(int index)
Returns the field at the given index within this map.

Parameters:
index - the index of the required field
Returns:
the field, or null if the screen is not valid

field

public Field field(int row,
                   int column)
Returns the field at the given row and column within this map.

Parameters:
row - the row
column - the column
Returns:
the field, or null if screen is not valid

getName

public java.lang.String getName()
Returns the name of the map.

Returns:
the name of the map

getFieldLabels

public java.lang.String[] getFieldLabels()
Returns the names of the fields.

Returns:
array of field labels

equals

public boolean equals(java.lang.Object o)
Returns true if the given object is a Map equivalent to this one.

Overrides:
equals in class java.lang.Object
Parameters:
o - an Object
Returns:
true if the Object is the same as this Map

toString

public java.lang.String toString()
Returns a String representation of the Map.

Overrides:
toString in class java.lang.Object
Returns:
the name of this Map

©Copyright IBM Corp. 1994, 2014
Legal