NikeFS2RandomAccessStorageImpl (OpenXES)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.deckfour.xes.nikefs2
Class NikeFS2RandomAccessStorageImpl

java.lang.Object
  org.deckfour.xes.nikefs2.NikeFS2RandomAccessStorageImpl

All Implemented Interfaces:: DataInput, DataOutput, NikeFS2RandomAccessStorage

Direct Known Subclasses:: NikeFS2LazyRandomAccessStorageImpl

public class NikeFS2RandomAccessStorageImpl
extends Object
implements NikeFS2RandomAccessStorage
extends Object
implements NikeFS2RandomAccessStorage

Implements the Random Access Storage interface for using the NikeFS2 virtual file system transparently to the application and user. Effectively, this class implements a file abstraction, backed not by a real OS-level file, but a set of virtual blocks in the VFS.

Author:: Christian W. Guenther (christian@deckfour.org)

Nested Class Summary
`protected class`	`NikeFS2RandomAccessStorageImpl.FS2BlockInputStream` Internal support class implementing an input stream over a list of blocks, as implemented by the enclosing class
`protected class`	`NikeFS2RandomAccessStorageImpl.FS2BlockOutputStream` Internal support class implementing an output stream over a list of blocks, as implemented by the enclosing class
`protected class`	`NikeFS2RandomAccessStorageImpl.FS2DataInputStream` Internal support class implementing a data input stream with NikeFS2-block-safe UTF-8 string serialization.
`protected class`	`NikeFS2RandomAccessStorageImpl.FS2DataOutputStream` Internal support class implementing a data output stream with NikeFS2-block-safe UTF-8 string serialization.

Field Summary
`protected List<NikeFS2Block>`	`blocks` List of blocks used to store data.
`protected NikeFS2RandomAccessStorageImpl.FS2DataInputStream`	`dataInputStream` Data input stream, used to simplify reading of higher-level data types.
`protected NikeFS2RandomAccessStorageImpl.FS2DataOutputStream`	`dataOutputStream` Data output stream, used to simplify writing of higher-level data types.
`protected long`	`pointer` Current file pointer (in bytes from the start) within this virtual file.
`protected long`	`size` Current size, in bytes, of this virtual file.
`protected NikeFS2VirtualFileSystem`	`vfs` References the virtual file system for block provision.

Constructor Summary
`NikeFS2RandomAccessStorageImpl(NikeFS2VirtualFileSystem virtualFileSystem)` Creates a new instance of this class.

Method Summary
`protected void`	`adjustSize()` Calling this method will adjust the size of this file, if it is no longer accurate.
`void`	`close()` Closes the data storage container.
`NikeFS2RandomAccessStorage`	`copy()` Creates a clone, or copy, of this storage, having the exact same contents and the file pointer reset to zero.
`long`	`getFilePointer()` Returns the current file pointer of the storage container.
`long`	`length()` Returns the length, or size, in number of bytes currently used by this instance.
`boolean`	`readBoolean()`
`byte`	`readByte()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`void`	`readFully(byte[] b)`
`void`	`readFully(byte[] b, int off, int len)`
`int`	`readInt()`
`String`	`readLine()` Deprecated.
`long`	`readLong()`
`short`	`readShort()`
`int`	`readUnsignedByte()`
`int`	`readUnsignedShort()`
`String`	`readUTF()`
`void`	`seek(long pos)` Repositions the offset, or file pointer, at which the next read or write operation will occur.
`int`	`skipBytes(int n)` Moves the offset, or file pointer, a specified number of bytes towards the end of the storage container.
`protected int`	`translateToBlockNumber(long offset)` Translates a virtual file pointer address in this instance to the block number, where the data is actually stored.
`protected int`	`translateToBlockOffset(long offset)` Translates a virtual file pointer address in this instance to the offset within the block, where the data is actually stored.
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int len)`
`void`	`write(int b)`
`void`	`writeBoolean(boolean v)`
`void`	`writeByte(int b)`
`void`	`writeBytes(String str)`
`void`	`writeChar(int c)`
`void`	`writeChars(String str)`
`void`	`writeDouble(double d)`
`void`	`writeFloat(float f)`
`void`	`writeInt(int i)`
`void`	`writeLong(long l)`
`void`	`writeShort(int s)`
`void`	`writeUTF(String str)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

vfs

protected NikeFS2VirtualFileSystem vfs

References the virtual file system for block provision.

blocks

protected List<NikeFS2Block> blocks

List of blocks used to store data.

size

protected long size

Current size, in bytes, of this virtual file.

pointer

protected long pointer

Current file pointer (in bytes from the start) within this virtual file.

dataOutputStream

protected NikeFS2RandomAccessStorageImpl.FS2DataOutputStream dataOutputStream

Data output stream, used to simplify writing of higher-level data types.

dataInputStream

protected NikeFS2RandomAccessStorageImpl.FS2DataInputStream dataInputStream

Data input stream, used to simplify reading of higher-level data types.

Constructor Detail

NikeFS2RandomAccessStorageImpl

public NikeFS2RandomAccessStorageImpl(NikeFS2VirtualFileSystem virtualFileSystem)

Creates a new instance of this class.

Parameters:: virtualFileSystem - The virtual file system instance this virtual file can allocate storage blocks from.

Method Detail

adjustSize

protected void adjustSize()

Calling this method will adjust the size of this file, if it is no longer accurate.

translateToBlockNumber

protected int translateToBlockNumber(long offset)

Translates a virtual file pointer address in this instance to the block number, where the data is actually stored.

Parameters:: offset - The virtual file pointer address, in bytes from the beginning.
Returns:: The number of the referenced block.

translateToBlockOffset

protected int translateToBlockOffset(long offset)

Translates a virtual file pointer address in this instance to the offset within the block, where the data is actually stored.

Parameters:: offset - The virtual file pointer address, in bytes from the beginning.
Returns:: The offset within the block, where the data is actually stored