Package com.softwaremining.cics

Class CicsSequential

java.lang.Object

com.softwaremining.wrappers.CBLBean

com.softwaremining.wrappers.AbstractBasePersistence

com.softwaremining.files.AbstractFile

com.softwaremining.files.AbstractSequentialFile

com.softwaremining.files.SequentialNIOFile

com.softwaremining.cics.CicsSequential

All Implemented Interfaces:

IPersistence, AbstractDataObject, ICBLBeanNGroup, ICBLContainer, IFieldContainer, ISMBean, ISMDataType

public abstract class CicsSequential
extends SequentialNIOFile

This class is the super class of data-items accesed by CICS IO operations e.g. CICS READ , WRITE, DELETE, REWRITE

Field Summary

Fields inherited from class com.softwaremining.files.SequentialNIOFile

_recordSize, fileInputStream, fileOutputStream, ONE_ByteBuffer, PAGE_ByteBuffer, SPACE_ByteBuffer, useMultiByteReader

Fields inherited from class com.softwaremining.files.AbstractSequentialFile

ADVANCE_NOT_INITIALIZED, advanceContinuation, advanceSize, advanceType, CRLFcharCount, currentRecordNumber, EJECT, FIRST_LINE_POS, firstLineTerminators, firstRead, fixedLenghtRecordsEndWithNewLine, fixedLengthRecord, justRead, LINE, lineCounter, numberOfInitialRecords, PAGE, rdw_format, RDW_LENGTH, rdw_Null, recordDependingField, targetIsPrinter, TOP_OF_PAGE, totalRuntime, useRDW

Fields inherited from class com.softwaremining.files.AbstractFile

openMode

Fields inherited from class com.softwaremining.wrappers.AbstractBasePersistence

fileName, ownerClassName, status

Fields inherited from class com.softwaremining.wrappers.CBLBean

EBCDIC_JIT_PD_SUPPORT_FOR_SEQ_FILES, INDEX_FOR_NON_ARRAY_VERSION_OF_FIELD, INDEX_ZERO, tmp_lengthofAssignedValue, totalRuntime_allocate, totalRuntime_calcFieldOffsets, totalRuntime_getMemoryPosition, totalRuntime_setFieldFormatted

Fields inherited from interface com.softwaremining.sql.IPersistence

ACCESS_MODE_DYNAMIC, ACCESS_MODE_RANDOM, ACCESS_MODE_SEQUENTIAL, ASCENDING_RECORD_KEY, CONDITION_TYPE_EQUALS, CONDITION_TYPE_GREATER, CONDITION_TYPE_GREATER_OR_EQUALS, CONDITION_TYPE_IGNORE, CONDITION_TYPE_IGNORE_FOR_SQL_LIKE, CONDITION_TYPE_LESS, CONDITION_TYPE_LESS_OR_EQUALS, CONDITION_TYPE_LIKE, CONDITION_TYPE_NO_CONDITION, CONDITION_TYPE_NOT_ASSIGNED, DESCENDING_RECORD_KEY, OPEN_MODE_EXTEND, OPEN_MODE_I_O, OPEN_MODE_INPUT, OPEN_MODE_NOT_OPENED, OPEN_MODE_OUTPUT, STATUS_AT_END, STATUS_CLOSE_FILE_FILE_NOT_OPEN, STATUS_DUP_KEY, STATUS_FAILED_CLOSING, STATUS_INCORRECT_READ_OF_UNOPENED_FILE, STATUS_INCORRECT_RECORDSIZE_REWRITE, STATUS_INSERT_ERR_INAPPROPRIATE_FILE, STATUS_INSERT_ERR_INVALID_KEY, STATUS_LOCK, STATUS_NOT_FOUND, STATUS_OPEN_FILE_FILE_NOT_FOUND, STATUS_REWRITE_WITHOUT_READ, STATUS_SM_FAIL_UNKOWN_REASON, STATUS_SM_NOT_ASSIGNED, STATUS_SUCCESS, UNCERTAIN_OF_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
CicsSequential(BaseService owner)

Method Summary

