com.azalient.api.file
Interface Page

All Superinterfaces:

IPage

All Known Subinterfaces:

PageW

public interface Page
extends IPage

The base interface for pages written to the "workbook" or model file.

Each page holds raw data in rows and columns.

The page is divided into tables, and the bounds of each table can be queried. All row and column values are on the page, not in each table.

Field Summary

static String

TYPE_PAGE_BASE_SEP The separator string used between page type, page name and base name in the internal name of a page.

Fields inherited from interface com.azalient.api.a.tables.IPage

ZERO

Method Summary

void	baseName(String s) Reset the base
BookR	book() The book to which this page belongs
int	columns() return the number of columns
Object	get(int col, int row) Return a value of a type in { String, Integer, Double, UTime, Boolean, null }
Object	get(int col, int row, boolean checkMerged) Return a value of a type in { String, Integer, Double, UTime, Boolean, null }
void	pageName(String s) Rename the page
int	rows() return the number of rows
TableB	tableBounds(String tableName) Return the bounds of a given table
String[]	tableNames() Return the list of tables that already exist on this page

Methods inherited from interface com.azalient.api.a.tables.IPage

baseName, pageName, pageType

Field Detail

TYPE_PAGE_BASE_SEP

static final String TYPE_PAGE_BASE_SEP

The separator string used between page type, page name and base name in the internal name of a page.

See Also:

Constant Field Values

Method Detail

book

BookR book()

The book to which this page belongs

get

Object get(int col,
           int row)

Return a value of a type in { String, Integer, Double, UTime, Boolean, null }

Parameters:

col - the page column

row - the page row

get

Object get(int col,
           int row,
           boolean checkMerged)

Return a value of a type in { String, Integer, Double, UTime, Boolean, null }

Parameters:

col - the page column

row - the page row

checkMerged - if this is true, and the page allows cell merging, use the primary cell if this cell is part of a set of merged cells. If the page does not allow cell merging then this has no effect. XLS pages allow cell merging, AZA and CSV do not.

rows

int rows()

return the number of rows

columns

int columns()

return the number of columns

tableBounds

TableB tableBounds(String tableName)

Return the bounds of a given table

tableNames

String[] tableNames()

Return the list of tables that already exist on this page

pageName

void pageName(String s)

Rename the page

baseName

void baseName(String s)

Reset the base