nl.renarj.jasdb.storage.btree

Class BtreeIndexRecordWriter

java.lang.Object

nl.renarj.jasdb.storage.btree.BtreeIndexRecordWriter

All Implemented Interfaces:

RecordWriter

public class BtreeIndexRecordWriter
extends Object
implements RecordWriter

Author:

Renze de Vries

Constructor Summary

Constructors

Constructor and Description
BtreeIndexRecordWriter(File recordStorageLocation)

Method Summary

Modifier and Type	Method and Description
void	closeWriter() This closes the writer channel and releases all the resources
void	flush() Guarantees the changes are flushed to the disk
long	getDiskSize() Gets the disk size of the persistence storage
long	getSize() Gets the amount of data streams / records stored
boolean	isOpen() Checks if the writer is already open
void	openWriter() This opens the writer for all access, needs to be done before any operations are done on the recordwriter
RecordIterator	readAllRecords() This returns an iterator that can iterate over all persisted records.
RecordIterator	readAllRecords(int limit) This returns an iterator that can iterate over all persisted records to a defined limit.
RecordResult	readRecord(UUIDKey documentId) This reads a specific record at the indicated record position
void	removeRecord(UUIDKey documentId) This will command the writer to remove the indicated record from storage.
void	updateRecord(UUIDKey documentId, ClonableDataStream dataStream) This updates the record contents stored in storage for a given updated content and the current record pointer to the record.
void	writeRecord(UUIDKey documentId, ClonableDataStream dataStream) This writes the given content to the filesystem and returns the record pointer at which the record can be retrieved on next attempt.

Methods inherited from class java.lang.Object

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

Constructor Detail

BtreeIndexRecordWriter

public BtreeIndexRecordWriter(File recordStorageLocation)

Method Detail

getDiskSize

public long getDiskSize()
                 throws JasDBStorageException

Description copied from interface: RecordWriter

Gets the disk size of the persistence storage

Specified by:

getDiskSize in interface RecordWriter

Returns:

The disksize in bytes

Throws:

JasDBStorageException - If unable to get the disksize

getSize

public long getSize()
             throws JasDBStorageException

Description copied from interface: RecordWriter

Gets the amount of data streams / records stored

Specified by:

getSize in interface RecordWriter

Returns:

The amount of datastreams / records stored

Throws:

JasDBStorageException - If unable to get the size

openWriter

public void openWriter()
                throws JasDBStorageException

Description copied from interface: RecordWriter

This opens the writer for all access, needs to be done before any operations are done on the recordwriter

Specified by:

openWriter in interface RecordWriter

Throws:

JasDBStorageException - If unable to open the writer

closeWriter

public void closeWriter()
                 throws JasDBStorageException

Description copied from interface: RecordWriter

This closes the writer channel and releases all the resources

Specified by:

closeWriter in interface RecordWriter

Throws:

JasDBStorageException - If unable to close the writer

flush

public void flush()
           throws JasDBStorageException

Description copied from interface: RecordWriter

Guarantees the changes are flushed to the disk

Specified by:

flush in interface RecordWriter

Throws:

JasDBStorageException - If unable to flush changes to the disk

isOpen

public boolean isOpen()

Description copied from interface: RecordWriter

Checks if the writer is already open

Specified by:

isOpen in interface RecordWriter

Returns:

True if the writer is open and ready for usage, False if not

readAllRecords

public RecordIterator readAllRecords()
                              throws JasDBStorageException

Description copied from interface: RecordWriter

This returns an iterator that can iterate over all persisted records.

Specified by:

readAllRecords in interface RecordWriter

Returns:

The record iterator which can iterate over all the persisted record.

Throws:

JasDBStorageException - If unable to return an iterator, channel is closed or not accessible

readAllRecords

public RecordIterator readAllRecords(int limit)
                              throws JasDBStorageException

Description copied from interface: RecordWriter

This returns an iterator that can iterate over all persisted records to a defined limit.

Specified by:

readAllRecords in interface RecordWriter

Returns:

The record iterator which can iterate over all the persisted record to a defined limit.

Throws:

JasDBStorageException - If unable to return an iterator, channel is closed or not accessible

readRecord

public RecordResult readRecord(UUIDKey documentId)
                        throws JasDBStorageException

Description copied from interface: RecordWriter

This reads a specific record at the indicated record position

Specified by:

readRecord in interface RecordWriter

Parameters:

documentId - The document key identifier used to identify the document to write to storage

Returns:

The RecordResult if the record could be found

Throws:

JasDBStorageException - In case the record could not be found or read

writeRecord

public void writeRecord(UUIDKey documentId,
                        ClonableDataStream dataStream)
                 throws JasDBStorageException

Description copied from interface: RecordWriter

This writes the given content to the filesystem and returns the record pointer at which the record can be retrieved on next attempt.

Specified by:

writeRecord in interface RecordWriter

Parameters:

documentId - The document key identifier used to identify the document to write to storage

dataStream - The datastream to be written to storage

Throws:

JasDBStorageException - If unable to write the record to the storage

removeRecord

public void removeRecord(UUIDKey documentId)
                  throws JasDBStorageException

Description copied from interface: RecordWriter

This will command the writer to remove the indicated record from storage.

Specified by:

removeRecord in interface RecordWriter

Parameters:

documentId - The document key identifier used to identify the document to remove

Throws:

JasDBStorageException - If unable to find the indicated record or removing failed.

updateRecord

public void updateRecord(UUIDKey documentId,
                         ClonableDataStream dataStream)
                  throws JasDBStorageException

Description copied from interface: RecordWriter

This updates the record contents stored in storage for a given updated content and the current record pointer to the record. It will return the same or an updated record pointer pointing to the updated content on the disk.

Specified by:

updateRecord in interface RecordWriter

Parameters:

documentId - The document key identifier used to identify the document to write to storage

dataStream - The datastream to be written to storage

Throws:

JasDBStorageException - If unable to update in case no record exists or unable to update in storage.