Package com.softwaremining.wrappers

Class CBLPointer

java.lang.Object

com.softwaremining.wrappers.AbstractCBLField

com.softwaremining.wrappers.AbstractCBLPrimitive

com.softwaremining.wrappers.AbstractCBLNumeric

com.softwaremining.wrappers.CBLInteger

com.softwaremining.wrappers.CBLPointer

All Implemented Interfaces:

AbstractDataObject, IFormatTypes, ICBLContainer, ICBLDataType, IFieldContainer, ISMDataType, ISMInteger, ISMNumeric, ISMObject

Direct Known Subclasses:

CBLObject

public class CBLPointer
extends CBLInteger

Data Type used for emulation of COBOL Pointer fields. Classes declaring this data-type must inherit from CBLBean (or one of its subclasses).

Field Summary

Fields inherited from class com.softwaremining.wrappers.AbstractCBLField

format, log, 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
CBLPointer(AbstractCBLPrimitive parent, int[] index)
CBLPointer(String name, int[] theDim, CBLBean owner)
CBLPointer(String name, int[] theDim, String picture, CBLBean owner)	Deprecated.
CBLPointer(String name, int[] theDim, String picture, CBLBean owner, int compMode)
CBLPointer(String name, CBLBean owner)	when the Pointer is redefined - it means the offset maybe passed to it via the Redefined field e.g.
CBLPointer(String name, String picture, CBLBean owner)	Deprecated.
CBLPointer(String name, String picture, CBLBean owner, int compMode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
final void	assignDefaultValue(AbstractDataObject data)
final void	assignExemptFromMemRelease(boolean exempt)
void	assignRedefines(AbstractCBLField field)	used internally by the framework to manage the COBOL redefinitions
final void	assignRedefines(AbstractDataObject data)
void	assignToAddressOf(AbstractCBLField targetField)	Translation of COBOL's SET pointer (this) TO ADDRESS OF targetField
void	assignToAddressOf(CBLBean targetWrapper)	Translation of COBOL's SET pointer (this) TO ADDRESS OF targetField
void	assignToAddressOf(CBLBean targetWrapper, long index)	Translation of COBOL's SET pointer (this) TO ADDRESS OF targetField The POINTER dao is expected to be an array of pointers, and the 'index' refers to Pointer array Item.
final void	assignToAddressOf(CBLPointer sourcePointer)	Translation of COBOL's SET pointer (this) TO ADDRESS OF targetField
void	assignValue(double newValue)	Method Used internally by framework Set value of the object
void	assignValue(int newValue)	Method Used internally by framework Set value of the object
void	assignValue(long newValue)	Method Used internally by framework Set value of the object
final void	assignValue(AbstractDataObject data)
final void	assignValue(AbstractDataObject data, int index)	Used internally by SM/ET Generated DAO objects for arrayed Pointers
void	assignValue(String newValue)	used internally by framework for setting object values
protected final AbstractCBLField	createSubField(int[] index)
boolean	equals(CBLPointer pointerField)	checks if Two Pointers point to same area
com.softwaremining.wrappers.CBLBean.StorageManager	getCharArraysManager()
com.softwaremining.wrappers.CBLBean.StorageManager	getCharArraysManager(int index)
com.softwaremining.wrappers.CBLBean.StorageObject	getTopCharArrayObject()
com.softwaremining.wrappers.CBLBean.StorageObject	getTopCharArrayObject(int index)
void	incrementPointerOffset(double pointerOffst)	POINTER ARITHMATIC - limited functionality.
void	incrementPointerOffset(Number pointerOffst)
void	initialize()	method used internally by framework to initialize the field to its defaultValue
boolean	isExemptFromMemRelease()
boolean	isFieldPointer()	a pointer may point to a Field (in same class) or another Data-Access Object (ACMBaseWrappper subclass)
boolean	isNull()	check whether field has been assigned to as yet
boolean	pointsTo(CBLBean targetWrapper)
void	reset()
String	retrieveAsString()	For a group item - it returns the fully expanded String representing the group.
String	retrieveAsStringFormatted()	used internally by framework for getting Stringified object values Returns the "storage" format of the field - for computational fields this would be binary
AbstractDataObject	retrievePointingTo()
Object	retrieveSQLObject()	used internally by framework for database access
CBLPointer	retrieveSubField(int index)
String	stringValue()

Methods inherited from class com.softwaremining.wrappers.CBLInteger

assignValue, assignValue

Methods inherited from class com.softwaremining.wrappers.AbstractCBLNumeric

assignBlankWhenZeros, assignValue, assignValue, bigDecimalValue, bigIntegerValue, compareTo, createBlank, doubleValue, equals, equals, equals, equals, equals, equals, getAsArray, getDefaultSpecialValue, getNumber, getObject, getObjectNoLeftCut, getStorageString, getValue, intValue, intValue, isBlankWhenZero, isFilled, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, longValue, longValue, retrieveAsBigDecimal, retrieveAsBigDecimal, retrieveAsBigDecimal, retrieveAsBigInteger, retrieveAsDouble, retrieveAsDouble, retrieveAsDouble, retrieveAsInt, retrieveAsInt, retrieveAsInt, retrieveAsInt, retrieveAsLong, retrieveAsLong, retrieveAsLong, setBlankWhenZero, setBlankWhenZeros, setRound, setRound

Methods inherited from class com.softwaremining.wrappers.AbstractCBLPrimitive

bytesSize, getPicture, initialize, isGroup, pad, pad, rebuildRestoringInitValues, resetDimensionByIndx, retrieveField, retrieveSQLObject, setObjectAsString

Methods inherited from class com.softwaremining.wrappers.AbstractCBLField

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

intValue, retrieveAsInt

Methods inherited from interface com.softwaremining.wrappers.ISMNumeric

assignValue, doubleValue, getFormat, getNumber, getStorageString, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterOrEqualTo, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isGreaterThan, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, lengthOf, retrieveAsDouble, setRound

Methods inherited from interface com.softwaremining.wrappers.ISMObject

assignExcludeFromSQLTable, assignMasterSQLColumnsForArrays, assignObject, assignString, assignStringFormatted, assignSubstring, bytesSize, fill, isExcludedFromSQLTable, isFiller, retrieveMasterSQLColumnsForArrays, retrieveName, retrieveObject, retrieveSQLObject, retrieveStorageCellSize, retrieveSubField, retrieveWrapper

Constructor Details

CBLPointer

public CBLPointer(String name,
 CBLBean owner)

when the Pointer is redefined - it means the offset maybe passed to it via the Redefined field e.g. 01 WORKING-STORAGE-FIELDS. 03 PTR1 POINTER. 03 INT1 REDEFINES PTR1 PIC S9(09) COMP. ... MOVE 123 to INT1 So, when redefined use the internal CBLInteger value which is shared between this and Redefinition, otherwise use pointerOffset

CBLPointer

public CBLPointer(String name,
 int[] theDim,
 CBLBean owner)

CBLPointer

@Deprecated
public CBLPointer(String name,
 String picture,
 CBLBean owner,
 int compMode)

Deprecated.

CBLPointer

public CBLPointer(String name,
 int[] theDim,
 String picture,
 CBLBean owner,
 int compMode)

CBLPointer

@Deprecated
public CBLPointer(String name,
 String picture,
 CBLBean owner)

Deprecated.

CBLPointer

@Deprecated
public CBLPointer(String name,
 int[] theDim,
 String picture,
 CBLBean owner)

Deprecated.

CBLPointer

public CBLPointer(AbstractCBLPrimitive parent,
 int[] index)

Method Details

createSubField

protected final AbstractCBLField createSubField(int[] index)

Overrides:

createSubField in class CBLInteger

assignValue

public final void assignValue(AbstractDataObject data)

Overrides:

assignValue in class AbstractCBLField

assignValue

public final void assignValue(AbstractDataObject data,
 int index)

Used internally by SM/ET Generated DAO objects for arrayed Pointers

Parameters:

data -

index -

getTopCharArrayObject

public com.softwaremining.wrappers.CBLBean.StorageObject getTopCharArrayObject()

getTopCharArrayObject

public com.softwaremining.wrappers.CBLBean.StorageObject getTopCharArrayObject(int index)

getCharArraysManager

public com.softwaremining.wrappers.CBLBean.StorageManager getCharArraysManager()

getCharArraysManager

public com.softwaremining.wrappers.CBLBean.StorageManager getCharArraysManager(int index)

assignToAddressOf

public final void assignToAddressOf(CBLPointer sourcePointer)

Translation of COBOL's
SET pointer (this) TO ADDRESS OF targetField

Overrides:

assignToAddressOf in class AbstractCBLField

Parameters:

targetField -

assignToAddressOf

public void assignToAddressOf(AbstractCBLField targetField)

Translation of COBOL's
SET pointer (this) TO ADDRESS OF targetField

Specified by:

assignToAddressOf in interface ICBLContainer

Overrides:

assignToAddressOf in class AbstractCBLField

Parameters:

targetField -

assignToAddressOf

public void assignToAddressOf(CBLBean targetWrapper)

Translation of COBOL's
SET pointer (this) TO ADDRESS OF targetField

Specified by:

assignToAddressOf in interface ICBLContainer

Overrides:

assignToAddressOf in class AbstractCBLField

Parameters:

targetWrapper -

targetField -

assignToAddressOf

public void assignToAddressOf(CBLBean targetWrapper,
 long index)

Translation of COBOL's
SET pointer (this) TO ADDRESS OF targetField
The POINTER dao is expected to be an array of pointers, and the 'index' refers to Pointer array Item.
I.e. POINTER (this) OCCURS nn TIMES.

Parameters:

targetField -

assignRedefines

public void assignRedefines(AbstractCBLField field)

Description copied from class: AbstractCBLField

used internally by the framework to manage the COBOL redefinitions

Overrides:

assignRedefines in class AbstractCBLField

isFieldPointer

public boolean isFieldPointer()

a pointer may point to a Field (in same class) or another Data-Access Object (ACMBaseWrappper subclass)

Returns:

true if pointing to a field

isNull

public boolean isNull()

check whether field has been assigned to as yet

Returns:

true if not pointing to anything yet

assignRedefines

public final void assignRedefines(AbstractDataObject data)

retrieveSQLObject

public Object retrieveSQLObject()

Description copied from class: AbstractCBLField

used internally by framework for database access

Specified by:

retrieveSQLObject in interface ISMDataType

Specified by:

retrieveSQLObject in interface ISMObject

Overrides:

retrieveSQLObject in class AbstractCBLField

stringValue

public String stringValue()

Specified by:

stringValue in interface ISMDataType

Overrides:

stringValue in class AbstractCBLField

retrieveAsStringFormatted

public String retrieveAsStringFormatted()

used internally by framework for getting Stringified object values Returns the "storage" format of the field - for computational fields this would be binary

Specified by:

retrieveAsStringFormatted in interface ISMObject

Overrides:

retrieveAsStringFormatted in class AbstractCBLField

retrieveAsString

public String retrieveAsString()

Description copied from class: AbstractCBLField

For a group item - it returns the fully expanded String representing the group. Ie if

   Group contains FIELD-1 PIC (X) OCCURS 4 time.
   field1[0].set("A");
   group.stringValue() returns : "A   " ;
 

For a field - it returns the value. Ie for an integer (PIC X(5)) value 10 it would return "10" , Please also see retrieveAsStringFormatted which would return "10 "

Specified by:

retrieveAsString in interface AbstractDataObject

Specified by:

retrieveAsString in interface ISMDataType

Specified by:

retrieveAsString in interface ISMObject

Overrides:

retrieveAsString in class AbstractCBLField

Returns:

String representation of a group

retrievePointingTo

public AbstractDataObject retrievePointingTo()

assignValue

public void assignValue(String newValue)

Description copied from class: AbstractCBLField

used internally by framework for setting object values

Specified by:

assignValue in interface AbstractDataObject

Specified by:

assignValue in interface ISMDataType

Specified by:

assignValue in interface ISMObject

Overrides:

assignValue in class AbstractCBLField

assignValue

public void assignValue(double newValue)

Description copied from class: AbstractCBLField

Method Used internally by framework Set value of the object

Overrides:

assignValue in class AbstractCBLField

assignValue

public void assignValue(long newValue)

Method Used internally by framework Set value of the object

Overrides:

assignValue in class AbstractCBLField

assignValue

public void assignValue(int newValue)

Method Used internally by framework Set value of the object

Overrides:

assignValue in class AbstractCBLField

initialize

public void initialize()

method used internally by framework to initialize the field to its defaultValue

Specified by:

initialize in interface ISMObject

Overrides:

initialize in class AbstractCBLPrimitive

assignDefaultValue

public final void assignDefaultValue(AbstractDataObject data)

retrieveSubField

public CBLPointer retrieveSubField(int index)

incrementPointerOffset

public void incrementPointerOffset(double pointerOffst)

POINTER ARITHMATIC - limited functionality. EG. in COBOL we can have

  ADD 2 TO WS-SAD-PTR
 

This framework does not work with direct memory position - but instead it will offset the pointer position. THis means if it was pointing to a field X(10), incrementing the address by 2 is equivalant of field.substring(2);

Overrides:

incrementPointerOffset in class AbstractCBLField

incrementPointerOffset

public void incrementPointerOffset(Number pointerOffst)

equals

public boolean equals(CBLPointer pointerField)

checks if Two Pointers point to same area

Overrides:

equals in class AbstractCBLField

Parameters:

value -

Returns:

pointsTo

public boolean pointsTo(CBLBean targetWrapper)

assignExemptFromMemRelease

public final void assignExemptFromMemRelease(boolean exempt)

isExemptFromMemRelease

public boolean isExemptFromMemRelease()

reset

public void reset()