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

Package com.softwaremining.containers

Class AbstractContainerBean

java.lang.Object

com.softwaremining.containers.AbstractContainerBean

All Implemented Interfaces:

AbstractDataObject, ISMBean, ISMDataType, ISMObject

Direct Known Subclasses:

AbstractORContainer, AbstractSSABean

public abstract class AbstractContainerBean
extends Object
implements AbstractDataObject, ISMObject, ISMBean

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	sessionId

Constructor Summary

Constructors

Constructor	Description
AbstractContainerBean()	standard constructor
AbstractContainerBean(BaseService owner)	standard constructor

Method Summary

Modifier and Type	Method	Description
void	assignDefaultValue(String newValue)
final void	assignEbcdicValue(String newValue)	set the value of this record to EBCDIC bytes passed
void	assignEncodedValue(String theLine)	Used by the file-readers - to convert to /from ebcdic IF the flag DATAFILES_ARE_EBCDIC is set
void	assignExcludeFromSQLTable(boolean excludeFromSQLTable)
void	assignExemptFromMemRelease(boolean exempt)
void	assignHighValues()
final void	assignHighValues(int startPos, int length)	Equivalent of COBOL HIGH VALUES
void	assignLowValues()
final void	assignLowValues(int startPos, int length)	Equivalent of COBOL LOW VALUES
void	assignMasterSQLColumnsForArrays(String[] columnNames)	For Unisys DMS Support
void	assignObject(int[] idx, Object value)
void	assignOverrideSQLTableName(String tableName)
void	assignSessionId(Long sessionId)	For internal use only
void	assignString(String newValue)
final void	assignStringFormatted(String newValue)
final void	assignSubstring(int offset, int length, String newValue)	translation of MOVE 'A' TO ABC (5:4)
void	assignValue(ISMBean wrapper)	Assign Field Values
void	assignValue(Object obj)
void	assignValue(String newValue)	Assign a value to this DA (CBL type implementations will take care of REDEFINITIONS, OCCURS DEPENDING, Packed=Decimal fields, ...)
int	bytesSize()
boolean	equalsRightTrimmed(String theVal)
void	fill(int startPos, int length, String filler)
void	fill(String filler)
String	getValue()
protected void	initDefaultValues()
void	initialize()	Equivalent of COBOL's INITIALIZE statement
void	initializeMD()
boolean	isExcludedFromSQLTable()
boolean	isExemptFromMemRelease()
boolean	isFilled(char filler)
boolean	isFilled(String filler)
boolean	isFiller()
boolean	isResourceAlreadyReleased()
void	releaseResources()	this is called internally - after a program is CANCEL'ed.
void	releaseResources(boolean forceRelease)	For internal use only - memory management stuff
void	resetStructure(boolean restoreInitialValues)	For internal use only.
int	retrieveActualLength()	returns the size of the Stringified representation of the DAO, ie concatenation of DAO fields sizes The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.
String	retrieveAsString()	returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.
String	retrieveAsStringFormatted()
String	retrieveEbcdicValue()
String	retrieveEncodedValue()
ISMObject	retrieveField(int fieldNum)	For internal use only
ISMObject	retrieveField(String fieldName)	For internal use only
AbstractMutableField[]	retrieveFields()	if the class ONLY contains Non-Arrayed Strings, the it will override this method Otherwise, XML to Bean generator will create an overriding method.
String[]	retrieveMasterSQLColumnsForArrays()	For Unisys DMS Support
String	retrieveName()
String	retrieveObject()
Long	retrieveSessionId()	For internal use only
Object	retrieveSQLObject()
Object	retrieveSQLObject(int[] idx)
String	retrieveSQLTableNameOverride()
int	retrieveStorageCellSize()
ISMObject	retrieveSubField(int[] idx)
final String	retrieveSubstring(int beginIndex, int length)
ISMObject	retrieveTopLevelField()	DAO classes need to have one (and only one) field / group.
String	retrieveValue()	Same as retrieveAsString - returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.
void	retrieveValue(AbstractMutableField[] toFields)
ISMBean	retrieveWrapper()
String	stringValue()	returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.
String	toString()
String	trim()

Methods inherited from class java.lang.Object

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

Field Details

sessionId

protected Long sessionId

Constructor Details

AbstractContainerBean

public AbstractContainerBean(BaseService owner)

standard constructor

Parameters:

owner -

AbstractContainerBean

public AbstractContainerBean()

standard constructor

Method Details

retrieveFields

public AbstractMutableField[] retrieveFields()

if the class ONLY contains Non-Arrayed Strings, the it will override this method Otherwise, XML to Bean generator will create an overriding method.

Returns:

list of MString fields

retrieveObject

public String retrieveObject()

Specified by:

retrieveObject in interface ISMObject

retrieveSQLObject

public Object retrieveSQLObject()

Specified by:

retrieveSQLObject in interface ISMDataType

Specified by:

retrieveSQLObject in interface ISMObject

retrieveAsStringFormatted

public String retrieveAsStringFormatted()

Specified by:

retrieveAsStringFormatted in interface ISMObject

retrieveAsString

public String retrieveAsString()

Description copied from interface: ISMBean

returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Specified by:

retrieveAsString in interface AbstractDataObject

Specified by:

retrieveAsString in interface ISMBean

Specified by:

retrieveAsString in interface ISMDataType

Specified by:

retrieveAsString in interface ISMObject

Returns:

stringValue

public String stringValue()

Description copied from interface: ISMBean

returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Specified by:

stringValue in interface ISMBean

Specified by:

stringValue in interface ISMDataType

Returns:

trim

public String trim()

retrieveSubstring

public final String retrieveSubstring(int beginIndex,
 int length)

retrieveStorageCellSize

public int retrieveStorageCellSize()

Specified by:

retrieveStorageCellSize in interface AbstractDataObject

Specified by:

retrieveStorageCellSize in interface ISMDataType

Specified by:

retrieveStorageCellSize in interface ISMObject

retrieveValue

public void retrieveValue(AbstractMutableField[] toFields)

assignValue

public void assignValue(ISMBean wrapper)

Assign Field Values

Parameters:

wrapper -

assignStringFormatted

public final void assignStringFormatted(String newValue)

Specified by:

assignStringFormatted in interface ISMObject

isResourceAlreadyReleased

public boolean isResourceAlreadyReleased()

Specified by:

isResourceAlreadyReleased in interface ISMBean

releaseResources

public void releaseResources()

this is called internally - after a program is CANCEL'ed. it is to help with the GC process

releaseResources

public void releaseResources(boolean forceRelease)

Description copied from interface: ISMBean

For internal use only - memory management stuff

Specified by:

releaseResources in interface ISMBean

Parameters:

forceRelease -

retrieveName

public String retrieveName()

Specified by:

retrieveName in interface ISMObject

retrieveSQLTableNameOverride

public String retrieveSQLTableNameOverride()

assignOverrideSQLTableName

public void assignOverrideSQLTableName(String tableName)

retrieveMasterSQLColumnsForArrays

public String[] retrieveMasterSQLColumnsForArrays()

Description copied from interface: ISMObject

For Unisys DMS Support

Specified by:

retrieveMasterSQLColumnsForArrays in interface ISMObject

assignMasterSQLColumnsForArrays

public void assignMasterSQLColumnsForArrays(String[] columnNames)

Description copied from interface: ISMObject

For Unisys DMS Support

Specified by:

assignMasterSQLColumnsForArrays in interface ISMObject

isFilled

public boolean isFilled(char filler)

isFilled

public boolean isFilled(String filler)

equalsRightTrimmed

public boolean equalsRightTrimmed(String theVal)

retrieveSQLObject

public Object retrieveSQLObject(int[] idx)

Specified by:

retrieveSQLObject in interface ISMObject

assignValue

public void assignValue(Object obj)

Specified by:

assignValue in interface ISMObject

assignObject

public void assignObject(int[] idx,
 Object value)

Specified by:

assignObject in interface ISMObject

retrieveWrapper

public ISMBean retrieveWrapper()

Specified by:

retrieveWrapper in interface ISMObject

bytesSize

public int bytesSize()

Specified by:

bytesSize in interface ISMObject

retrieveSubField

public ISMObject retrieveSubField(int[] idx)

Specified by:

retrieveSubField in interface ISMObject

retrieveField

public ISMObject retrieveField(int fieldNum)

Description copied from interface: ISMBean

For internal use only

Specified by:

retrieveField in interface ISMBean

Parameters:

fieldNum -

Returns:

retrieveField

public ISMObject retrieveField(String fieldName)

Description copied from interface: ISMBean

For internal use only

Specified by:

retrieveField in interface ISMBean

