iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.editor.generator.model
Class RPGArray

java.lang.Object
  extended bycom.ibm.etools.iseries.editor.generator.model.RPGSimpleArray
      extended bycom.ibm.etools.iseries.editor.generator.model.RPGArray
All Implemented Interfaces:
IDSpec

public class RPGArray
extends RPGSimpleArray


Field Summary
protected  boolean ALT
           
protected  boolean ascending
           
protected  boolean ctdata
           
protected  boolean descending
           
protected  boolean externalFormat
           
protected  String externalFormatType
           
protected  boolean fromFile
           
protected  String fromFileName
           
protected  String mainArrayName
           
protected  int perrcd
           
protected  boolean toFile
           
protected  String toFileName
           
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGSimpleArray
dimensions
 
Fields inherited from interface com.ibm.etools.iseries.editor.generator.model.IDSpec
DATEFMT_DMY, DATEFMT_EUR, DATEFMT_ISO, DATEFMT_JIS, DATEFMT_JUL, DATEFMT_MDY, DATEFMT_NONE, DATEFMT_USA, DATEFMT_YMD, DT_AMPERSAND, DT_COLON, DT_COMMA, DT_DASH, DT_NONE, DT_PERIOD, DT_SLASH, INFDS_DB, INFDS_DSPF_ATTR, INFDS_DSPF_DEV, INFDS_FILE, INFDS_ICF_ATTR, INFDS_ICF_DEV, INFDS_IO, INFDS_OPEN, INFDS_PRTF, MSG_ERR_REQ_FIELD, RPGARRAYKWD_B, RPGARRAYKWD_F, RPGARRAYKWD_I, RPGARRAYKWD_L, RPGARRAYKWD_P, RPGARRAYKWD_R, RPGARRAYKWD_S, RPGARRAYKWD_U, RPGTYPE_A, RPGTYPE_AV, RPGTYPE_B, RPGTYPE_C, RPGTYPE_CV, RPGTYPE_D, RPGTYPE_F, RPGTYPE_G, RPGTYPE_GV, RPGTYPE_I, RPGTYPE_I2, RPGTYPE_N, RPGTYPE_P, RPGTYPE_S, RPGTYPE_STAR, RPGTYPE_T, RPGTYPE_U, RPGTYPE_U2, RPGTYPE_Z, TIMEFMT_EUR, TIMEFMT_HMS, TIMEFMT_ISO, TIMEFMT_JIS, TIMEFMT_NONE, TIMEFMT_USA
 
Constructor Summary
RPGArray()
           
 
Method Summary
 String getExternalFormatType()
           
 String getFromFileName()
           
 String getMainArrayName()
           
 int getPerrcd()
           
 String getToFileName()
           
 boolean isALT()
           
 boolean isAscending()
           
 boolean isCTData()
           
 boolean isDescending()
           
 boolean isExternalFormat()
           
 boolean isFromFile()
           
 boolean isToFile()
           
 void setALT(boolean alt)
          Sets whether this is an alternating array, whose contents is interspliced with another "main" array.
 void setAscending(boolean ascend)
          Sets whether this array is in ascending order.
 void setCTData(boolean b)
          Sets whether this is a compile time array, whose data is supplied at the bottom of the source after the **CTDATA specification.
 void setDescending(boolean descend)
          Sets whether the array is in descending order.
 void setExternalFormat(boolean b)
          Sets whether or not the data type of the array is the same as the type of data in the database file for pre-runtime arrays.
 void setExternalFormatType(String type)
          Sets the type of data in the database file for pre-runtime arrays if the data type of the array is the same; has no effect otherwise.
 void setFromFile(boolean b)
          For pre-runtime arrays, sets whether or not the array data is loaded automatically from the database file specified using setToFileName(String).
 void setFromFileName(String name)
          For pre-runtime arrays where isFromFile() is true, sets the name of the database file from which the array data is loaded, otherwise has no effect.
 void setMainArrayName(String name)
          For alternating arrays, sets the name of the main array whose contents are interspliced with this array, otherwise has no effect on other types of arrays.
 void setPerrcd(int i)
          For compile-time or pre-runtime arrays, sets how many array entries are in each row of the **CTDATA or database file data.
 void setToFile(boolean b)
          For pre-runtime arrays, sets whether or not the array data will be written automatically to the database file specified in setToFileName(String).
 void setToFileName(String name)
          For pre-runtime arrays for which isToFile() is true, sets the name of the database file to which the array data will be written automatically, otherwise has no effect.
 
Methods inherited from class com.ibm.etools.iseries.editor.generator.model.RPGSimpleArray
getDimensions, setDimensions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALT

protected boolean ALT

mainArrayName

protected String mainArrayName

ascending

protected boolean ascending

descending

protected boolean descending

ctdata

protected boolean ctdata

perrcd

protected int perrcd

fromFile

protected boolean fromFile

toFile

protected boolean toFile

fromFileName

protected String fromFileName

toFileName

protected String toFileName

externalFormat

protected boolean externalFormat

externalFormatType

protected String externalFormatType
Constructor Detail

RPGArray

public RPGArray()
Method Detail

isALT

public boolean isALT()
Returns:
Whether this is an alternating array, whose contents is interspliced with another "main" array. The "main" array is named using setMainArrayName(String).
See Also:
#setAlt(), getMainArrayName(), setMainArrayName(String)

isAscending

public boolean isAscending()
Returns:
Whether this array is in ascending order.
See Also:
isDescending(), setAscending(boolean), setDescending(boolean)

isCTData

public boolean isCTData()
Returns:
Whether this is a compile time array, whose data is supplied at the bottom of the source after the **CTDATA specification.
See Also:
setCTData(boolean)

