A data store that is backed by a file located at the path given. More...

Inheritance diagram for Deveel.Data.Store.FileStoreData:

Public Member Functions
	FileStoreData (string filePath)

void	Dispose ()

bool	Delete ()
	Deletes the data block. More...

void	Open (bool readOnly)
	Opens the data block and make it ready to be accessed. More...

void	Close ()
	Closes the block and make it unavailable. More...

int	Read (long position, byte[] buffer, int offset, int length)
	Reads a given amount of data from the block, starting at the absolute position given and copying into the provided buffer. More...

void	Write (long position, byte[] buffer, int offset, int length)
	Writes a given buffer into the block, starting at the absolute position given. More...

void	Flush ()
	Flushes the data written in the temporary store of the block to the underlying medium. More...

void	SetLength (long value)
	Sets the length of the data block. More...

Properties
string	FilePath `[get, private set]`

bool	IsOpen `[get, private set]`

bool	Exists `[get]`

long	Length `[get]`

bool	IsReadOnly `[get, private set]`

Properties inherited from Deveel.Data.Store.IStoreData
bool	Exists `[get]`
	Gets a value indicating whether the data block object exists. More...

long	Length `[get]`
	Gets the current length of the data block. More...

bool	IsReadOnly `[get]`
	Gets a value indicating whether the data block is in read-only mode. More...

Private Member Functions
	~FileStoreData ()

void	Dispose (bool disposing)

Private Attributes
LocalFile	file

readonly object	objectLock = new object()

Detailed Description

A data store that is backed by a file located at the path given.

Definition at line 24 of file FileStoreData.cs.

Constructor & Destructor Documentation

Deveel.Data.Store.FileStoreData.FileStoreData ( string filePath )

inline

Definition at line 28 of file FileStoreData.cs.

                                               {
             if (String.IsNullOrEmpty(filePath))
                 throw new ArgumentNullException("filePath");
 
             FilePath = filePath;
             IsOpen = false;
         }

Deveel.Data.Store.FileStoreData.~FileStoreData ( )

inlineprivate

Definition at line 36 of file FileStoreData.cs.

                          {
             Dispose(false);
         }

Member Function Documentation

void Deveel.Data.Store.FileStoreData.Close ( )

inline

Closes the block and make it unavailable.

When IDisposable.Dispose is invoked this method is also called to prevent any operation before disposal.

Implements Deveel.Data.Store.IStoreData.

Definition at line 93 of file FileStoreData.cs.

                             {
             lock (objectLock) {
                 try {
                     file.Close();
                 } finally {
                     IsOpen = false;
                 }
             }
         }

bool Deveel.Data.Store.FileStoreData.Delete ( )

inline

Deletes the data block.

Returns: Returns true if the block was successfully deleted, or false otherwise.

Implements Deveel.Data.Store.IStoreData.

Definition at line 73 of file FileStoreData.cs.

                              {
             if (IsOpen)
                 return false;
 
             try {
                 File.Delete(FilePath);
                 return !Exists;
             } catch (Exception) {
                 return false;
             }
         }

void Deveel.Data.Store.FileStoreData.Dispose ( )

inline

Definition at line 44 of file FileStoreData.cs.

                               {
             Dispose(true);
             GC.SuppressFinalize(this);
         }

void Deveel.Data.Store.FileStoreData.Dispose ( bool disposing )

inlineprivate

Definition at line 49 of file FileStoreData.cs.

                                              {
             if (disposing) {
                 if (IsOpen)
                     Close();
 
                 if (file != null)
                     file.Dispose();
             }
         }

void Deveel.Data.Store.FileStoreData.Flush ( )

inline

Flushes the data written in the temporary store of the block to the underlying medium.

Implements Deveel.Data.Store.IStoreData.

Definition at line 131 of file FileStoreData.cs.

                             {
             try {
                 file.Flush(true);
             } catch (IOException) {
                 // There isn't much we can do about this exception.  By itself it
                 // doesn't indicate a terminating error so it's a good idea to ignore
                 // it.  Should it be silently ignored?
             }
         }