Modifier and Type	Method	Description
void	assignFileName(String fileName)	In Sequential File Processing - it overwrites the default name of an input/output file automatically assigned by the system.
void	assignLock(boolean newLocValue)	Blank method - no functionality is currently deemed to be required
void	assignRecordKey(ISMObject _recordKey)
void	assignRecordKeyValue(String newValue)
protected void	assignResponseCode(int value)	Used internally to set the IO operation status-values.
CicsBaseService	getOwningCicsService()
String	getRecordKey()
int	getResponse2Code()
int	getResponseCode()	Used internally to set the IO operation status-values.
int	insert()	Insert a record - populate the values from the existing fields
protected int	processException(CBLException e)	constructor
protected int	processException(CBLException e, boolean invokeHandler)	Set appropriate responseCodes, and invoke the conditionHandler
protected int	processException(CBLException e, boolean invokeHandler, int overridingResponseCode)	Set appropriate responseCodes, and invoke the conditionHandler
int	read()	Same as next() . Reads the next record from file.
void	releaseResources(boolean forceRelease)	For internal use only - memory management stuff
ISMObject[]	retrieveNativeKeys()	used internally by softwareMining
protected void	setEibFunction(String value)	Used internally to set the IO operation status-values.
protected void	setResponseCode2(int responseCode2)	Used internally to set the IO operation status-values.
void	setStorageLength(int newLength)	to do ...

Methods inherited from class com.softwaremining.files.SequentialNIOFile

_insertRecord, assignUseMultiByteReader, clear, close, getReadSize, insertNewLine, isFileOpened, nextWithException_UseExactRecordLenght, nextWithException_UseExactRecordLenght_UsingFileChannel, nextWithException_UseExactRecordLenght_UsingFileReader, nextWithException_UseLineBreaks, open, open, prevWithException, readLine_FromFileChannel, readLine_FromFileReader, updateRecord

Methods inherited from class com.softwaremining.files.AbstractSequentialFile

advance, advance, advance, assignDependingField, assignEncodedBytes, assignFixedLenghtRecordsEndWithNewLine, assignRecordsAreFixedLength, assignRecordSize, assignTargetIsPrinter, assignUsesRDW, closeReel, deleteRecord, exists, getCRLFcharCount, getRecordSize, insert, insertRecord, insertRecord, isFixedLenghtRecordsEndWithNewLine, isInputFileEmpty, isRDW, nextRecord, prevRecord, println, readRecord, retrieveCurrentRecordNumber, retrieveEncodedBytesForWrite, retrieveFieldLineCounter, retrieveFieldPageCounter, retrieveInputFileRecordCount, retrieveLineCounter, retrieveNumberOfInitialRecords, retrievePageCounter, retrieveRecordDependingField, setCRLFcharCount

Methods inherited from class com.softwaremining.files.AbstractFile

assignOptional, resetDataDirectory, retrieveDataDirectory, retrieveFullFileName, retrieveOpenMode

Methods inherited from class com.softwaremining.wrappers.AbstractBasePersistence

assignAccessMode, assignStatus, assignStatus, assignStatusAsPrimitive, assignStatusValue, assignStatusValue, assignTableName, delete, next, prev, readRow, retrieveAccessMode, retrieveFileName, retrieveFileName, retrieveFirstLevelEntry, retrieveSessionId, retrieveStatusField, retrieveStatusValue, update

Methods inherited from class com.softwaremining.wrappers.CBLBean

addCorrespondingValue, addCorrespondingValue, allocate, assignAddressTo, assignAddressTo, assignBean, assignBytesEncoded, assignCachedInitializationValue, assignCorrespondingValue, assignCorrespondingValue, assignDefaultValue, assignEbcdicBytes, assignEbcdicJIT_PdSupportForSequentialFiles, assignEncodedValue, assignExemptFromMemRelease, assignExternal, assignHighValues, assignInternalVars, assignLowValues, assignRawEbcdicBytes, assignRedefines, assignRedefines, assignSessionId, assignStringFormatted, assignSubstring, assignSubstring, assignToAddressOf, assignToAddressOf, assignToAddressOf, assignToAddressOf, assignToAllFields, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, calculateStorageSize, containsPointers, equals, equals, equals, equals, equalsRightTrimmed, fieldsCount, fill, fill, fill, fill, fill, getValue, hasPackedDecimalFields, hasSameStorageManager, initDefaultValues, initialize, initialize, isExemptFromMemRelease, isFilled, isFilled, isFilled, isFilled, isGreaterThan, isGreaterThan, isGreaterThan, isHighValues, isInvolvedInDependency, isInvolvedInExternalDependency, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, isLowValues, isRedefinedByAnotherClass, isResourceAlreadyReleased, lengthOf, print, printFieldPosition, printFieldValues, printOrderedFieldPosition, releaseResources, resetCachedValues, resetCompressedFieldList, resetStorageManager, resetStructure, resize, retrieveActualLength, retrieveAsInt, retrieveAsString, retrieveCachedInitializationValue, retrieveCompressedFields, retrieveDependedFieldsList, retrieveEbcdicBytes, retrieveEbcdicValue, retrieveEncodedValue, retrieveField, retrieveField, retrieveFieldAtMemoryPosition, retrieveFieldFormatted, retrieveFields, retrieveIsTargetOfPointers, retrievePrimitiveFields, retrieveRawEbcdicBytes, retrieveRedefinesList, retrieveSQLObject, retrieveStorageBytes, retrieveStorageCellSize, retrieveSubstring, retrieveSubstring, retrieveTopLevelField, retrieveValue, retrieveValue, setValue, stringValue, subtractCorrespondingValue, subtractCorrespondingValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CicsSequential

public CicsSequential(BaseService owner)

Method Details

getOwningCicsService

public CicsBaseService getOwningCicsService()

processException

protected int processException(CBLException e)

constructor

Parameters:

owner -

eibaid - / public CicsPersistence(CicsBaseService owner ,Eibaid eibaid) { super(owner); this.eibaid = eibaid; this.owningCicsService = owner; }

processException

protected int processException(CBLException e,
 boolean invokeHandler)

Set appropriate responseCodes, and invoke the conditionHandler

Parameters:

e -

Returns:

processException

protected int processException(CBLException e,
 boolean invokeHandler,
 int overridingResponseCode)

Set appropriate responseCodes, and invoke the conditionHandler

Parameters:

e -

Returns:

insert

public int insert()

Description copied from class: AbstractBasePersistence

Insert a record - populate the values from the existing fields

Overrides:

insert in class AbstractBasePersistence

read

public int read()

Description copied from class: AbstractSequentialFile

Same as next() .
Reads the next record from file. DOES NOT THROW AtEndException ... instead only the FileStatus will be changed.

Overrides:

read in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

assignResponseCode

protected void assignResponseCode(int value)

Used internally to set the IO operation status-values. Also if a FileStatus field is defined, the system will allocate correct values to it.

Parameters:

value - - .. one of ..

setResponseCode2

protected void setResponseCode2(int responseCode2)

Used internally to set the IO operation status-values.

Parameters:

value - - .. one of ..

setEibFunction

protected void setEibFunction(String value)

Used internally to set the IO operation status-values. Also if a FileStatus field is defined, the system will allocate correct values to it.

Parameters:

value - - .. one of ..

getResponseCode

public int getResponseCode()

Used internally to set the IO operation status-values. Also if a FileStatus field is defined, the system will allocate correct values to it.

Returns:

- the status value .. one of ACMBasePersistent.STATUS_xxxx

getResponse2Code

public int getResponse2Code()

assignFileName

public void assignFileName(String fileName)

In Sequential File Processing - it overwrites the default name of an input/output file automatically assigned by the system.

Overrides:

assignFileName in class AbstractSequentialFile

Parameters:

fileName -

setStorageLength

public void setStorageLength(int newLength)

to do ... not implemented

Parameters:

newLength -

retrieveNativeKeys

public ISMObject[] retrieveNativeKeys()

used internally by softwareMining

getRecordKey

public String getRecordKey()

assignRecordKey

public void assignRecordKey(ISMObject _recordKey)

assignRecordKeyValue

public void assignRecordKeyValue(String newValue)

assignLock

public void assignLock(boolean newLocValue)

Blank method - no functionality is currently deemed to be required

Overrides:

assignLock in class AbstractBasePersistence

Parameters:

newLocValue -

releaseResources

public void releaseResources(boolean forceRelease)

Description copied from interface: ISMBean

For internal use only - memory management stuff

Specified by:

releaseResources in interface ISMBean

Overrides:

releaseResources in class CBLBean

Parameters:

forceRelease -