casa.io

Class CoreIO

java.lang.Object

casa.io.CoreIO

class CoreIO
extends Object

CASAFileIO - a pure Java implementation of various functions used for working with CASAFiles

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer

Constructor Summary

Constructors

Constructor and Description
CoreIO()

Method Summary

Modifier and Type	Method and Description
protected static FilePosition	appendBlock(CASAFileBlock block, CASAFile file)
protected static long	appendBlock(CASAFileBlock block, RandomAccessFile file)
protected static void	clearBlocks(FilePosition pos) go through all blocks (including first) and set free data size == total data area
protected static FilePosition	getFilePosition(CASAFile file, NodePosition nodePos) convert the supplied node position into a file position returns null if node not found
protected static FilePosition	getFirstWritePosition(CASAFile file, long offset, int mode)
protected static long	getNodeLength(CASAFile file, String nodeName)
protected static long	getNodeLength(FilePosition pos)
protected static int	read(FilePosition pos, byte[] bytes, int start, int byteCount)
protected static int	read(FilePosition pos, byte[] bytes, int start, int byteCount, RandomAccessFile file) read an arbitrary number of bytes from file
protected static CASAFileBlock	readBlock(CASAFile file, long offset)
protected static CASAFileBlock	readBlock(FilePosition pos)
protected static CASAFileBlock	readBlock(FilePosition pos, RandomAccessFile aFile)
protected static CASAFileBlockHeader	readBlockHeader(CASAFile file, long offset)
protected static CASAFileBlockHeader	readBlockHeader(FilePosition pos)
protected static CASAFileBlockHeader	readBlockHeader(FilePosition pos, RandomAccessFile aFile)
protected static CASAFileBlockHeader	readBlockHeader(long offset, RandomAccessFile aFile)
protected static CASAFileHeader	readFileHeader(CASAFile file)
protected static CASAFileHeader	readFileHeader(RandomAccessFile file)
protected static void	setIndexOffset(FilePosition pos, long indexOffset) convenience method to set the index offset in one (or more) block headers this method follows all next links and ensures that the index offset is consistent accross all blocks containing a node
protected static FilePosition	write(FilePosition pos, byte[] bytes) Writes the specified data to the file for the specified node.
protected static FilePosition	write(FilePosition pos, byte[] bytes, int startIndex, int dataCount)
protected static FilePosition	write(FilePosition pos, byte[] bytes, int startIndex, int dataCount, RandomAccessFile aFile)
protected static FilePosition	writeBlock(CASAFileBlock block, FilePosition pos)
protected static FilePosition	writeBlock(CASAFileBlock block, FilePosition pos, RandomAccessFile aFile)
protected static void	writeBlockHeader(CASAFileBlockHeader header, FilePosition pos)
protected static void	writeBlockHeader(CASAFileBlockHeader header, long offset, RandomAccessFile file)

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreIO

CoreIO()

Method Detail

write

protected static FilePosition write(FilePosition pos,
                                    byte[] bytes)
                             throws IOException,
                                    CASAIOException

Writes the specified data to the file for the specified node. As with the stream methods the data to be written is actually only the eight low-order bits of each integer in the data array. The 24 high-order bits of each int are ignored. If the node does not exist, it will be created with the given data. only the data from data[offset] to data[length - 1] is written. The data is written from the dataOffset parameter. If append == true then the data is appended to the node, otherwise the nodes data will be overwritten by the new data

Throws:

IOException

CASAIOException

write

protected static FilePosition write(FilePosition pos,
                                    byte[] bytes,
                                    int startIndex,
                                    int dataCount)
                             throws IOException,
                                    CASAIOException

Throws:

IOException

CASAIOException

write

protected static FilePosition write(FilePosition pos,
                                    byte[] bytes,
                                    int startIndex,
                                    int dataCount,
                                    RandomAccessFile aFile)
                             throws IOException,
                                    CASAIOException

Throws:

IOException

CASAIOException

clearBlocks

protected static void clearBlocks(FilePosition pos)
                           throws IOException,
                                  CASAIOException

go through all blocks (including first) and set free data size == total data area

Throws:

IOException

CASAIOException

getFilePosition

protected static FilePosition getFilePosition(CASAFile file,
                                              NodePosition nodePos)
                                       throws CASAIOException,
                                              IOException

