Package com.softwaremining.files

Class AbstractFile

java.lang.Object

com.softwaremining.wrappers.CBLBean

com.softwaremining.wrappers.AbstractBasePersistence

com.softwaremining.files.AbstractFile

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSequentialFile, RelativeFile

public abstract class AbstractFile
extends AbstractBasePersistence
implements IPersistence

Field Summary

Fields

Modifier and Type	Field	Description
protected int	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, log, 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
AbstractFile()
AbstractFile(BaseService owner)	default Constructor

Method Summary

Modifier and Type	Method	Description
void	assignOptional(boolean isOptional)
static void	resetDataDirectory()	resets the data-directory variable, enforcing it to be set again (Useful if/when COnfig.dataDirectory as changed)
static final String	retrieveDataDirectory()	Set-up the Input/Output directory for creation of sequential files.
String	retrieveFullFileName()	if running in a web-environment (WEB-INF somewhere in the path) The method needs "softwaremining.properties" file somewhere it its path.
final int	retrieveOpenMode()	Open modes are : IPersistence.OPEN_MODE_INPUT ( read ) IPersistence.OPEN_MODE_OUTPUT (Write) IPersistence.OPEN_MODE_I_O (read-write) IPersistence.OPEN_MODE_EXTEND: (read-write)

Methods inherited from class com.softwaremining.wrappers.AbstractBasePersistence

assignAccessMode, assignFileName, assignLock, assignStatus, assignStatus, assignStatusAsPrimitive, assignStatusValue, assignStatusValue, assignTableName, clear, close, delete, deleteRecord, insert, insertRecord, next, nextRecord, open, prev, prevRecord, read, readRecord, readRow, retrieveAccessMode, retrieveFileName, retrieveFileName, retrieveFirstLevelEntry, retrieveSessionId, retrieveStatusField, retrieveStatusValue, update, updateRecord

Methods inherited from class com.softwaremining.wrappers.CBLBean

addCorrespondingValue, addCorrespondingValue, allocate, assignAddressTo, assignAddressTo, assignBean, assignBytesEncoded, assignCachedInitializationValue, assignCorrespondingValue, assignCorrespondingValue, assignDefaultValue, assignDependingField, assignEbcdicBytes, assignEbcdicJIT_PdSupportForSequentialFiles, assignEncodedValue, assignExemptFromMemRelease, assignExternal, assignHighValues, assignInternalVars, assignLowValues, assignRawEbcdicBytes, assignRecordSize, 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

openMode

protected int openMode

Constructor Details

AbstractFile

public AbstractFile()

AbstractFile

public AbstractFile(BaseService owner)

default Constructor

Parameters:

owner -

Method Details

retrieveFullFileName

public String retrieveFullFileName()

if running in a web-environment (WEB-INF somewhere in the path) The method needs "softwaremining.properties" file somewhere it its path.

Returns:

if WEB-INF is somewher in the path then it absolote path for "WEB-INF/out" if WEB-INF is not anywhere in the path - then it returns "";

retrieveDataDirectory

public static final String retrieveDataDirectory()

Set-up the Input/Output directory for creation of sequential files. if running in a web-environment (WEB-INF somewhere in the path) The method needs "softwaremining.properties" file somewhere it its path.

Returns:

if WEB-INF is somewhere in the path then it absolute path for "WEB-INF/out" if WEB-INF is not anywhere in the path - then it returns "";

retrieveOpenMode

public final int retrieveOpenMode()

Open modes are :
IPersistence.OPEN_MODE_INPUT ( read )
IPersistence.OPEN_MODE_OUTPUT (Write)
IPersistence.OPEN_MODE_I_O (read-write)
IPersistence.OPEN_MODE_EXTEND: (read-write)

Specified by:

retrieveOpenMode in class AbstractBasePersistence

resetDataDirectory

public static void resetDataDirectory()

resets the data-directory variable, enforcing it to be set again (Useful if/when COnfig.dataDirectory as changed)

assignOptional

public void assignOptional(boolean isOptional)