For use with Java applications generated by SoftwareMining's COBOL-to-Java conversion tools.

Package com.softwaremining.wrappers

Class CBLGroup

java.lang.Object

com.softwaremining.wrappers.AbstractCBLField

com.softwaremining.wrappers.CBLGroup

All Implemented Interfaces:

AbstractDataObject, IFormatTypes, ICBLBeanNGroup, ICBLContainer, ICBLDataType, IFieldContainer, ISMDataType, ISMGroup, ISMObject

Direct Known Subclasses:

BMSGroup

public class CBLGroup
extends AbstractCBLField
implements ISMGroup, ICBLBeanNGroup

Representation of a COBOL Group Item.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ADD_CORRESPONDING
static final int	ASSIGN_CORRESPONDING
protected OrderedMap	fieldsMap
protected static Log	log
static final int	SUBTRACT

Fields inherited from class com.softwaremining.wrappers.AbstractCBLField

format, NEEDS_FORMATING, readjustIndex_counter, resetWrapperOffsetCount, STRINGIFY_BEFORE_FORMATTING, totalRuntime_ACMFieldConstructor, totalRuntime_arrayUtilityReadjustIndex, totalRuntime_cachingTime, totalRuntime_getSubField, totalRuntime_getSubField_createSubField, totalRuntime_getSubField_createSubField_count, totalRuntime_getSubField_setSubFieldHelper, totalRuntime_getSubFieldHelper, totalruntime_getSubFields_b, totalRuntime_getWrapperOffset, totalRuntime_resetWrapperOffset, totalRuntime_setInternalValue, wrapperOffsetCount

Fields inherited from interface com.softwaremining.wrappers.format.IFormatTypes

COMP_MODE_COMP, COMP_MODE_COMP_1, COMP_MODE_COMP_2, COMP_MODE_COMP_3, COMP_MODE_COMP_4, COMP_MODE_COMP_5, COMP_MODE_COMP_6, COMP_MODE_COMP_7, COMP_MODE_COMP_8, COMP_MODE_COMP_MCP, COMP_MODE_COMP_X, COMP_MODE_DISPLAY, COMP_MODE_DISPLAY_SIGN_IS_LEADING, COMP_MODE_DISPLAY_SIGN_IS_SEPARATE_LEADING, COMP_MODE_DISPLAY_SIGN_IS_SEPARATE_TRAILING, COMP_MODE_DISPLAY_SIGN_IS_TRAILING, COMP_MODE_IDS_DB_KEY, COMP_MODE_NATIVE_2, COMP_MODE_NATIVE_4, COMP_MODE_NATIVE_8, COMP_MODE_REAL, COMP_MODE_UNSUPPORTED, JUSTIFIED_RIGHT_FALSE, JUSTIFIED_RIGHT_TRUE

Constructor Summary

Constructors

Constructor	Description
CBLGroup(CBLGroup parent, int[] index)
CBLGroup(String name, AbstractCBLField[] fields, int[] theDim, int[] offsetIndex, CBLBean wrapper)	constructor
CBLGroup(String name, ICBLDataType[] fields, int[] dim, CBLBean wrapper)
CBLGroup(String name, ICBLDataType[] fields, CBLBean wrapper)	constructor

Method Summary