convert the supplied node position into a file position returns null if node not found

Throws:

CASAIOException

IOException

getFirstWritePosition

protected static FilePosition getFirstWritePosition(CASAFile file,
                                                    long offset,
                                                    int mode)
                                             throws CASAIOException,
                                                    IOException

Throws:

CASAIOException

IOException

writeBlock

protected static FilePosition writeBlock(CASAFileBlock block,
                                         FilePosition pos)
                                  throws IOException

Throws:

IOException

writeBlock

protected static FilePosition writeBlock(CASAFileBlock block,
                                         FilePosition pos,
                                         RandomAccessFile aFile)
                                  throws IOException

Throws:

IOException

writeBlockHeader

protected static void writeBlockHeader(CASAFileBlockHeader header,
                                       FilePosition pos)
                                throws IOException

Throws:

IOException

writeBlockHeader

protected static void writeBlockHeader(CASAFileBlockHeader header,
                                       long offset,
                                       RandomAccessFile file)
                                throws IOException

Throws:

IOException

appendBlock

protected static FilePosition appendBlock(CASAFileBlock block,
                                          CASAFile file)
                                   throws IOException,
                                          CASAIOException

Throws:

IOException

CASAIOException

appendBlock

protected static long appendBlock(CASAFileBlock block,
                                  RandomAccessFile file)
                           throws IOException

Throws:

IOException

readFileHeader

protected static CASAFileHeader readFileHeader(CASAFile file)
                                        throws IOException,
                                               CASAIOException

Throws:

IOException

CASAIOException

readFileHeader

protected static CASAFileHeader readFileHeader(RandomAccessFile file)
                                        throws IOException,
                                               CASAIOException

Throws:

IOException

CASAIOException

readBlockHeader

protected static CASAFileBlockHeader readBlockHeader(CASAFile file,
                                                     long offset)
                                              throws IOException,
                                                     CASAIOException

Throws:

IOException

CASAIOException

readBlockHeader

protected static CASAFileBlockHeader readBlockHeader(FilePosition pos)
                                              throws IOException,
                                                     CASAIOException

Throws:

IOException

CASAIOException

readBlockHeader

protected static CASAFileBlockHeader readBlockHeader(FilePosition pos,
                                                     RandomAccessFile aFile)
                                              throws IOException,
                                                     CASAIOException

Throws:

IOException

CASAIOException

readBlockHeader

protected static CASAFileBlockHeader readBlockHeader(long offset,
                                                     RandomAccessFile aFile)
                                              throws IOException,
                                                     CASAIOException

Throws:

IOException

CASAIOException

readBlock

protected static CASAFileBlock readBlock(CASAFile file,
                                         long offset)
                                  throws IOException,
                                         CASAIOException

Throws:

IOException

CASAIOException

readBlock

protected static CASAFileBlock readBlock(FilePosition pos)
                                  throws IOException,
                                         CASAIOException

Throws:

IOException

CASAIOException

readBlock

protected static CASAFileBlock readBlock(FilePosition pos,
                                         RandomAccessFile aFile)
                                  throws IOException,
                                         CASAIOException

Throws:

IOException

CASAIOException

read

protected static int read(FilePosition pos,
                          byte[] bytes,
                          int start,
                          int byteCount)
                   throws IOException,
                          CASAIOException

Throws:

IOException

CASAIOException

read

protected static int read(FilePosition pos,
                          byte[] bytes,
                          int start,
                          int byteCount,
                          RandomAccessFile file)
                   throws IOException,
                          CASAIOException

read an arbitrary number of bytes from file

Throws:

IOException

CASAIOException

getNodeLength

protected static long getNodeLength(CASAFile file,
                                    String nodeName)
                             throws CASAIOException,
                                    IOException

Throws:

CASAIOException

IOException

getNodeLength

protected static long getNodeLength(FilePosition pos)
                             throws CASAIOException,
                                    IOException

Throws:

CASAIOException

IOException

setIndexOffset

protected static void setIndexOffset(FilePosition pos,
                                     long indexOffset)
                              throws CASAIOException,
                                     IOException

convenience method to set the index offset in one (or more) block headers this method follows all next links and ensures that the index offset is consistent accross all blocks containing a node

Throws:

CASAIOException

IOException