org.textmining.extraction.word.model

Class CHPFormattedDiskPage

java.lang.Object

org.textmining.extraction.word.model.FormattedDiskPage

org.textmining.extraction.word.model.CHPFormattedDiskPage

public class CHPFormattedDiskPage
extends FormattedDiskPage

Represents a CHP fkp. The style properties for paragraph and character runs are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps for character run properties. The first part of the fkp for both CHP and PAP fkps consists of an array of 4 byte int offsets that represent a Paragraph's or Character run's text offset in the main stream. The ending offset is the next value in the array. For example, if an fkp has X number of Paragraph's stored in it then there are (x + 1) 4 byte ints in the beginning array. The number X is determined by the last byte in a 512 byte fkp. CHP and PAP fkps also store the compressed styles(grpprl) that correspond to the offsets on the front of the fkp. The offset of the grpprls is determined differently for CHP fkps and PAP fkps.

Author:

Ryan Ackley

Field Summary

Fields inherited from class org.textmining.extraction.word.model.FormattedDiskPage

_crun, _currentIndex, _fc2Cp, _fkp, _offset

Constructor Summary

Constructors

Constructor and Description
CHPFormattedDiskPage()
CHPFormattedDiskPage(byte[] documentStream, int offset, int fcMin, NodeHelper fc2Cp) This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array read from a Word file).

Method Summary

Modifier and Type	Method and Description
void	fill(ArrayList filler, int start)
void	fill(List filler)
CHPX	getCHPX(int index)
int	getEndIndex()
protected byte[]	getGrpprl(int index) Gets the chpx for the character run at index in this fkp.
ArrayList	getOverflow()
int	size() Used to get the total number of grrprl's stored int this FKP
byte[]	toByteArray(int fcMin)

Methods inherited from class org.textmining.extraction.word.model.FormattedDiskPage

getEnd, getStart

Methods inherited from class java.lang.Object

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

Constructor Detail

CHPFormattedDiskPage

public CHPFormattedDiskPage()

CHPFormattedDiskPage

public CHPFormattedDiskPage(byte[] documentStream,
                            int offset,
                            int fcMin,
                            NodeHelper fc2Cp)

This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array read from a Word file).

Method Detail

getCHPX

public CHPX getCHPX(int index)

fill

public void fill(List filler)

fill

public void fill(ArrayList filler,
                 int start)

getEndIndex

public int getEndIndex()

getOverflow

public ArrayList getOverflow()

getGrpprl

protected byte[] getGrpprl(int index)

Gets the chpx for the character run at index in this fkp.

Specified by:

getGrpprl in class FormattedDiskPage

Parameters:

index - The index of the chpx to get.

Returns:

a chpx grpprl.

toByteArray

public byte[] toByteArray(int fcMin)

size

public int size()

Description copied from class: FormattedDiskPage

Used to get the total number of grrprl's stored int this FKP

Specified by:

size in class FormattedDiskPage

Returns:

The number of grpprls in this FKP