Modifier and Type	Method	Description
void	addCorrespondingValue(CBLBean target)	for translation of COBOL MOVE CORRESPONDING statements
void	addCorrespondingValue(CBLGroup target)	for translation of COBOL's ADD CORRESPONDING statements
final void	addField(AbstractCBLField field)
final void	addFieldWithoutNumOccurs(AbstractCBLField field)
void	assignBean(CBLBean sourceBean)	Set value of the object
void	assignCorrespondingValue(CBLBean target)	for translation of COBOL MOVE CORRESPONDING statements
void	assignCorrespondingValue(CBLGroup target)	for translation of COBOL MOVE CORRESPONDING statements
void	assignGroup(CBLGroup sourceGroup)	Set value of the object
int	bytesSize()	accounts for field sizes and Array SIZEs E.g.
final boolean	containsField(AbstractCBLField aField, boolean recursive)	checks if Group contains the field.
AbstractCBLField	createBlank()
protected AbstractCBLField	createSubField(int[] index)
final void	deleteField(int idx)
final void	deleteField(String name)
final int	fieldsCount()
final AbstractCBLField[]	getDirectChildFields()	get a list of all the DIRECT children (not the grand-children)
final AbstractCBLField	getField(int idx)
final Format	getFormat()	used internally by the framework
void	initialize()	Implementation of COBOL INITIALIZE
final boolean	isEsql49LevelIndicator()
final boolean	isGroup()	differentiate between fields and groups.
String	printFieldPosition()	returns the name of all fields and their memory position This method is used only for debugging purpose
final void	readPointerAddressesFromWrapper(CBLGroup source)	method used internally by framework transfers the address of Pointers assigned to CBLBeans, from Source Structure to the target Structure
void	rebuildRestoringInitValues(boolean alreadyInitialized)	For internal use only.
protected final void	resetDimensionByIndx(int dimensionValue, int dimensionIndx, AbstractCBLField owner)	Method used for reseting of dimensions.
List<AbstractCBLField>	retrieveCompressedFields()
final AbstractCBLField	retrieveField(String name)
final List<AbstractCBLField>	retrievePrimitiveFields()	get all the Primitive Fields (children, and grand-children) - ie ISMString, ISMInteger ...
Object	retrieveSQLObject(int[] indexes)	used internally by framework for database access
final void	setEsql49LevelIndicator(boolean esql49LevelIndicator)
final void	setObjectAsString(int[] indexes, String strValue)
void	subtractCorrespondingValue(CBLBean target)	for translation of COBOL SUBTRACT CORRESPONDING statements
void	subtractCorrespondingValue(CBLGroup target)	for translation of COBOL MOVE CORRESPONDING statements
String	toEbcdic()	convert this record to Ebcdic

Methods inherited from class com.softwaremining.wrappers.AbstractCBLField

addDependedField, assignAddressTo, assignBigDecimal, assignDefaultValue, assignDefaultValue, assignDependingField, assignDouble, assignExcludeFromSQLTable, assignExternal, assignHighValues, assignHighValues, assignInt, assignLong, assignLowValues, assignLowValues, assignMasterSQLColumnsForArrays, assignObject, assignOverrideSQLTableName, assignPointerOffset, assignRedefines, assignRedefines, assignSeparateColumn, assignSeparateTable, assignString, assignString, assignStringFormatted, assignStringFormatted, assignSubstring, assignSubstring, assignSubstring, assignSubstring, assignSubstring, assignSubstringDeprecated, assignToAddressOf, assignToAddressOf, assignToAddressOf, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValueUnFormatted, enableSizeErrDetectionOnNextOp, equals, equals, equals, equals, equals, equals, equals, equalsRightTrimmed, fetchParentArray, fill, fill, fill, fill, fill, getAllSubFields, getArrayLength, getAsString, getCachedValue, getDefaultValue, getDependedFieldsList, getDimensions, getMemoryPosition, getNumberOfSQLColumns, getNumOccurs, getObject, getOffsets, getParentGroup, getRedefines, getReverseRedefines, getSubFields, incrementPointerOffset, invokeSizeError, isArrayOfArrays, isBMSString, isCachable, isCachedArrayLengthActual, isCacheStateOK, isEmpty, isEqualToAll, isExcludedFromSQLTable, isFilled, isFilled, isFilled, isFilled, isFiller, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isHighValues, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, isLowValues, isSeparateColumns, isSeparateTable, isSpaces, isSubField, isUsedInRedefines, isZeros, lengthOf, onSizeError, printDetailAndValue, printDetails, redefinesAnotherField, resetCachedValue, retrieveAsString, retrieveAsString, retrieveAsStringFormatted, retrieveAsStringFormatted, retrieveMasterSQLColumnsForArrays, retrieveName, retrieveObject, retrieveSQLObject, retrieveSQLTableNameOverride, retrieveStorageBytes, retrieveStorageBytes, retrieveStorageCellSize, retrieveSubField, retrieveSubstring, retrieveSubstring, retrieveWrapper, setCachedValue, setHighValues, setHighValues, setLowValues, setLowValues, setNumberOfSQLColumns, setNumOccurs, setOmitted, setParentGroup, setSeparateColumn, setSeparateTable, setSubstring, setSubstring, setSubstring, setSubstring, setWrapper, stringValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwaremining.wrappers.ISMDataType

