com.ibm.pdp.maf.rpp.pac.program
Interface CDLineDataStructure

All Superinterfaces:
CDLine, Element

public interface CDLineDataStructure
extends CDLine

CDLineDataStrucure are used to describe three basic types of elements, which are specified in the Organization field:

For each external resource, you have its:


Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getAccessKeyDataElementCode()
          This code, on six characters, is required for indexed Data Structures.
 int getBlockFactor()
          This field, on five characters, is required for the generation of the BLOCK CONTAINS clause.
 ProgramBlockTypeValues getBlockType()
          Specify here whether the block size entered in the Block factor field represents a number of records, characters, or whether it must be ignored for the block management.
 int getBreakLevel()
          For sequentially accessed, sorted files, it is the number of Data Elements (elementary or group) on which a control break processing is specified for the Data Structure.
 java.util.List<DataStructureCall> getDataStructureCalls()
          List of the DataStrucutre called.
 java.lang.String getFileStatus()
          This field is optional.
 java.lang.String getPhysicalUnitType()
          The possible unit type varies according to the Type of COBOL code: Type of COBOL code = 1: IBM DOS/VSE: Enter the model type (examples: 2314, 3330, 2400) Type of COBOL code = 3: UNIX, WINDOWS:EXT = Generation of the EXTERNAL clause at the file FD level LS = Generation of the LINE SEQUENTIAL clause EXLS = Generation of the LINE SEQUENTIAL clause and of the EXTERNAL clause at the file FD level Type of COBOL code = Q: ACUCOBOL: LS = Generation of the LINE SEQUENTIAL clause Type of COBOL code = 4: BULL GCOS7: SSF = Option WITH SSF in the SELECT clause OUT = Option -SYSOUT suffix after the file name in the SELECT clause (WITH SSF is generated).
 ProgramPhysicalUnitTypeComplementValues getPhysicalUnitTypeComplement()
          It is a complement to the Physical unit type field.
 java.lang.String getRecordTypeDataElementCode()
          Code of the Data Element whose values identify the different record types of a Data Structure.
 java.lang.String getResultDataStructureCode()
          If the Data Structure has a Usage set to P: Principal, it is the Code in program' of the result output Data Structure (two characters).
 java.lang.String getSortKeys()
          It is the group of the Data Elements which make up the sort key for control break processing.
 java.lang.String getSourceDataStructureCode()
          If the Data Structure has a Usage set to:M: Transaction to be validated or N: Transaction not to be validated, it us the Code in program (on two characters) of the transaction file which contains the errors (Usage set to E: Transaction with error checking), if such a file has been called.
 int getSyncLevel()
          For sequentially accessed files, this field is used to set the synchronization of two or more files.
 int getTransactionBreakLevel()
          In a transaction file, it is the position, within the sort key, of the Action code (entered on the Segment Definition tab).
 
Methods inherited from interface com.ibm.pdp.maf.rpp.pac.program.CDLine
getAccessMode, getBlockMode, getCobolPosition, getCobolRecordLevel, getExternalName, getFormatType, getGeneratedDescriptionType, getIOMode, getOrganization, getSubScheme, getUnitType, getUsage
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getAccessKeyDataElementCode

java.lang.String getAccessKeyDataElementCode()

This code, on six characters, is required for indexed Data Structures.

Returns:

getBlockFactor

int getBlockFactor()

This field, on five characters, is required for the generation of the BLOCK CONTAINS clause.

It must contain a numeric value. It corresponds to the block size (the size of the physical record). Spaces and zeros are equivalent.

The block size can be zero for:

The BLOCK CONTAINS clause is not generated in the following cases:

Returns:

getBlockType

ProgramBlockTypeValues getBlockType()

Specify here whether the block size entered in the Block factor field represents a number of records, characters, or whether it must be ignored for the block management.

Returns:

getBreakLevel

int getBreakLevel()

For sequentially accessed, sorted files, it is the number of Data Elements (elementary or group) on which a control break processing is specified for the Data Structure.

O is the default value.

1 to 9 levels, according to the number of Data Elements to be used for control break processing. These Data Elements are identified as the Sort key composition field for this Data Structure.

When there is a control break processing on a Data Structure, two indicators keep track of the status of the records being processed

Below, the term 'umpteenth key Data Element' includes all the key Data Elements up to and including the umpteenth level:

When these files are synchronized with others, the control breaks are kept synchronized through two additional switches:

For output files (Usage set to D: Output file): A value other than zero creates a duplicate file layout to be generated in the WORKING-STORAGE SECTION, prefixed by 1-. However you are advised to specify it in the work areas, using micropatterns.

Returns:

getDataStructureCalls

java.util.List<DataStructureCall> getDataStructureCalls()

List of the DataStrucutre called.

Returns:

getFileStatus

java.lang.String getFileStatus()

This field is optional.

If specified, it is a character string, on 10 characters maximum, in the following format:

ddsseeeeee, where:

The use of this field varies according to the Type of COBOL code and to the Data Structure call Organization.

Returns:

getPhysicalUnitType

java.lang.String getPhysicalUnitType()

The possible unit type varies according to the Type of COBOL code:

A V in the fourth position generates the clause VALUE OF FILE-ID is 3-FF00-IDENT (FF is the Data Structure Code in program). The field 3-FF00-IDENT must be defined in work areas by the user.

For the two-character codes, a third character can specify a particular final disposition:

A V in the fourth position generates the clause VALUE OF D.S. NAME IS 3-FF00-IDENT.

These four data names are to be declared in work area lines with their appropriate values.

Returns:

getPhysicalUnitTypeComplement

ProgramPhysicalUnitTypeComplementValues getPhysicalUnitTypeComplement()

It is a complement to the Physical unit type field. The purpose of this field varies according to the Type of COBOL code.

Returns:

getRecordTypeDataElementCode

java.lang.String getRecordTypeDataElementCode()

Code of the Data Element whose values identify the different record types of a Data Structure.

This Data Element must belong to the common part Segment (00 Segment).

This name can also be specified in the Structure code field of the Segment Definition tab.

Returns:

getResultDataStructureCode

java.lang.String getResultDataStructureCode()

If the Data Structure has a Usage set to P: Principal, it is the Code in program' of the result output Data Structure (two characters).

If the Data Structure has a Usage set to R: Result or D: Output file, it is the Code in program of the principal input Data Structure (two characters).

Returns:

getSortKeys

java.lang.String getSortKeys()

It is the group of the Data Elements which make up the sort key for control break processing.

They are identified by the value entered in the Sort key field on the Segment -CE Lines tab.

The order for sorting these key Data Elements can be entered here. To do so, you use the values assigned on the -CE Lines tab in the appropriate order, from major to minor - left to right.

If you do enter anything here, the Data Elements coded with value 1 - 9 are taken as the default.

Note: For transaction files, include the 'action code' and 'record type' Data Elements as a part of the key. The order in which these Data Elements are sorted determines the sequence in which the transactions update the principal file, and the policy for duplicate record detection.

Returns:

getSourceDataStructureCode

java.lang.String getSourceDataStructureCode()

If the Data Structure has a Usage set to:

S: Selected, you must enter the Code in program (on two characters) of the input source. On the source Data Structure call line, you must enter the Code in program of the selected Data Structure.

Returns:

getSyncLevel

int getSyncLevel()

For sequentially accessed files, this field is used to set the synchronization of two or more files.

O is the default value.

1 to 9 levels. Enter the number of Data Elements (elementary or group) on which a file matching is to be synchronized for this Data Structure. This number identifies the number of the key fields (identified in the Sort key composition field) that are involved in the synchronization.

For an automatic synchronization, the following conditions must be met:

These Data Elements must have a display format (if they are numeric, they must be whole numbers and unsigned).

The switches generated to control file synchronization are:

Returns:

getTransactionBreakLevel

int getTransactionBreakLevel()

In a transaction file, it is the position, within the sort key, of the Action code (entered on the Segment Definition tab).

Example: If the value of the Sort key is ABCDE and the Action code is D, the value is 4.

It is the most minor key of the sort key. It is used to differentiate one type of transaction from another in the same principal file. Duplicates are detected if any key elements below this one are found to match.

By default, the value of this field is that of the Break level already entered in the previous window. The value must be one-character long.

Note: All spaces are replaced with zeros.

Returns: