Package com.softwaremining.files

Class QSAMFile

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.QSAMFile

All Implemented Interfaces:

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

public abstract class QSAMFile
extends SequentialFile

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLOCK_SIZE_DIMENTION_IN_BYTES
static final int	BLOCK_SIZE_DIMENTION_IN_RECORDS
static final int	RECORD_FORMAT_FIXED_LENGTH
static final int	RECORD_FORMAT_SPANNED
static final int	RECORD_FORMAT_UNDEFINED
static final int	RECORD_FORMAT_VARIABLE_LENGTH

Fields inherited from class com.softwaremining.files.SequentialFile

log, 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_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_REWRITE_WITHOUT_READ, STATUS_SM_FAIL_UNKOWN_REASON, STATUS_SM_NOT_ASSIGNED, STATUS_SUCCESS, UNCERTAIN_OF_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QSAMFile()
protected	QSAMFile(BaseService owner)

Method Summary

Modifier and Type	Method	Description
int	deleteRecord()	deletes the entire file
int	insertRecord()	Insert (write) the current data into file.
int	nextRecord()	read the next record from file.
int	prev()
int	prevRecord()	Scroll back to previous record When end (or beginning) of file is reached, it throws AtEndException
void	setBlockSize(int blockSize, int blockSizeDimention)
void	setRecordFormat(int recordFormat)
int	updateRecord()	Update the current record with the current record structure.

Methods inherited from class com.softwaremining.files.SequentialFile

_insertRecord, clear, close, fileLength, insertNewLine, isFileOpened, nextWithException_UseExactRecordLenght, nextWithException_UseLineBreaks, open, open, prevWithException

Methods inherited from class com.softwaremining.files.AbstractSequentialFile

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

Methods inherited from class com.softwaremining.files.AbstractFile

resetDataDirectory, retrieveDataDirectory, retrieveFullFileName, retrieveOpenMode

Methods inherited from class com.softwaremining.wrappers.AbstractBasePersistence

assignAccessMode, assignLock, assignStatus, assignStatus, assignStatusAsPrimitive, assignStatusValue, assignStatusValue, assignTableName, delete, insert, next, 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, 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, printFieldPosition, printFieldValues, printOrderedFieldPosition, PrintOrderedFieldPositionsAndValue, releaseResources, releaseResources, resetCachedValues, resetCompressedFieldList, resetStructure, resize, retrieveActualLength, retrieveAsInt, retrieveAsString, retrieveCachedInitializationValue, retrieveCompressedFields, retrieveDependedFieldsList, retrieveEbcdicBytes, retrieveEbcdicValue, retrieveEncodedValue, retrieveField, retrieveField, retrieveFieldAtMemoryPosition, retrieveFieldFormatted, retrieveFields, retrieveIsTargetOfPointers, retrievePrimitiveFields, retrieveRawEbcdicBytes, retrieveSQLObject, retrieveStorageCellSize, retrieveStorageChars, 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

RECORD_FORMAT_FIXED_LENGTH

public static final int RECORD_FORMAT_FIXED_LENGTH

See Also:

• Constant Field Values

RECORD_FORMAT_VARIABLE_LENGTH

public static final int RECORD_FORMAT_VARIABLE_LENGTH

See Also:

• Constant Field Values

RECORD_FORMAT_SPANNED

public static final int RECORD_FORMAT_SPANNED

See Also:

• Constant Field Values

RECORD_FORMAT_UNDEFINED

public static final int RECORD_FORMAT_UNDEFINED

See Also:

• Constant Field Values

BLOCK_SIZE_DIMENTION_IN_RECORDS

public static final int BLOCK_SIZE_DIMENTION_IN_RECORDS

See Also:

• Constant Field Values

BLOCK_SIZE_DIMENTION_IN_BYTES

public static final int BLOCK_SIZE_DIMENTION_IN_BYTES

See Also:

• Constant Field Values

Constructor Details

QSAMFile

protected QSAMFile()

QSAMFile

protected QSAMFile(BaseService owner)

Method Details

setRecordFormat

public void setRecordFormat(int recordFormat)

setBlockSize

public void setBlockSize(int blockSize,
 int blockSizeDimention)

nextRecord

public int nextRecord()
               throws IOCriticalException,
AtEndException

Description copied from class: AbstractSequentialFile

read the next record from file. At end thow an exception

Overrides:

nextRecord in class AbstractSequentialFile

Returns:

Throws:

IOCriticalException

AtEndException

updateRecord

public int updateRecord()
                 throws IOCriticalException

Description copied from class: SequentialFile

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

public int insertRecord()
                 throws IOCriticalException

Description copied from class: AbstractSequentialFile

Insert (write) the current data into file.

Overrides:

insertRecord in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOCriticalException

prev

public int prev()

Overrides:

prev in class AbstractBasePersistence

prevRecord

public int prevRecord()
               throws IOCriticalException,
AtEndException

Description copied from class: AbstractSequentialFile

Scroll back to previous record When end (or beginning) of file is reached, it throws AtEndException

Overrides:

prevRecord in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOCriticalException

AtEndException

deleteRecord

public int deleteRecord()
                 throws IOStatusException

Description copied from class: AbstractSequentialFile

deletes the entire file

Overrides:

deleteRecord in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOStatusException