loci.poi.poifs.storage

Class DocumentBlock

java.lang.Object

loci.poi.poifs.storage.BigBlock

loci.poi.poifs.storage.DocumentBlock

All Implemented Interfaces:

BlockWritable

public class DocumentBlock
extends BigBlock

A block of document data.

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
private int	_bytes_read
private static byte	_default_value
private int	blockSize
private long	offset

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DocumentBlock(int size) Create a single instance initialized with default values
	DocumentBlock(RandomAccessInputStream stream, int size) Create a single instance initialized with data.
	DocumentBlock(RawDataBlock block, int size) create a document block from a raw data block

Method Summary

Methods

Modifier and Type	Method and Description
static DocumentBlock[]	convert(long offset, RandomAccessInputStream stream, int numBytes, int size, int blockSize) convert a single long array into an array of DocumentBlock instances
int	getBigBlockSize()
static byte	getFillByte()
boolean	partiallyRead() Was this a partially read block?
static void	read(DocumentBlock[] blocks, byte[] buffer, int offset, int blockSize, RandomAccessInputStream stream) read data from an array of DocumentBlocks
int	size() Get the number of bytes read for this block
(package private) void	writeData(OutputStream stream) Write the block's data to an OutputStream

Methods inherited from class loci.poi.poifs.storage.BigBlock

doWriteData, writeBlocks

Methods inherited from class java.lang.Object

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

Field Detail

_default_value

private static final byte _default_value

See Also:

Constant Field Values

_bytes_read

private int _bytes_read

blockSize

private int blockSize

offset

private long offset

Constructor Detail

DocumentBlock

public DocumentBlock(RawDataBlock block,
             int size)
              throws IOException

create a document block from a raw data block

Parameters:

block - the raw data block

size - the block size

Throws:

IOException

DocumentBlock

public DocumentBlock(RandomAccessInputStream stream,
             int size)
              throws IOException

Create a single instance initialized with data.

Parameters:

stream - the InputStream delivering the data.

Throws:

IOException

DocumentBlock

private DocumentBlock(int size)

Create a single instance initialized with default values

Method Detail

size

public int size()

Get the number of bytes read for this block

Returns:

bytes read into the block

getBigBlockSize

public int getBigBlockSize()

Specified by:

getBigBlockSize in class BigBlock

partiallyRead

public boolean partiallyRead()

Was this a partially read block?

Returns:

true if the block was only partially filled with data

getFillByte

public static byte getFillByte()

Returns:

the fill byte used

convert

public static DocumentBlock[] convert(long offset,
                      RandomAccessInputStream stream,
                      int numBytes,
                      int size,
                      int blockSize)

convert a single long array into an array of DocumentBlock instances

Parameters:

offset - the offset into the array of blocks to read from

stream - the RandomAccessInputStream to read from

size - the intended size of the array (which may be smaller)

numBytes - the number of bytes

blockSize - the size of a big block

Returns:

an array of DocumentBlock instances, filled from the input array

read

public static void read(DocumentBlock[] blocks,
        byte[] buffer,
        int offset,
        int blockSize,
        RandomAccessInputStream stream)

read data from an array of DocumentBlocks

Parameters:

blocks - the blocks to read from

buffer - the buffer to write the data into

offset - the offset into the array of blocks to read from

writeData

void writeData(OutputStream stream)
         throws IOException

Write the block's data to an OutputStream

Specified by:

writeData in class BigBlock

Parameters:

stream - the OutputStream to which the stored data should be written

Throws:

IOException - on problems writing to the specified stream