desmoj.core.report

Interface TableFormatter

All Known Implementing Classes:

AbstractTableFormatter, ASCIITableFormatter, HTMLTableChartFormatter, HTMLTableFormatter

public interface TableFormatter

An interface representing basic facilites for writing data into tables. The specified operations are adapted from the deprecated class demoj.report.HTMLFileOutput.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler (HTMLFileOutput), Nicolas Knaak Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Method Summary

Modifier and Type	Method and Description
void	close() Should close the document
void	closeRow() Should close a table row
void	closeTable() Should close a table
void	closeTableNoTopTag() Should close a table without writing a top tag (HTML specific)
java.lang.String	getFileFormat()
void	open(java.lang.String name) Should open a new document containing multiple tables with the given name
void	openRow() Should open a row
void	openTable(java.lang.String heading) Should open a table with the given heading
boolean	rowIsOpen()
void	setOutput(FileOutput out) Should set an output file to write the table to
void	setTimePrecision(int tp) Should set the required precision of time values.
boolean	tableIsOpen()
int	timePrecision() Should return the precision used for time values.
void	writeCell(java.lang.String s, int spanning) Should write the given string into a new table cell
void	writeHeading(int i, java.lang.String s) Should write the given heading of size i into a new table cell
void	writeHeadingCell(java.lang.String s) Should write the given heading of default size into a new table cell
void	writeHorizontalRuler() Writes a horizontal ruler
java.lang.String	writeTime(java.lang.String s) Should format the given time String and write it into a cell

Method Detail

open

void open(java.lang.String name)

Should open a new document containing multiple tables with the given name

Parameters:

name - table name

close

void close()

Should close the document

closeRow

void closeRow()

Should close a table row

closeTable

void closeTable()

Should close a table

closeTableNoTopTag

void closeTableNoTopTag()

Should close a table without writing a top tag (HTML specific)

openRow

void openRow()

Should open a row

openTable

void openTable(java.lang.String heading)

Should open a table with the given heading

Parameters:

heading - table heading

rowIsOpen

boolean rowIsOpen()

Returns:

true if a row is currently open, false otherwise

tableIsOpen

boolean tableIsOpen()

Returns:

true if a table is currently open, false otherwise

writeCell

void writeCell(java.lang.String s,
               int spanning)

Should write the given string into a new table cell

Parameters:

s - string to write

spanning - number of cells to span

writeHeading

void writeHeading(int i,
                  java.lang.String s)

Should write the given heading of size i into a new table cell

Parameters:

s - string to write

i - size (must be interpreted in a sensible way).

writeHeadingCell

void writeHeadingCell(java.lang.String s)

Should write the given heading of default size into a new table cell

Parameters:

s - string to write

writeHorizontalRuler

void writeHorizontalRuler()

Writes a horizontal ruler

writeTime

java.lang.String writeTime(java.lang.String s)

Should format the given time String and write it into a cell

Parameters:

s - a string containing simulation time in float format.

timePrecision

int timePrecision()

Should return the precision used for time values.

Returns:

precision

setOutput

void setOutput(FileOutput out)

Should set an output file to write the table to

Parameters:

out - a desmoj.report.FileOutput to write the table to

setTimePrecision

void setTimePrecision(int tp)

Should set the required precision of time values.

Parameters:

tp - precision

getFileFormat

java.lang.String getFileFormat()

Returns:

appendix of the file format the table is stored in (e.g. "html" or "txt")