Package com.pnfsoftware.jeb.core.output.table

Interface ITableDocument

All Superinterfaces:

IEventSource, IGenericDocument

All Known Implementing Classes:

AbstractTableDocument, StaticTableDocument

public interface ITableDocument
extends IEventSource, IGenericDocument

A table document is used to represent tabular data. A unit formatter may choose to provide table documents to clients.

Table documents, similar to ITextDocuments, offer methods to retrieve only parts of themselves.

Method Summary

Modifier and Type	Method	Description
ICellCoordinates	addressToCoordinates(String address)	Convert a cell address to cell coordinates.
String	coordinatesToAddress(ICellCoordinates coordinates)	Convert cell coordinates to the cell address.
List<String>	getColumnLabels()	Get the column labels for this table document.
int	getRowCount()	Get the number of rows in this table document.
ITableDocumentPart	getTable()	Get the entire document.
ITableDocumentPart	getTablePart(int start, int count)	Get a part of the document.

Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource

Methods inherited from interface com.pnfsoftware.jeb.core.output.IGenericDocument

dispose, getPropertyManager, getUnit

Method Details

getRowCount

int getRowCount()

Get the number of rows in this table document.

Returns:

the number of rows

getColumnLabels

List<String> getColumnLabels()

Get the column labels for this table document.

Returns:

the column labels

getTablePart

ITableDocumentPart getTablePart(int start,
 int count)

Get a part of the document.

Parameters:

start - starting row index

count - number of rows to be returned

Returns:

the part

getTable

ITableDocumentPart getTable()

Get the entire document.

Returns:

a part representing the entire document

coordinatesToAddress

String coordinatesToAddress(ICellCoordinates coordinates)

Convert cell coordinates to the cell address.

Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.

Parameters:

coordinates - coordinates of a cell

Returns:

the address of the cell, null on error

addressToCoordinates

ICellCoordinates addressToCoordinates(String address)

Convert a cell address to cell coordinates.

Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.

Parameters:

address - address of a cell

Returns:

coordinates of the cell, null on error