Package com.softwaremining.wrappers

Class CBLString

java.lang.Object

com.softwaremining.wrappers.AbstractCBLField

com.softwaremining.wrappers.AbstractCBLPrimitive

com.softwaremining.wrappers.CBLString

All Implemented Interfaces:

AbstractDataObject, IFormatTypes, ICBLContainer, ICBLDataType, IFieldContainer, ISMDataType, ISMObject, ISMString

Direct Known Subclasses:

BMSBlankString, BMSString, CBLBlankString, CBLFiller

public class CBLString
extends AbstractCBLPrimitive
implements ISMString

data type for representation of COBOL String formats.
Support packed decimals, redefines, occurs depending , ...

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

Modifier	Constructor	Description
protected	CBLString()	for internal use only.
	CBLString(AbstractCBLPrimitive parent, int[] index)
	CBLString(String name, int[] theDim, String picture, CBLBean wrapper)
	CBLString(String name, int[] theDim, String picture, CBLBean wrapper, int mode)
	CBLString(String name, String picture, CBLBean wrapper)
	CBLString(String name, String picture, CBLBean wrapper, int mode)

Method Summary

Modifier and Type	Method	Description
final void	assignJustifiedRight(boolean justifiedRight)
void	assignNewSize(int newSize)
final void	assignValue(AbstractCBLField field)	Set value of the object
final void	assignValue(AbstractCBLField field, int[] indexes)	Method Used internally by framework Set value of the object
AbstractCBLField	createBlank()	For internal use only.
protected AbstractCBLField	createSubField(int[] index)
boolean	equals(RangeItem[] value)	check against 88-RangeItems
boolean	equalsAll(char value)	SAS 03.03.2009 Lexicographical comparison operator
boolean	equalsAll(String value)	SAS 03.03.2009 Lexicographical comparison operator
final String[]	getAsArray()	SAS 11.03.2009 returns table as an array of values
final int	getDefaultSpecialValue()
final Object	getObject(String value)
String	getValue(int idx)	Arrayed Accessor - for single dimenSion arrays ...
boolean	isFiller()	used internally by the framework to indicate if a field represents COBOL FILLER
final boolean	isJustifiedRight()
boolean	isLessThanAll(char value)	SAS 03.03.2009 Lexicographical comparison operator
boolean	isLessThanAll(String value)	SAS 03.03.2009 Lexicographical comparison operator
String	retrieveAsString()	For a group item - it returns the fully expanded String representing the group.
final Object	retrieveSQLObject(int[] indexes)	method used internally by framework Get values from an SQL table and then caches it.
final void	setJustifiedRight(boolean justifiedRight)	Deprecated. - use assignJustifiedRight

Methods inherited from class com.softwaremining.wrappers.AbstractCBLPrimitive

bytesSize, getPicture, initialize, initialize, isGroup, pad, pad, rebuildRestoringInitValues, resetDimensionByIndx, retrieveField, 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, 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, assignValueUnFormatted, enableSizeErrDetectionOnNextOp, equals, equals, equals, equals, equals, 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, incrementPointerOffset, invokeSizeError, isArrayOfArrays, isBMSString, isCachable, isCachedArrayLengthActual, isCacheStateOK, isEmpty, isEqualToAll, isExcludedFromSQLTable, isFilled, isFilled, isFilled, isFilled, 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, 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, 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.AbstractDataObject

assignValue, retrieveStorageCellSize

Methods inherited from interface com.softwaremining.wrappers.ISMObject

assignExcludeFromSQLTable, assignMasterSQLColumnsForArrays, assignObject, assignString, assignStringFormatted, assignValue, bytesSize, initialize, isExcludedFromSQLTable, retrieveAsStringFormatted, retrieveMasterSQLColumnsForArrays, retrieveName, retrieveObject, retrieveSQLObject, retrieveStorageCellSize, retrieveSubField, retrieveWrapper

Methods inherited from interface com.softwaremining.wrappers.ISMString

assignSubstring, assignValue, equalsRightTrimmed, fill, fill, getFormat, isFilled, lengthOf, retrieveSubstring, retrieveSubstring, stringValue

Constructor Details

CBLString

protected CBLString()

for internal use only. Do not use.

CBLString

public CBLString(String name,
 String picture,
 CBLBean wrapper)

CBLString

public CBLString(String name,
 String picture,
 CBLBean wrapper,
 int mode)

CBLString

public CBLString(String name,
 int[] theDim,
 String picture,
 CBLBean wrapper,
 int mode)

CBLString

public CBLString(String name,
 int[] theDim,
 String picture,
 CBLBean wrapper)

CBLString

public CBLString(AbstractCBLPrimitive parent,
 int[] index)

Method Details

createSubField

protected AbstractCBLField createSubField(int[] index)

Specified by:

createSubField in class AbstractCBLField

setJustifiedRight

public final void setJustifiedRight(boolean justifiedRight)

Deprecated.

- use assignJustifiedRight

Parameters:

justifiedRight -

assignJustifiedRight

public final void assignJustifiedRight(boolean justifiedRight)

isJustifiedRight

public final boolean isJustifiedRight()

Specified by:

isJustifiedRight in interface ISMString

getObject

public final Object getObject(String value)

retrieveSQLObject

public final Object retrieveSQLObject(int[] indexes)

Description copied from class: AbstractCBLPrimitive

method used internally by framework Get values from an SQL table and then caches it.

Specified by:

retrieveSQLObject in interface ISMObject

Overrides:

retrieveSQLObject in class AbstractCBLPrimitive

getDefaultSpecialValue

public final int getDefaultSpecialValue()

assignValue

public final void assignValue(AbstractCBLField field)

Description copied from class: AbstractCBLField

Set value of the object

Overrides:

assignValue in class AbstractCBLField

assignValue

public final void assignValue(AbstractCBLField field,
 int[] indexes)

Description copied from class: AbstractCBLField

Method Used internally by framework Set value of the object

Overrides:

assignValue in class AbstractCBLField

equals

public boolean equals(RangeItem[] value)

check against 88-RangeItems

Overrides:

equals in class AbstractCBLField

isLessThanAll

public boolean isLessThanAll(char value)

SAS 03.03.2009 Lexicographical comparison operator

equalsAll

public boolean equalsAll(char value)

SAS 03.03.2009 Lexicographical comparison operator

isLessThanAll

public boolean isLessThanAll(String value)

SAS 03.03.2009 Lexicographical comparison operator

equalsAll

public boolean equalsAll(String value)

SAS 03.03.2009 Lexicographical comparison operator

retrieveAsString

public String retrieveAsString()

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 returnes 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

getValue

public String getValue(int idx)

Arrayed Accessor - for single dimenSion arrays ... Eg

Parameters:

arrayElement - - arrayElement

Returns:

getAsArray

public final String[] getAsArray()

SAS 11.03.2009 returns table as an array of values

Returns:

array of field values

createBlank

public AbstractCBLField createBlank()

For internal use only.

isFiller

public boolean isFiller()

Description copied from class: AbstractCBLField

used internally by the framework to indicate if a field represents COBOL FILLER

Specified by:

isFiller in interface ISMObject

Overrides:

isFiller in class AbstractCBLField

Returns:

assignNewSize

public void assignNewSize(int newSize)