Package com.softwaremining.files

Class CachedIndexedFile

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.files.CachedIndexedFile

All Implemented Interfaces:

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

public abstract class CachedIndexedFile
extends SequentialNIOFile

Cached table is for Reference Data only. Reference data are NOT written back to the file-system, they are only used in read-only mode. The data is loaded from file-system (when open() method is called) - and loaded into memory.
To use - find a persistent class which inherits from SQLWrapper or AbstractORContainer , and change its superclass to CachedIndexedFile.
also remember to use "assignFileName" to define the file containing the data.

Field Summary

Fields

Modifier and Type	Field	Description
protected ISMObject[]	nativeKeys

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
CachedIndexedFile()	constructor
CachedIndexedFile(BaseService owner)	Constructor -

Method Summary

Modifier and Type	Method	Description
void	assignRecordKey(ISMObject recordKey)
int	clear()	NOT SUPPORTED - this is a read-only data cache
int	close()	Close file and change status to STATUS_SUCCEED.
int	delete()	NOT SUPPORTED - this is a read-only data cache
void	first()	Goto first record (as organized by key's)
int	insertRecord()	NOT SUPPORTED - this is a read-only data cache
void	last()	Goto last record (as organized by key's)
int	nextRecord()	read next record
int	open(int openMode)	Opens and reads all the information into memory (if not there already)
int	prevRecord()	read previous record
int	read()	Read record which matches record-key
int	readAtPosition(int position)	goto the said "position", and read the data
ISMObject[]	retrieveNativeKeys()	for internal use only Native Keys refer to either a.
ISMObject	retrieveRecordKey()	for internal use only
int	seek(ISMObject key)	Find the record identified by key
final int	seekRecord(ISMObject key)	Go to the record identified by key
int	seekRecord(ISMObject[] keys, int conditionType)	Find the record identified by key
int	size()
int	update()	NOT SUPPORTED - this is a read-only data cache

Methods inherited from class com.softwaremining.files.SequentialNIOFile

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

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, isFixedLenghtRecordsEndWithNewLine, isRDW, println, 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, insert, next, prev, readRow, retrieveAccessMode, retrieveFileName, retrieveFileName, retrieveFirstLevelEntry, retrieveSessionId, retrieveStatusField, retrieveStatusValue

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

nativeKeys

protected ISMObject[] nativeKeys

Constructor Details

CachedIndexedFile

public CachedIndexedFile()

constructor

CachedIndexedFile

public CachedIndexedFile(BaseService owner)

Constructor -

Parameters:

owner -

Method Details

assignRecordKey

public void assignRecordKey(ISMObject recordKey)

retrieveNativeKeys

public ISMObject[] retrieveNativeKeys()

for internal use only
Native Keys refer to either a. any keys set by setRecordKey b. in absence of any keys defined by setRecordKey, then an additional index keys is created by SoftwareMining framework. (This is usually called INDX_FLD_0;)

retrieveRecordKey

public ISMObject retrieveRecordKey()

for internal use only

Returns:

open

public int open(int openMode)
         throws IOCriticalException

Opens and reads all the information into memory (if not there already)

Overrides:

open in class SequentialNIOFile

Parameters:

openMode - refers to:
IPersistence.OPEN_MODE_INPUT ( read )
IPersistence.OPEN_MODE_OUTPUT (Write)
IPersistence.OPEN_MODE_I_O (read-write)
IPersistence.OPEN_MODE_EXTEND: (read-write)

Throws:

IOCriticalException

close

public int close()
          throws IOCriticalException

Description copied from class: SequentialNIOFile

Close file and change status to STATUS_SUCCEED.

Overrides:

close in class SequentialNIOFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOCriticalException

seekRecord

public int seekRecord(ISMObject[] keys,
 int conditionType)

Find the record identified by key

seek

public int seek(ISMObject key)

Find the record identified by key

seekRecord

public final int seekRecord(ISMObject key)

Go to the record identified by key

read

public int read()
         throws IOStatusException

Read record which matches record-key

Overrides:

read in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOStatusException

nextRecord

public int nextRecord()
               throws IOStatusException

read next record

Overrides:

nextRecord in class AbstractSequentialFile

Returns:

Throws:

IOStatusException

readAtPosition

public int readAtPosition(int position)
                   throws IOStatusException

goto the said "position", and read the data

Parameters:

position -

Returns:

Throws:

IOStatusException

prevRecord

public int prevRecord()
               throws IOStatusException

read previous record

Overrides:

prevRecord in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOStatusException

first

public void first()
           throws IOStatusException

Goto first record (as organized by key's)

Throws:

IOStatusException

last

public void last()
          throws IOStatusException

Goto last record (as organized by key's)

Throws:

IOStatusException

size

public int size()

update

public int update()
           throws IOStatusException

NOT SUPPORTED - this is a read-only data cache

Overrides:

update in class AbstractBasePersistence

Throws:

IOStatusException

insertRecord

public int insertRecord()
                 throws IOStatusException

NOT SUPPORTED - this is a read-only data cache

Overrides:

insertRecord in class AbstractSequentialFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOStatusException

delete

public int delete()
           throws IOStatusException

NOT SUPPORTED - this is a read-only data cache

Overrides:

delete in class AbstractBasePersistence

Throws:

IOStatusException

clear

public int clear()
          throws IOStatusException

NOT SUPPORTED - this is a read-only data cache

Overrides:

clear in class SequentialNIOFile

Returns:

when successful it returns IPersistence.STATUS_SUCCESS

Throws:

IOStatusException