org.hsqldb.persist

Class DataFileCache

java.lang.Object

org.hsqldb.persist.DataFileCache

Direct Known Subclasses:

DataFileCacheSession, TextCache

public class DataFileCache
extends java.lang.Object

Acts as a manager for CACHED table persistence.

This contains the top level functionality. Provides file management services and access.

Rewritten for 1.8.0 and 2.x

Since:

1.7.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_190
static int	FLAG_HX
static int	FLAG_ISSAVED
static int	FLAG_ISSHADOWED
static int	FLAG_ROWINFO
long	maxDataFileSize
RowOutputInterface	rowOut
DataSpaceManager	spaceManager

Constructor Summary

Constructors

Constructor and Description
DataFileCache(Database db, java.lang.String baseFileName)
DataFileCache(Database db, java.lang.String baseFileName, boolean defrag)

Method Summary

Modifier and Type	Method and Description
void	add(CachedObject object)
void	adjustStoreCount(int adjust)
long	bytesCapacity()
int	capacity()
void	close() Writes out all cached rows that have been modified and the free position pointer for the *.data file and then closes the file.
long	enlargeFileSpace(long delta) Delta must always result in block multiples
CachedObject	get(CachedObject object, PersistentStore store, boolean keep)
CachedObject	get(long pos, int size, PersistentStore store, boolean keep)
CachedObject	get(long pos, PersistentStore store, boolean keep)
int	getAccessCount()
int	getCachedObjectCount()
int	getDataFileScale()
long	getFileFreePos()
java.lang.String	getFileName()
int	getFlags()
long	getLostBlockSize()
RAShadowFile	getShadowFile()
int	getStorageSize(long i)
long	getTotalCachedBlockSize()
boolean	hasRowInfo()
boolean	isDataReadOnly()
boolean	isFileModified()
boolean	isFileOpen()
boolean	isModified()
void	open(boolean readonly) Opens the *.data file for this cache, setting the variables that allow access to the particular database version of the *.data file.
void	release() Abandons changed rows and closes the .data file.
CachedObject	release(long pos)
void	releaseRange(long start, long limit)
void	remove(CachedObject object) Used when a row is deleted as a result of some DML or DDL statement.
void	removePersistence(CachedObject object)
void	reopen()
void	replace(CachedObject object)
void	reset() Commits all the changes to the file
void	saveRow(CachedObject row) Writes out the specified Row.
void	saveRowOutput(long pos)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_ISSHADOWED

public static final int FLAG_ISSHADOWED

See Also:

Constant Field Values

FLAG_ISSAVED

public static final int FLAG_ISSAVED

See Also:

Constant Field Values

FLAG_ROWINFO

public static final int FLAG_ROWINFO

See Also:

Constant Field Values

FLAG_190

public static final int FLAG_190

See Also:

Constant Field Values

FLAG_HX

public static final int FLAG_HX

See Also:

Constant Field Values

spaceManager

public DataSpaceManager spaceManager

rowOut

public RowOutputInterface rowOut

maxDataFileSize

public long maxDataFileSize

Constructor Detail

DataFileCache

public DataFileCache(Database db,
                     java.lang.String baseFileName)

DataFileCache

public DataFileCache(Database db,
                     java.lang.String baseFileName,
                     boolean defrag)

Method Detail

open

public void open(boolean readonly)

Opens the *.data file for this cache, setting the variables that allow access to the particular database version of the *.data file.

release

public void release()

Abandons changed rows and closes the .data file.

close

public void close()

Writes out all cached rows that have been modified and the free position pointer for the *.data file and then closes the file.

adjustStoreCount

public void adjustStoreCount(int adjust)

reopen

public void reopen()

reset

public void reset()

Commits all the changes to the file

remove

public void remove(CachedObject object)

Used when a row is deleted as a result of some DML or DDL statement. Removes the row from the cache data structures. Adds the file space for the row to the list of free positions.

removePersistence

public void removePersistence(CachedObject object)

add

public void add(CachedObject object)

getStorageSize

public int getStorageSize(long i)

replace

public void replace(CachedObject object)

get

public CachedObject get(CachedObject object,
                        PersistentStore store,
                        boolean keep)

get

public CachedObject get(long pos,
                        int size,
                        PersistentStore store,
                        boolean keep)

get

public CachedObject get(long pos,
                        PersistentStore store,
                        boolean keep)

releaseRange

public void releaseRange(long start,
                         long limit)

release

public CachedObject release(long pos)

saveRow

public void saveRow(CachedObject row)

Writes out the specified Row. Will write only the Nodes or both Nodes and table row data depending on what is not already persisted to disk.

saveRowOutput

public void saveRowOutput(long pos)

enlargeFileSpace

public long enlargeFileSpace(long delta)

Delta must always result in block multiples

capacity

public int capacity()

bytesCapacity

public long bytesCapacity()

getTotalCachedBlockSize

public long getTotalCachedBlockSize()

getLostBlockSize

public long getLostBlockSize()

getFileFreePos

public long getFileFreePos()

getCachedObjectCount

public int getCachedObjectCount()

getAccessCount

public int getAccessCount()

getFileName

public java.lang.String getFileName()

getDataFileScale

public int getDataFileScale()

hasRowInfo

public boolean hasRowInfo()

isFileModified

public boolean isFileModified()

isModified

public boolean isModified()

isFileOpen

public boolean isFileOpen()

getFlags

public int getFlags()

isDataReadOnly

public boolean isDataReadOnly()

getShadowFile

public RAShadowFile getShadowFile()