stringValue

Methods inherited from interface com.softwaremining.wrappers.ISMGroup

retrieveName

Methods inherited from interface com.softwaremining.wrappers.ISMObject

assignExcludeFromSQLTable, assignMasterSQLColumnsForArrays, assignObject, assignString, assignStringFormatted, assignSubstring, assignValue, assignValue, fill, isExcludedFromSQLTable, isFiller, retrieveAsString, retrieveAsStringFormatted, retrieveMasterSQLColumnsForArrays, retrieveObject, retrieveSQLObject, retrieveStorageCellSize, retrieveSubField, retrieveWrapper

Field Details

log

protected static transient Log log

fieldsMap

protected OrderedMap fieldsMap

ASSIGN_CORRESPONDING

public static final int ASSIGN_CORRESPONDING

See Also:

• Constant Field Values

ADD_CORRESPONDING

public static final int ADD_CORRESPONDING

See Also:

• Constant Field Values

SUBTRACT

public static final int SUBTRACT

See Also:

• Constant Field Values

Constructor Details

CBLGroup

public CBLGroup(String name,
 ICBLDataType[] fields,
 CBLBean wrapper)

constructor

CBLGroup

public CBLGroup(String name,
 ICBLDataType[] fields,
 int[] dim,
 CBLBean wrapper)

CBLGroup

public CBLGroup(String name,
 AbstractCBLField[] fields,
 int[] theDim,
 int[] offsetIndex,
 CBLBean wrapper)

constructor

CBLGroup

public CBLGroup(CBLGroup parent,
 int[] index)

Method Details

getFormat

public final Format getFormat()

Description copied from class: AbstractCBLField

used internally by the framework

Overrides:

getFormat in class AbstractCBLField

Returns:

bytesSize

public int bytesSize()

Description copied from class: AbstractCBLField

accounts for field sizes and Array SIZEs E.g. FIELD1 PIC X OCCURS 100 times. The cellsize is 1, but bytesSize() returns 100

Specified by:

bytesSize in interface ISMObject

Specified by:

bytesSize in class AbstractCBLField

retrieveField

public final AbstractCBLField retrieveField(String name)

Specified by:

retrieveField in interface IFieldContainer

getField

public final AbstractCBLField getField(int idx)

Specified by:

getField in interface ISMGroup

addField

public final void addField(AbstractCBLField field)

addFieldWithoutNumOccurs

public final void addFieldWithoutNumOccurs(AbstractCBLField field)

deleteField

public final void deleteField(int idx)

deleteField

public final void deleteField(String name)

fieldsCount

public final int fieldsCount()

Specified by:

fieldsCount in interface ISMGroup

setObjectAsString

public final void setObjectAsString(int[] indexes,
 String strValue)

isGroup

public final boolean isGroup()

Description copied from class: AbstractCBLField

differentiate between fields and groups.

Specified by:

isGroup in class AbstractCBLField

resetDimensionByIndx

protected final void resetDimensionByIndx(int dimensionValue,
 int dimensionIndx,
 AbstractCBLField owner)

Description copied from class: AbstractCBLField

Method used for reseting of dimensions. for example if occurrences of this field depends from another field value (DEPENDING ON)

Specified by:

resetDimensionByIndx in class AbstractCBLField

Parameters:

dimensionValue -

dimensionIndx -

owner -

