loci.poi.poifs.storage

Class HeaderBlockWriter

java.lang.Object

loci.poi.poifs.storage.BigBlock

loci.poi.poifs.storage.HeaderBlockWriter

All Implemented Interfaces:

BlockWritable, HeaderBlockConstants

public class HeaderBlockWriter
extends BigBlock
implements HeaderBlockConstants

The block containing the archive header

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
private IntegerField	_bat_count
private byte[]	_data
private static byte	_default_value
private IntegerField	_property_start
private IntegerField	_sbat_block_count
private IntegerField	_sbat_start
private IntegerField	_xbat_count
private IntegerField	_xbat_start
private int	bigBlockSize

Fields inherited from interface loci.poi.poifs.storage.HeaderBlockConstants

_bat_array_offset, _bat_count_offset, _property_start_offset, _sbat_block_count_offset, _sbat_start_offset, _signature, _signature_offset, _xbat_count_offset, _xbat_start_offset

Constructor Summary

Constructors

Constructor and Description
HeaderBlockWriter(int blockSize) Create a single instance initialized with default values

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static int	calculateXBATStorageRequirements(int blockCount, int size) For a given number of BAT blocks, calculate how many XBAT blocks will be needed
int	getBigBlockSize()
BATBlock[]	setBATBlocks(int blockCount, int startBlock, int size) Set BAT block parameters.
void	setPropertyStart(int startBlock) Set start of Property Table
void	setSBATBlockCount(int count) Set count of SBAT blocks
void	setSBATStart(int startBlock) Set start of small block allocation table
(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

_bat_count

private IntegerField _bat_count

_property_start

private IntegerField _property_start

_sbat_start

private IntegerField _sbat_start

_sbat_block_count

private IntegerField _sbat_block_count

_xbat_start

private IntegerField _xbat_start

_xbat_count

private IntegerField _xbat_count

_data

private byte[] _data

bigBlockSize

private int bigBlockSize

Constructor Detail

HeaderBlockWriter

public HeaderBlockWriter(int blockSize)

Create a single instance initialized with default values

Method Detail

getBigBlockSize

public int getBigBlockSize()

Specified by:

getBigBlockSize in class BigBlock

setBATBlocks

public BATBlock[] setBATBlocks(int blockCount,
                      int startBlock,
                      int size)

Set BAT block parameters. Assumes that all BAT blocks are contiguous. Will construct XBAT blocks if necessary and return the array of newly constructed XBAT blocks.

Parameters:

blockCount - count of BAT blocks

startBlock - index of first BAT block

Returns:

array of XBAT blocks; may be zero length, will not be null

setPropertyStart

public void setPropertyStart(int startBlock)

Set start of Property Table

Parameters:

startBlock - the index of the first block of the Property Table

setSBATStart

public void setSBATStart(int startBlock)

Set start of small block allocation table

Parameters:

startBlock - the index of the first big block of the small block allocation table

setSBATBlockCount

public void setSBATBlockCount(int count)

Set count of SBAT blocks

Parameters:

count - the number of SBAT blocks

calculateXBATStorageRequirements

static int calculateXBATStorageRequirements(int blockCount,
                                   int size)

For a given number of BAT blocks, calculate how many XBAT blocks will be needed

Parameters:

blockCount - number of BAT blocks

Returns:

number of XBAT blocks needed

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