Package com.softwaremining.files

Class AbstractSequentialMappedFile

java.lang.Object

com.softwaremining.wrappers.CBLBean

com.softwaremining.wrappers.AbstractBasePersistence

com.softwaremining.files.AbstractFile

com.softwaremining.files.AbstractSequentialFile

com.softwaremining.files.SequentialFile

com.softwaremining.files.AbstractSequentialMappedFile

All Implemented Interfaces:

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

Direct Known Subclasses:

SequentialVariableMappedFile

public abstract class AbstractSequentialMappedFile
extends SequentialFile

Caters for VSAM Record & Line Sequential files. Example.

    ExamplePersistentFile examplePersistentFile = new ExamplePersistentFile(null);
    examplePersistentFile.assignStatus(field_status);  // this needs to be an ISMField
    
    // for Sequential files use 0, 
    // for LINE sequential, on windows use 2 on Unix use 1 
    examplePersistentFile.assignFileName( FILE_NAME );
    examplePersistentFile.open(IPersistence.OPEN_MODE_INPUT);
    
    
    while (examplePersistentFile.next()) {
        
        if (! examplePersistentFile.getStatusValue().equals(IPersistence.STATUS_SUCCESS)) break;
        System.out.println(" - " + examplePersistentFile.stringValue());
    }
    

Field Summary

Fields

Modifier and Type	Field	Description
protected static Log	log

Fields inherited from class com.softwaremining.files.SequentialFile

randomAccessFile

Fields inherited from class com.softwaremining.files.AbstractSequentialFile

_recordSize, 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
AbstractSequentialMappedFile()	constructor
AbstractSequentialMappedFile(BaseService owner)	default Constructor

Method Summary

Modifier and Type	Method	Description
protected int	_insertRecord(int groupSize)	Used Internally by SoftwareMining Framework Insert (write) the current data into file.
protected void	insertNewLine()	Auxilary method (not present in COBOL).
protected int	nextWithException_UseExactRecordLenght()	Used Internally by SoftwareMining Framework read the next record from file.
protected int	nextWithException_UseLineBreaks()	Used Internally by SoftwareMining framework read the next record from file.
int	prevWithException()	Scroll back to previous record When end (or beginning) of file is reached, it does not throw an exception
void	setOffset(int newOffset)	Returns the current file-Length If file has not been opened yet, or if file has been closed, then it returns 0.
int	updateRecord()	Update the current record with the current record structure.

Methods inherited from class com.softwaremining.files.SequentialFile

clear, close, fileLength, isFileOpened, open, open

Methods inherited from class com.softwaremining.files.AbstractSequentialFile

advance, advance, advance, assignDependingField, assignEncodedBytes, assignFileName, assignFixedLenghtRecordsEndWithNewLine, assignRecordsAreFixedLength, assignRecordSize, assignTargetIsPrinter, assignUsesRDW, closeReel, deleteRecord, exists, getCRLFcharCount, getRecordSize, insert, insertRecord, insertRecord, isFixedLenghtRecordsEndWithNewLine, isRDW, nextRecord, prevRecord, println, read, readRecord, retrieveCurrentRecordNumber, retrieveEncodedBytesForWrite, retrieveFieldLineCounter, retrieveFieldPageCounter, 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, assignLock, assignStatus, assignStatus, assignStatusAsPrimitive, assignStatusValue, assignStatusValue, assignTableName, delete, insert, 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, 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, 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

Field Details

log

protected static Log log

Constructor Details

AbstractSequentialMappedFile

public AbstractSequentialMappedFile()

constructor

AbstractSequentialMappedFile

public AbstractSequentialMappedFile(BaseService owner)

default Constructor

Parameters:

owner -

Method Details

nextWithException_UseExactRecordLenght

protected int nextWithException_UseExactRecordLenght()
                                              throws IOCriticalException,
AtEndException

Used Internally by SoftwareMining Framework read the next record from file. At end throw an exception

Overrides:

nextWithException_UseExactRecordLenght in class SequentialFile

Throws:

IOCriticalException

AtEndException

nextWithException_UseLineBreaks

protected int nextWithException_UseLineBreaks()
                                       throws IOCriticalException,
AtEndException

Used Internally by SoftwareMining framework read the next record from file. At end throw an exception

Overrides:

nextWithException_UseLineBreaks in class SequentialFile

Throws:

IOCriticalException

AtEndException

prevWithException

public int prevWithException()
                      throws IOCriticalException,
AtEndException

Scroll back to previous record When end (or beginning) of file is reached, it does not throw an exception

Overrides:

prevWithException in class SequentialFile

Throws:

IOCriticalException

AtEndException

updateRecord

public int updateRecord()
                 throws IOCriticalException

Update the current record with the current record structure. If at end of file is reached, it throws an exception

Overrides:

updateRecord in class SequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOCriticalException

_insertRecord

protected int _insertRecord(int groupSize)
                     throws IOCriticalException

Description copied from class: AbstractSequentialFile

Used Internally by SoftwareMining Framework Insert (write) the current data into file.

Overrides:

_insertRecord in class SequentialFile

Parameters:

groupSize - : Used for multi 01 files ... defines the size of the group

Throws:

IOCriticalException

insertNewLine

protected void insertNewLine()
                      throws IOCriticalException

Auxilary method (not present in COBOL). Adds a new CRLF to the file.

Overrides:

insertNewLine in class SequentialFile

Throws:

IOCriticalException

setOffset

public void setOffset(int newOffset)

Returns the current file-Length If file has not been opened yet, or if file has been closed, then it returns 0.