createSubField

protected AbstractCBLField createSubField(int[] index)

Specified by:

createSubField in class AbstractCBLField

getDirectChildFields

public final AbstractCBLField[] getDirectChildFields()

get a list of all the DIRECT children (not the grand-children)

Specified by:

getDirectChildFields in interface ISMGroup

Returns:

containsField

public final boolean containsField(AbstractCBLField aField,
 boolean recursive)

checks if Group contains the field. If 'recursive' = false, then only direct child fields are considered, If 'recursive' = false, then only direct child fields are considered,

Parameters:

aField - - field to look for

recursive - - whether to look into owned groups.

Returns:

retrievePrimitiveFields

public final List<AbstractCBLField> retrievePrimitiveFields()

get all the Primitive Fields (children, and grand-children) - ie ISMString, ISMInteger ... but all the Groups will be expanded to include their fields .

Specified by:

retrievePrimitiveFields in interface ICBLBeanNGroup

retrieveCompressedFields

public List<AbstractCBLField> retrieveCompressedFields()

assignCorrespondingValue

public void assignCorrespondingValue(CBLBean target)

for translation of COBOL MOVE CORRESPONDING statements

Parameters:

target -

assignCorrespondingValue

public void assignCorrespondingValue(CBLGroup target)

for translation of COBOL MOVE CORRESPONDING statements

Parameters:

target -

addCorrespondingValue

public void addCorrespondingValue(CBLBean target)

for translation of COBOL MOVE CORRESPONDING statements

Parameters:

target -

addCorrespondingValue

public void addCorrespondingValue(CBLGroup target)

for translation of COBOL's ADD CORRESPONDING statements

Parameters:

target -

subtractCorrespondingValue

public void subtractCorrespondingValue(CBLBean target)

for translation of COBOL SUBTRACT CORRESPONDING statements

Parameters:

target -

subtractCorrespondingValue

public void subtractCorrespondingValue(CBLGroup target)

for translation of COBOL MOVE CORRESPONDING statements

Parameters:

target -

isEsql49LevelIndicator

public final boolean isEsql49LevelIndicator()

Specified by:

isEsql49LevelIndicator in interface ISMGroup

setEsql49LevelIndicator

public final void setEsql49LevelIndicator(boolean esql49LevelIndicator)

Specified by:

setEsql49LevelIndicator in interface ISMGroup

retrieveSQLObject

public Object retrieveSQLObject(int[] indexes)

used internally by framework for database access

Specified by:

retrieveSQLObject in interface ISMObject

Specified by:

retrieveSQLObject in class AbstractCBLField

toEbcdic

public String toEbcdic()

convert this record to Ebcdic

Overrides:

toEbcdic in class AbstractCBLField

initialize

public void initialize()

Description copied from class: AbstractCBLField

Implementation of COBOL INITIALIZE

Specified by:

initialize in interface ISMObject

Specified by:

initialize in class AbstractCBLField

rebuildRestoringInitValues

public void rebuildRestoringInitValues(boolean alreadyInitialized)

Description copied from class: AbstractCBLField

For internal use only.
Used under certain circumstances in CICS (STORAGE 00).
It clears the data, restoring INITIAL-VALUES as defined in original-COBOL

Specified by:

rebuildRestoringInitValues in class AbstractCBLField

readPointerAddressesFromWrapper

public final void readPointerAddressesFromWrapper(CBLGroup source)

method used internally by framework
transfers the address of Pointers assigned to CBLBeans, from Source Structure to the target Structure

Parameters:

source - wrapper

assignBean

public void assignBean(CBLBean sourceBean)

Set value of the object

Overrides:

assignBean in class AbstractCBLField

assignGroup

public void assignGroup(CBLGroup sourceGroup)

Set value of the object

Overrides:

assignGroup in class AbstractCBLField

createBlank

public AbstractCBLField createBlank()

printFieldPosition

public String printFieldPosition()

returns the name of all fields and their memory position This method is used only for debugging purpose

Returns: