Package org.orbisgis.commons.printer

Class CustomPrinter

java.lang.Object

org.orbisgis.commons.printer.CustomPrinter

All Implemented Interfaces:

ICustomPrinter

Direct Known Subclasses:

Ascii, Html

public abstract class CustomPrinter
extends Object
implements ICustomPrinter

Root implementation of ICustomPrinter for the custom printers.

Author:

Erwan Bocher (CNRS), Sylvain PALOMINOS (UBS 2019-2020)

Nested Class Summary

Nested classes/interfaces inherited from interface org.orbisgis.commons.printer.ICustomPrinter

ICustomPrinter.CellPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	builder	Not null StringBuilder used for the string building
protected int	columnCount	Count of column
protected int	columnIndex	Current column index
protected int	columnWidth	Width in character number of a single column
protected boolean	isDrawingTable	True of a table is currently drawn, false otherwise

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomPrinter(StringBuilder builder)	Main constructor.

Method Summary

Modifier and Type	Method	Description
void	appendTableValue(Object value)	Add a single value to the table.
void	appendText(String text)
void	endTable()	End the table drawing.
void	startTable(int columnWidth, int columnCount)	Start the drawing of a table.
String	toString()	Return the not null string representation of the data contained by the ICustomPrinter in its specific format.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orbisgis.commons.printer.ICustomPrinter

appendTableHeaderValue, appendTableLineSeparator, appendTableTitle, appendTableValue, appendValue

Field Detail

builder

protected StringBuilder builder

Not null StringBuilder used for the string building

columnWidth

protected int columnWidth

Width in character number of a single column

columnCount

protected int columnCount

Count of column

isDrawingTable

protected boolean isDrawingTable

True of a table is currently drawn, false otherwise

columnIndex

protected int columnIndex

Current column index

Constructor Detail

CustomPrinter

protected CustomPrinter(StringBuilder builder)

Main constructor.

Parameters:

builder - StringBuilder used for the string building.

Method Detail

toString

public String toString()

Description copied from interface: ICustomPrinter

Return the not null string representation of the data contained by the ICustomPrinter in its specific format.

Specified by:

toString in interface ICustomPrinter

Overrides:

toString in class Object

Returns:

The not null string representation of the data contained by the ICustomPrinter

startTable

public void startTable(int columnWidth,
                       int columnCount)

Description copied from interface: ICustomPrinter

Start the drawing of a table.

Specified by:

startTable in interface ICustomPrinter

Parameters:

columnWidth - Width in character number of a single column.

columnCount - Count of column.

endTable

public void endTable()

Description copied from interface: ICustomPrinter

End the table drawing.

Specified by:

endTable in interface ICustomPrinter

appendTableValue

public void appendTableValue(Object value)

Description copied from interface: ICustomPrinter

Add a single value to the table. Linebreak are automatically generated once the column count is reached.

Specified by:

appendTableValue in interface ICustomPrinter

Parameters:

value - Value to add to the table.

appendText

public void appendText(String text)

Specified by:

appendText in interface ICustomPrinter