org.millscript.office.excel.versions.biff2
Class Biff2RecordTokenizer

java.lang.Object
  org.millscript.office.excel.RecordTokenizer
      org.millscript.office.excel.versions.biff2.Biff2RecordTokenizer

Direct Known Subclasses:

Biff3RecordTokenizer

public class Biff2RecordTokenizer
extends RecordTokenizer

Nested Class Summary

Nested classes/interfaces inherited from class org.millscript.office.excel.RecordTokenizer

RecordTokenizer.StringOptions

Constructor Summary

Biff2RecordTokenizer(BIFFVersion version, BIFFRecordInputStream bis, byte[] bofData)

Method Summary

RecordParser	getRecordParser()
AbsoluteCellAddress	readAbsoluteCellAddress() Returns the AbsoluteCellAddress at the current offset in the current record data.
CellRangeAddress	readCellRangeAddress() Returns the CellRangeAddress at the current offset in the current record data.
ConstantCachedValue[]	readConstantCachedValueArray() Returns an array of the ConstantCachedValues from the current record offset.
FormattingRun	readFormattingRun() Returns the formating run at the current offset in the current record data.
org.millscript.millscript.expr.Expr<?>	readFormula(int formulaSize) Returns the Expr for the formula at the current offset in the current record with the specified total byte size.
OffsetCellAddress	readOffsetCellAddress() Returns the OffsetCellAddress at the current offset in the current record data.
java.lang.String	readString(int length) Returns a string of the specified length from the current record at the current offset.

Methods inherited from class org.millscript.office.excel.RecordTokenizer

checkBIFFVersionSupportsRecord, decode, getBiffVersion, getBytesLeftInCurrentRecordData, getCodepage, getCodepageDecoder, getCurrentRecordDataOffset, getRecordTokenizer, hasMoreRecords, nextRecord, peekRecord, read2ByteChar, read2ByteInt, read4ByteInt, read8ByteDouble, read8ByteLong, readByte, readBytes, readBytesInto, readBytesLeftInCurrentRecordData, readCellRangeAddressList, readCellRangeAddressListPreBIFF8, readCellRangeAddressPreBIFF8, readCharArray, readColor, readCompressedCharArray, readConstantCachedValues, readFormula, readLongString, readRKValue, readShortString, readUnicodeString, readUnsigned2Byte, readUnsignedByte, readZeroTerminatedCompressedString, readZeroTerminatedString, setCodepage, setCurrentRecordDataOffset, skipBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

Biff2RecordTokenizer

public Biff2RecordTokenizer(BIFFVersion version,
                            BIFFRecordInputStream bis,
                            byte[] bofData)

Parameters:

version -

bis -

Method Detail

getRecordParser

public RecordParser getRecordParser()

Specified by:

getRecordParser in class RecordTokenizer

See Also:

RecordTokenizer.getRecordParser()

readAbsoluteCellAddress

public AbsoluteCellAddress readAbsoluteCellAddress()

Description copied from class: RecordTokenizer

Returns the AbsoluteCellAddress at the current offset in the current record data. This method allows for the changes in the format of this record between BIFF7 and BIFF8. The current offset is incremented by the appropriate amount for the current BIFF version.

Specified by:

readAbsoluteCellAddress in class RecordTokenizer

Returns:

the AbsoluteCellAddress at the current offset in the current record data

See Also:

RecordTokenizer.readAbsoluteCellAddress()

readCellRangeAddress

public CellRangeAddress readCellRangeAddress()

Description copied from class: RecordTokenizer

Returns the CellRangeAddress at the current offset in the current record data. This method allows for the changes in the format of this record between BIFF7 and BIFF8. The current offset is incremented by the appropriate amount for the current BIFF version.

Specified by:

readCellRangeAddress in class RecordTokenizer

Returns:

the CellRangeAddress at the current offset in the current record data

See Also:

RecordTokenizer.readCellRangeAddress()

readConstantCachedValueArray

public ConstantCachedValue[] readConstantCachedValueArray()

Description copied from class: RecordTokenizer

Returns an array of the ConstantCachedValues from the current record offset. The number returned is decoded from the first three bytes in a BIFF version dependant way.

Specified by:

readConstantCachedValueArray in class RecordTokenizer

Returns:

an array of ConstantCachedValues

See Also:

RecordTokenizer.readConstantCachedValueArray()

readFormattingRun

public FormattingRun readFormattingRun()

Description copied from class: RecordTokenizer

Returns the formating run at the current offset in the current record data. This method allows for the changes in the format of this record between BIFF7 and BIFF8.

Specified by:

readFormattingRun in class RecordTokenizer

Returns:

the FormattingRun at the current offset in the current record

See Also:

RecordTokenizer.readFormattingRun()

readFormula

public org.millscript.millscript.expr.Expr<?> readFormula(int formulaSize)

Description copied from class: RecordTokenizer

Returns the Expr for the formula at the current offset in the current record with the specified total byte size. This method will first read the number of bytes used by the formula data, which is a BIFF version dependant field.

Specified by:

readFormula in class RecordTokenizer

Parameters:

formulaSize - the number of bytes the formula uses, including the version dependant formula data byte size field

Returns:

the Expr for the parsed formula

See Also:

RecordTokenizer.readFormula(int)

readOffsetCellAddress

public OffsetCellAddress readOffsetCellAddress()

Description copied from class: RecordTokenizer

Returns the OffsetCellAddress at the current offset in the current record data. This method allows for the changes in the format of this record between BIFF7 and BIFF8. The current offset is incremented by the appropriate amount for the current BIFF version.

Specified by:

readOffsetCellAddress in class RecordTokenizer

Returns:

the OffsetCellAddress at the current offset in the current record data

See Also:

RecordTokenizer.readOffsetCellAddress()

readString

public java.lang.String readString(int length)

Description copied from class: RecordTokenizer

Returns a string of the specified length from the current record at the current offset. This method allows for the varying storage of strings between BIFF versions.

Specified by:

readString in class RecordTokenizer

Returns:

a String from the current offset in the current record

See Also:

RecordTokenizer.readString(int)