io.starter.formats.LEO

Interface BlockByteConsumer

All Known Implementing Classes:

Ai, AlRuns, Area, AreaFormat, Array, AttachedLabel, AutoFilter, Axcent, Axesused, Axis, AxisLineFormat, AxisParent, Bar, Begin, Blank, Bof, BookBool, Boolerr, Boppop, BoppopCustom, BottomMargin, Boundsheet, CalcMode, CatLab, CatserRange, Cf, Cf12, Chart, Chart3DBarShape, ChartFormat, ChartFormatLink, ChartFrtInfo, ChartLine, Codename, Colinfo, Condfmt, Condfmt12, Continue, Country, Crn, CrtLayout12, CrtLayout12A, Dat, DataFormat, DataLabExt, DataLabExtContents, Dbcell, DConBin, DConName, DConRef, DefaultRowHeight, DefaultText, DefColWidth, Dimensions, Dropbar, Dsf, Dv, Dval, End, EndBlock, EndObject, Eof, Externname, Externsheet, Extsst, Fbi, FeatHeadr, FileLock, Font, FontBasis, Fontx, Footerrec, Format, Formula, Frame, FrtFontList, FrtWrapper, GelFrame, GenericChartObject, Guts, HCenter, Headerrec, Hlink, Ifmt, Index, InterfaceHdr, Label, Labelsst, LeftMargin, Legend, Legendxn, Line, LineFormat, MarkerFormat, Mergedcells, MSODrawing, MSODrawingGroup, MSODrawingSelection, Mulblank, Mulrk, Name, NineteenOhFour, Note, NumberRec, Obj, ObjectLink, ObjProtect, Obproj, OOXMLChart, Palette, Pane, Password, Phonetic, Picf, Pie, PieFormat, PivotChartBits, PivotChartLink, PlotArea, PlotGrowth, Pls, PLV, Pos, PrintGrid, PrintRowCol, Prot4rev, Protect, QsiSXTag, Radar, RadarArea, RightMargin, Rk, Row, RrdHead, RrdInfo, Rstring, SbaseRef, Scatter, ScenProtect, Scl, Selection, SerauxErrBar, SerauxTrend, Serfmt, Series, SeriesList, SeriesText, SerParent, SerToCrt, Setup, Shrfmla, ShtProps, SiIndex, Sst, StartBlock, StartObject, StringRec, Style, Supbook, Surface, SxAddl, SXBool, SxDB, SxDBB, SXDBEx, SxDI, SxEX, SxFDB, SXFDBType, Sxformat, Sxivd, Sxli, SXNum, SxPI, SxStreamID, SXString, Sxvd, SxVdEX, Sxvi, Sxview, SxVIEWEX9, SxViewLink, SxVS, TabID, TableStyles, TextDisp, ThreeD, Tick, TopMargin, Txo, UnencryptedXLSRecord, Units, Usersviewbegin, Usersviewend, UsrExcl, ValueRange, VCenter, Window1, Window2, Writeaccess, WsBool, Xct, Xf, XLSCellRecord, XLSRecord, YMult

public interface BlockByteConsumer

The BlockByteConsumer interface describes an Object which reads its data from a scattered collection of Blocks. By tracking the blocks containing the record's data,

Method Summary

Modifier and Type	Method and Description
BlockByteReader	getByteReader() Get the BlockByteReader for this Consumer
int	getFirstBlock() Returns the index of the first block
int	getLastBlock() Returns the index of the last block
int	getLength() Returns the length of the record.
int	getOffset() Get the relative position within the data underlying the block vector represented by the BlockByteReader.
void	setByteReader(BlockByteReader db) Set the BlockByteReader for this Consumer
void	setFirstBlock(int i) Sets the index of the first block
void	setLastBlock(int i) Sets the index of the last block
void	setOffset(int pos) Set the relative position within the data underlying the block vector represented by the BlockByteReader.

Method Detail

setOffset

void setOffset(int pos)

Set the relative position within the data underlying the block vector represented by the BlockByteReader. In other words, this is the relative position used by the BlockByteReader to offset the Consumer's read position within the collection of Data Blocks. This may be an offset relative to the data in a file, or within a Storage contained in a file. The Workbook Storage for example will contain a non-contiguous collection of Blocks containing data from any number of positions in a file. This collection forms a contiguous span of bytes comprising an XLS Workbook. The XLSRecords within this span of bytes will set their relative position within this 'virtual' array. Thus the XLSRecord positions are relative to the order of bytes contained in the Block collection. The BOF record then is at offset 0 within the data of the first Block, even though the underlying data of this first Block may be anywhere on disk.

Parameters:

pos -

getOffset

int getOffset()

Get the relative position within the data underlying the block vector represented by the BlockByteReader.

Returns:

relative position

setFirstBlock

void setFirstBlock(int i)

Sets the index of the first block

setLastBlock

void setLastBlock(int i)

Sets the index of the last block

getFirstBlock

int getFirstBlock()

Returns the index of the first block

Returns:

getLastBlock

int getLastBlock()

Returns the index of the last block

Returns:

getLength

int getLength()

Returns the length of the record.

Returns:

setByteReader

void setByteReader(BlockByteReader db)

Set the BlockByteReader for this Consumer

Parameters:

db -

getByteReader

BlockByteReader getByteReader()

Get the BlockByteReader for this Consumer

Parameters:

db -