Parameters:

fieldName -

Returns:

fill

public void fill(String filler)

Specified by:

fill in interface ISMObject

fill

public void fill(int startPos,
 int length,
 String filler)

assignHighValues

public void assignHighValues()

assignLowValues

public void assignLowValues()

retrieveTopLevelField

public ISMObject retrieveTopLevelField()

Description copied from interface: ISMBean

DAO classes need to have one (and only one) field / group.
this methods retrieves the top level field / group

Specified by:

retrieveTopLevelField in interface ISMBean

Returns:

assignHighValues

public final void assignHighValues(int startPos,
 int length)

Equivalent of COBOL HIGH VALUES

Parameters:

startPos -

length -

assignLowValues

public final void assignLowValues(int startPos,
 int length)

Equivalent of COBOL LOW VALUES

Parameters:

startPos -

length -

assignSubstring

public final void assignSubstring(int offset,
 int length,
 String newValue)

translation of MOVE 'A' TO ABC (5:4)

Specified by:

assignSubstring in interface ISMObject

Parameters:

offset -

length -

newValue -

initializeMD

public void initializeMD()

initialize

public void initialize()

Description copied from interface: ISMBean

Equivalent of COBOL's INITIALIZE statement

Specified by:

initialize in interface ISMBean

Specified by:

initialize in interface ISMObject

initDefaultValues

protected void initDefaultValues()

resetStructure

public void resetStructure(boolean restoreInitialValues)

Description copied from interface: ISMBean

For internal use only. fills the underlying char array (if any present) to '0' - (this is the status at the time of instantiation). Then it calls InitDefaultValues.

Specified by:

resetStructure in interface ISMBean

Parameters:

restoreInitialValues - Used under certain circumstances in CICS (STORAGE 00), It clears the data, restoring INITIAL-VALUES as defined in original-COBOL

getValue

public String getValue()

retrieveValue

public String retrieveValue()

Description copied from interface: ISMBean

Same as retrieveAsString - returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Specified by:

retrieveValue in interface ISMBean

Returns:

assignValue

public void assignValue(String newValue)

Description copied from interface: ISMBean

Assign a value to this DA (CBL type implementations will take care of REDEFINITIONS, OCCURS DEPENDING, Packed=Decimal fields, ...)

Specified by:

assignValue in interface AbstractDataObject

Specified by:

assignValue in interface ISMBean

Specified by:

assignValue in interface ISMDataType

Specified by:

assignValue in interface ISMObject

assignDefaultValue

public void assignDefaultValue(String newValue)

assignString

public void assignString(String newValue)

Specified by:

assignString in interface ISMObject

retrieveActualLength

public int retrieveActualLength()

Description copied from interface: ISMBean

returns the size of the Stringified representation of the DAO, ie concatenation of DAO fields sizes The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Specified by:

retrieveActualLength in interface ISMBean

Returns:

retrieveEncodedValue

public String retrieveEncodedValue()

Returns:

retrieveEbcdicValue

public String retrieveEbcdicValue()

assignEbcdicValue

public final void assignEbcdicValue(String newValue)

set the value of this record to EBCDIC bytes passed

Parameters:

newValue -

assignEncodedValue

public void assignEncodedValue(String theLine)

Used by the file-readers - to convert to /from ebcdic IF the flag DATAFILES_ARE_EBCDIC is set

Parameters:

theLine -

assignSessionId

public void assignSessionId(Long sessionId)

For internal use only

Specified by:

assignSessionId in interface ISMBean

retrieveSessionId

public Long retrieveSessionId()

For internal use only

Specified by:

retrieveSessionId in interface ISMBean

isFiller

public boolean isFiller()

Specified by:

isFiller in interface ISMObject

toString

public String toString()

Overrides:

toString in class Object

isExcludedFromSQLTable

public boolean isExcludedFromSQLTable()

Specified by:

isExcludedFromSQLTable in interface ISMObject

assignExcludeFromSQLTable

public void assignExcludeFromSQLTable(boolean excludeFromSQLTable)

Specified by:

assignExcludeFromSQLTable in interface ISMObject

assignExemptFromMemRelease

public void assignExemptFromMemRelease(boolean exempt)

Specified by:

assignExemptFromMemRelease in interface ISMBean

isExemptFromMemRelease

public boolean isExemptFromMemRelease()

Specified by:

isExemptFromMemRelease in interface ISMBean