isDescending

public boolean isDescending()
Returns:
Whether the array is in descending order.
See Also:
isAscending(), setDescending(boolean), setAscending(boolean)

isExternalFormat

public boolean isExternalFormat()
Returns:
Whether or not the data type of the array is the same as the type of data in the database file for pre-runtime arrays.
See Also:
setExternalFormat(boolean), getExternalFormatType(), setExternalFormatType(String)

getExternalFormatType

public String getExternalFormatType()
Returns:
The type of data in the database file for pre-runtime arrays if the data type of the array is the same; returns "" otherwise. Note that this is one of the constant String types defined in the IDSpec interface.
See Also:
IDSpec, isExternalFormat(), setExternalFormat(boolean), setExternalFormatType(String)

isFromFile

public boolean isFromFile()
Returns:
For pre-runtime arrays, returns whether or not the array data is loaded automatically from the database file specified using setToFileName(String).
See Also:
setFromFile(boolean), getFromFileName(), setFromFileName(String)

getFromFileName

public String getFromFileName()
Returns:
For pre-runtime arrays where isFromFile() is true, returns the name of the database file from which the array data is loaded, otherwise returns "".
See Also:
isFromFile(), setFromFile(boolean), setFromFileName(String)

getMainArrayName

public String getMainArrayName()
Returns:
For alternating arrays, returns the name of the main array whose contents are interspliced with this array, otherwise returns "".
See Also:
isALT(), setALT(boolean), setMainArrayName(String)

getPerrcd

public int getPerrcd()
Returns:
For compile-time or pre-runtime arrays, returns how many array entries are in each row of the **CTDATA or database file data.
See Also:
setPerrcd(int)

isToFile

public boolean isToFile()
Returns:
For pre-runtime arrays, returns whether or not the array data will be written automatically to the database file specified in setToFileName(String).
See Also:
setToFile(boolean), getToFileName(), setToFileName(String)

getToFileName

public String getToFileName()
Returns:
For pre-runtime arrays for which isToFile() is true, returns the name of the database file to which the array data will be written automatically, otherwise returns "".
See Also:
isToFile(), setToFile(boolean), setToFileName(String)

setALT

public void setALT(boolean alt)
Sets whether this is an alternating array, whose contents is interspliced with another "main" array. The "main" array is named using setMainArrayName(String).

Parameters:
alt - is true if and only if this is an alternating array
See Also:
isALT(), getMainArrayName(), setMainArrayName(String)

setAscending

public void setAscending(boolean ascend)
Sets whether this array is in ascending order. Note: if the array is already set to be in descending order this method has no effect.

Parameters:
ascend - is true if and only if this array is in ascending order.
See Also:
isDescending(), isAscending(), setDescending(boolean)

setCTData

public void setCTData(boolean b)
Sets whether this is a compile time array, whose data is supplied at the bottom of the source after the **CTDATA specification.

Parameters:
b - is true if and only if this is a compile time array.
See Also:
isCTData()

setDescending

public void setDescending(boolean descend)
Sets whether the array is in descending order. Note that this method has no effect if the array is already in ascending order.

Parameters:
descend - is true if and only if this array is to be in descending order
See Also:
isAscending(), isDescending(), setAscending(boolean)

setExternalFormat

public void setExternalFormat(boolean b)
Sets whether or not the data type of the array is the same as the type of data in the database file for pre-runtime arrays.

Parameters:
b - is true if and only if this array has an externally defined format.
See Also:
#getExternalFormat(), getExternalFormatType(), setExternalFormatType(String)

setExternalFormatType

public void setExternalFormatType(String type)
Sets the type of data in the database file for pre-runtime arrays if the data type of the array is the same; has no effect otherwise.

Parameters:
type - is one of the constant String types defined in the IDSpec interface.
See Also:
IDSpec, isExternalFormat(), setExternalFormat(boolean), setExternalFormatType(String)

setFromFile

public void setFromFile(boolean b)
For pre-runtime arrays, sets whether or not the array data is loaded automatically from the database file specified using setToFileName(String).

Parameters:
b - is true if and only if the array data is loaded automatically from an external database file.
See Also:
isFromFile(), getFromFileName(), setFromFileName(String)

setFromFileName

public void setFromFileName(String name)
For pre-runtime arrays where isFromFile() is true, sets the name of the database file from which the array data is loaded, otherwise has no effect.

Parameters:
name - The name of the database file from which the array data is to be loaded.
See Also:
isFromFile(), setFromFile(boolean), getFromFileName()

setMainArrayName

public void setMainArrayName(String name)
For alternating arrays, sets the name of the main array whose contents are interspliced with this array, otherwise has no effect on other types of arrays.

Parameters:
name - the name of the main array
See Also:
isALT(), setALT(boolean), getMainArrayName()

setPerrcd

public void setPerrcd(int i)
For compile-time or pre-runtime arrays, sets how many array entries are in each row of the **CTDATA or database file data.

Parameters:
i - the number of array entries per row of the **CTDATA or database file data
See Also:
getPerrcd()

setToFile

public void setToFile(boolean b)
For pre-runtime arrays, sets whether or not the array data will be written automatically to the database file specified in setToFileName(String).

Parameters:
b - is true if and only if the array data will be written automatically to the database file
See Also:
isToFile(), getToFileName(), setToFileName(String)

setToFileName

public void setToFileName(String name)
For pre-runtime arrays for which isToFile() is true, sets the name of the database file to which the array data will be written automatically, otherwise has no effect.

Parameters:
name - the name of the database file to which the array data willl be written
See Also:
isToFile(), setToFile(boolean), getToFileName()

iSeries Remote Systems
v6.0.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.