void Deveel.Data.Store.FileStoreData.Open ( bool readOnly )

inline

Opens the data block and make it ready to be accessed.

Parameters

readOnly Indicates if the block must be open in read-only mode.

Implements Deveel.Data.Store.IStoreData.

Definition at line 85 of file FileStoreData.cs.

                                         {
             lock (objectLock) {
                 file = new LocalFile(FilePath, readOnly);
                 IsOpen = true;
                 IsReadOnly = readOnly;
             }
         }

int Deveel.Data.Store.FileStoreData.Read	(	long	position,
		byte[]	buffer,
		int	offset,
		int	length
	)

inline

Reads a given amount of data from the block, starting at the absolute position given and copying into the provided buffer.

Parameters

position	The absolute position within the data block from where to start reading.
buffer	The destination buffer where the data read will be filled in.
offset	The starting offset within the buffer where to start copying the data read.
length	The desired number of bytes to read from the data block.

Returns: Returns the actual number of bytes read from the data block or 0 if the end of the block was reached.

Implements Deveel.Data.Store.IStoreData.

Definition at line 103 of file FileStoreData.cs.

                                                                               {
             // Make sure we don't Read past the end
             lock (objectLock) {
                 length = System.Math.Max(0, System.Math.Min(length, (int)(Length - position)));
                 int count = 0;
                 if (position < Length) {
                     file.Seek(position, SeekOrigin.Begin);
                     count = file.Read(buffer, offset, length);
                 }
 
                 return count;
             }
         }

void Deveel.Data.Store.FileStoreData.SetLength ( long value )

inline

Sets the length of the data block.

Parameters

value The new size to set for the data block.

If the value is less than Length this method will shrink the data block and trim the exceeding contents. If the value is more than Length then it is responsibility of the implementation of this contract to increase the contents.

Implements Deveel.Data.Store.IStoreData.

Definition at line 141 of file FileStoreData.cs.

                                           {
             lock (objectLock) {
                 file.SetLength(value);
             }
         }

void Deveel.Data.Store.FileStoreData.Write	(	long	position,
		byte[]	buffer,
		int	offset,
		int	length
	)

inline

Writes a given buffer into the block, starting at the absolute position given.

Parameters

position	The absolute position within the data block from where to start writing.
buffer	The data to write into the block.
offset	The starting offset within the buffer where to start writing data from.
length	The number of bytes to write into the data block.

Implements Deveel.Data.Store.IStoreData.

Definition at line 117 of file FileStoreData.cs.

                                                                                 {
             if (IsReadOnly)
                 throw new IOException();
 
             // Make sure we don't Write past the end
             lock (objectLock) {
                 length = System.Math.Max(0, System.Math.Min(length, (int)(Length - position)));
                 if (position < Length) {
                     file.Seek(position, SeekOrigin.Begin);
                     file.Write(buffer, offset, length);
                 }
             }
         }

Member Data Documentation

LocalFile Deveel.Data.Store.FileStoreData.file

private

Definition at line 25 of file FileStoreData.cs.

readonly object Deveel.Data.Store.FileStoreData.objectLock = new object()

private

Definition at line 26 of file FileStoreData.cs.

Property Documentation

bool Deveel.Data.Store.FileStoreData.Exists

get

Definition at line 59 of file FileStoreData.cs.

string Deveel.Data.Store.FileStoreData.FilePath

getprivate set

Definition at line 40 of file FileStoreData.cs.

bool Deveel.Data.Store.FileStoreData.IsOpen

getprivate set

Definition at line 42 of file FileStoreData.cs.

bool Deveel.Data.Store.FileStoreData.IsReadOnly

getprivate set

Definition at line 71 of file FileStoreData.cs.

long Deveel.Data.Store.FileStoreData.Length

get

Definition at line 67 of file FileStoreData.cs.

The documentation for this class was generated from the following file:

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Store/FileStoreData.cs

Public Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation