Package org.openl.rules.table.xls.builder

Class TableBuilder

java.lang.Object

org.openl.rules.table.xls.builder.TableBuilder

Direct Known Subclasses:

DataTableBuilder, DatatypeAliasTableBuilder, DatatypeTableBuilder, PropertiesTableBuilder, SimpleRulesTableBuilder, TestTableBuilder

public class TableBuilder
extends Object

Class that allows creating tables in specified excel sheet.

Author:

Aliaksandr Antonik, Andrei Astrouski

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEADER_HEIGHT
static int	PROPERTIES_MIN_WIDTH
static String	TABLE_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
TableBuilder(XlsSheetGridModel gridModel)	Creates new instance.
TableBuilder(XlsSheetGridModel gridModel, MetaInfoWriter metaInfoWriter)

Method Summary

Modifier and Type	Method	Description
void	beginTable(int width, int height)	Begins writing a table.
void	beginTable(IGridRegion regionToWrite)	Begins writing a table within the specified region.
void	endTable()	Finishes writing a table.
protected int	getCurrentRow()
protected org.apache.poi.ss.usermodel.CellStyle	getDefaultCellStyle()	Initializes default cell style.
protected org.apache.poi.ss.usermodel.CellStyle	getDefaultDateCellStyle()
protected XlsSheetGridModel	getGridModel()
protected int	getHeight()
IGridRegion	getTableRegion()
protected int	getWidth()
protected void	incCurrentRow()
protected void	incCurrentRow(int increment)
void	save()
protected void	writeCell(int x, int y, int width, int height, Object value)	Writes cell.
protected void	writeCell(int x, int y, int width, int height, Object value, ICellStyle style)	Writes cell.
protected void	writeCell(int x, int y, Object value)	Writes cell.
void	writeGridTable(IGridTable table)	Writes table grid.
void	writeHeader(String header, ICellStyle style)	Writes table header.
void	writeProperties(Map<String,Object> properties, ICellStyle style)	Writes table properties.

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_PROPERTIES

public static final String TABLE_PROPERTIES

See Also:

Constant Field Values

HEADER_HEIGHT

public static final int HEADER_HEIGHT

See Also:

Constant Field Values

PROPERTIES_MIN_WIDTH

public static final int PROPERTIES_MIN_WIDTH

See Also:

Constant Field Values

Constructor Detail

TableBuilder

public TableBuilder(XlsSheetGridModel gridModel)

Creates new instance.

Parameters:

gridModel - represents interface for operations with excel sheets

TableBuilder

public TableBuilder(XlsSheetGridModel gridModel,
                    MetaInfoWriter metaInfoWriter)

Method Detail

beginTable

public void beginTable(int width,
                       int height)
                throws CreateTableException

Begins writing a table.

Parameters:

width - table width in cells

height - table height in cells

Throws:

CreateTableException - if unable to create table

IllegalStateException - if beginTable() has already been called without subsequent endTable()

beginTable

public void beginTable(IGridRegion regionToWrite)
                throws CreateTableException

Begins writing a table within the specified region.

Parameters:

regionToWrite - region to write table.

Throws:

CreateTableException - if unable to create table

IllegalStateException - if beginTable() has already been called without subsequent endTable()

endTable

public void endTable()
              throws CreateTableException

Finishes writing a table. Saves the changes to excel sheet.

Throws:

IllegalStateException - if method is called without prior beginTable() call

CreateTableException - if an exception occurred when saving

save

public void save()
          throws CreateTableException

Throws:

CreateTableException

getCurrentRow

protected int getCurrentRow()

getDefaultCellStyle

protected org.apache.poi.ss.usermodel.CellStyle getDefaultCellStyle()

Initializes default cell style.

Returns:

cell style

getDefaultDateCellStyle

protected org.apache.poi.ss.usermodel.CellStyle getDefaultDateCellStyle()

getGridModel

protected XlsSheetGridModel getGridModel()

getHeight

protected int getHeight()

getTableRegion

public IGridRegion getTableRegion()

getWidth

protected int getWidth()

incCurrentRow

protected void incCurrentRow()

incCurrentRow

protected void incCurrentRow(int increment)

writeCell

protected void writeCell(int x,
                         int y,
                         int width,
                         int height,
                         Object value)

Writes cell.

Parameters:

x - cell x coordinate

y - cell y coordinate

width - cell width

height - cell height

value - cell value

writeCell

protected void writeCell(int x,
                         int y,
                         int width,
                         int height,
                         Object value,
                         ICellStyle style)

Writes cell.

Parameters:

x - cell x coordinate

y - cell y coordinate

width - cell width

height - cell height

value - cell value

style - cell style

writeCell

protected void writeCell(int x,
                         int y,
                         Object value)

Writes cell.

Parameters:

x - cell x coordinate

y - cell y coordinate

value - cell value

writeGridTable

public void writeGridTable(IGridTable table)

Writes table grid.

Parameters:

table - table grid

Throws:

IllegalArgumentException - if table is null

IllegalStateException - if method is called without prior beginTable() call

writeHeader

public void writeHeader(String header,
                        ICellStyle style)

Writes table header.

Parameters:

header - header text for the table

style - header style

Throws:

IllegalStateException - if method is called without prior beginTable() call

writeProperties

public void writeProperties(Map<String,Object> properties,
                            ICellStyle style)

Writes table properties.

Parameters:

properties - table properties

style - properties style

Throws:

IllegalArgumentException - if properties is null

IllegalStateException - if method is called without prior beginTable() call