Package com.softwaremining.cics.wrappers

Class BMSString

java.lang.Object

com.softwaremining.wrappers.AbstractCBLField

com.softwaremining.wrappers.AbstractCBLPrimitive

com.softwaremining.wrappers.CBLString

com.softwaremining.cics.wrappers.BMSString

All Implemented Interfaces:

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

public class BMSString
extends CBLString
implements IBMSField

BMS screen define fields which are one of three types:

• length field
• Flag/Attribute field
• Main field (BMSField) - this is where the actual data resides

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	BMSString(AbstractCBLPrimitive parent, int[] index)
	BMSString(String name, int[] theDim, String picture, CBLBean wrapper)
	BMSString(String name, String picture, CBLBean wrapper)

Method Summary

Modifier and Type	Method	Description
AbstractCBLField	createBlank()	For internal use only
AbstractCBLField	createSubField(int[] index)
int	getLengthTyped()	returns the length of characters typed in front end.
boolean	hasFocus()
boolean	isBMSString()	For internal use only.
boolean	isErased()	Checks if the attribute field has modified (MDT) value.
boolean	isErased2()	Checks if the attribute field has LOW-VALUES
boolean	isInputAvailable()	Checks if the number of characters typed by user is greater than 0.
boolean	isInputValid()	checks if the length-field is -1
boolean	isModified()	checks if attrib-A is not equal to Hex40 Value
void	resetAttributes()	Assigns LOW-VALUES to attribute field
void	setColor(String newColour)	For Output Fields COLOR Field is only provided when BMS EXTATT=yes is specified on the original application (rare)
IBMSField	setFocus()	Set focus on the field
IBMSField	setIntensity(int intensity)	changes intensity from default BMSField.INTENSITY_NORMAL to BMSField.INTENSITY_DARK or BMSField.INTENSITY_BRIGHT.
void	setLengthTyped(int newLen)	Resets the length attrib fields to new value
void	setLengthTyped(String newLen)
IBMSField	setModified(boolean modified)	Sets the isModified flag on outgoing field.
IBMSField	setNumeric(boolean numeric)	fields are AlphaNumeric by default.
IBMSField	setProtected(boolean protect)	fields are Unprotected / Enabled by default.
IBMSField	setSkip(boolean skip)	This is equivalent of DISABLING an input field.

Methods inherited from class com.softwaremining.wrappers.CBLString

assignJustifiedRight, assignNewSize, assignValue, assignValue, equals, equalsAll, equalsAll, getAsArray, getDefaultSpecialValue, getObject, getValue, isFiller, isJustifiedRight, isLessThanAll, isLessThanAll, retrieveAsString, retrieveSQLObject, setJustifiedRight

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

BMSString

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

BMSString

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

BMSString

protected BMSString(AbstractCBLPrimitive parent,
 int[] index)

Method Details

createSubField

public AbstractCBLField createSubField(int[] index)

Overrides:

createSubField in class CBLString

setIntensity

public IBMSField setIntensity(int intensity)

Description copied from interface: IBMSField

changes intensity from default BMSField.INTENSITY_NORMAL to BMSField.INTENSITY_DARK or BMSField.INTENSITY_BRIGHT.

Specified by:

setIntensity in interface IBMSField

setNumeric

public IBMSField setNumeric(boolean numeric)

fields are AlphaNumeric by default. NOTE: Setting this to true or false will force the field UN-PROTECTED, and disables the SKIP attribute

Specified by:

setNumeric in interface IBMSField

Parameters:

numeric -

Returns:

setProtected

public IBMSField setProtected(boolean protect)

fields are Unprotected / Enabled by default.

Specified by:

setProtected in interface IBMSField

Parameters:

numeric -

Returns:

setSkip

public IBMSField setSkip(boolean skip)

Description copied from interface: IBMSField

This is equivalent of DISABLING an input field. The cursor will not stop at fields marked as SKIP

Specified by:

setSkip in interface IBMSField

setModified

public IBMSField setModified(boolean modified)

Description copied from interface: IBMSField

Sets the isModified flag on outgoing field. (value of field.isModifiedByFrontEnd() will not have been changed) CICS RECEIVE will only report values which have been altered since previous SEND. E.g. after a Receive statement, bufferI.xyzI will contain NULL values if the on-screen value of XYZ is not changed between SEND and RECEIVE. using bufferI.ObjectxyzI.SetModified(true) will ensure the ON-SCREEN value is returned irrespective of whether it had been modified or not.

Specified by:

setModified in interface IBMSField

Parameters:

modified -

Returns:

setFocus

public IBMSField setFocus()

Description copied from interface: IBMSField

Set focus on the field

Specified by:

setFocus in interface IBMSField

getLengthTyped

public int getLengthTyped()

Description copied from interface: IBMSField

returns the length of characters typed in front end. E.g. if the field has been defined as 20 chars, but user has only typed "ABC" - then value 3 will be returned.

Specified by:

getLengthTyped in interface IBMSField

setLengthTyped

public void setLengthTyped(int newLen)

Description copied from interface: IBMSField

Resets the length attrib fields to new value

Specified by:

setLengthTyped in interface IBMSField

setLengthTyped

public void setLengthTyped(String newLen)

isInputValid

public boolean isInputValid()

Description copied from interface: IBMSField

checks if the length-field is -1

Specified by:

isInputValid in interface IBMSField

Returns:

isModified

public boolean isModified()

checks if attrib-A is not equal to Hex40 Value

Specified by:

isModified in interface IBMSField

isInputAvailable

public boolean isInputAvailable()

Checks if the number of characters typed by user is greater than 0.
ie if L-Field has greater than 0 characters.

Specified by:

isInputAvailable in interface IBMSField

Returns:

isErased

public boolean isErased()

Checks if the attribute field has modified (MDT) value.

Specified by:

isErased in interface IBMSField

Returns:

isErased2

public boolean isErased2()

Checks if the attribute field has LOW-VALUES

Specified by:

isErased2 in interface IBMSField

resetAttributes

public void resetAttributes()

Assigns LOW-VALUES to attribute field

Specified by:

resetAttributes in interface IBMSField

createBlank

public AbstractCBLField createBlank()

For internal use only

Overrides:

createBlank in class CBLString

Returns:

setColor

public void setColor(String newColour)

For Output Fields COLOR Field is only provided when BMS EXTATT=yes is specified on the original application (rare)

Specified by:

setColor in interface IBMSField

Parameters:

newColour -

hasFocus

public boolean hasFocus()

isBMSString

public boolean isBMSString()

For internal use only.
This provides same functionality of if (this instanceOf BMSString) without building a dependency on CICS libraries.

Overrides:

isBMSString in class AbstractCBLField

Returns: