desmoj.core.report

Class ASCIITableFormatter

java.lang.Object

desmoj.core.report.AbstractTableFormatter

desmoj.core.report.ASCIITableFormatter

All Implemented Interfaces:

TableFormatter

public class ASCIITableFormatter
extends AbstractTableFormatter

A table formatter class for writing simulation output to tab delimited ASCII (e.g. for import into statistics tools or spreadsheet software).

Version:

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

Author:

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.

Constructor Summary

Constructors

Constructor and Description
ASCIITableFormatter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the document by closing open rows and tables and writing the Desmo-J version footer
void	closeRow() Writes a newline character
void	closeTable() Writes 2 newline characters
void	closeTableNoTopTag() Calls closeTable
static void	disableFooter() Disables the table footer (for all ASCII tables).
java.lang.String	getFileFormat()
void	open(java.lang.String name) Opens the table (without effect for ASCII tables)
void	openRow() Only sets rowOpen flag to true
void	openTable(java.lang.String heading) Opens the table by writing the heading and a newline character
void	writeCell(java.lang.String s, int spanning) Writes the given string followed by a separator character
void	writeHeading(int i, java.lang.String s) Writes the given heading enclosed in asterisks followed by a newline character.
void	writeHeadingCell(java.lang.String s) Writes a heading cell.
void	writeHorizontalRuler() Writes a line of asterisks and a newline.

Methods inherited from class desmoj.core.report.AbstractTableFormatter

openRow, rowIsOpen, setOutput, setTimePrecision, tableIsOpen, timePrecision, writeTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ASCIITableFormatter

public ASCIITableFormatter()

Method Detail

closeRow

public void closeRow()

Writes a newline character

See Also:

TableFormatter.closeRow()

closeTable

public void closeTable()

Writes 2 newline characters

See Also:

TableFormatter.closeTable()

closeTableNoTopTag

public void closeTableNoTopTag()

Calls closeTable

See Also:

TableFormatter.closeTableNoTopTag()

openRow

public void openRow()

Only sets rowOpen flag to true

See Also:

TableFormatter.openRow()

openTable

public void openTable(java.lang.String heading)

Opens the table by writing the heading and a newline character

Parameters:

heading - heading to write

See Also:

TableFormatter.openTable(java.lang.String)

writeCell

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

Writes the given string followed by a separator character

Parameters:

s - string to write

spanning - number of cells to span (ignored)

See Also:

desmoj.core.report.TableFormatter#writeCell(java.lang.String)

writeHeading

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

Writes the given heading enclosed in asterisks followed by a newline character. The integer parameter's value has no effect on ASCII tables.

Parameters:

i - heading size (without effect)

s - heading to write

See Also:

TableFormatter.writeHeading(int, java.lang.String)

writeHeadingCell

public void writeHeadingCell(java.lang.String s)

Writes a heading cell. Heading cells are not formatted in a special way in ASCII tables.

Parameters:

s - heading to write

See Also:

TableFormatter.writeHeadingCell(java.lang.String)

writeHorizontalRuler

public void writeHorizontalRuler()

Writes a line of asterisks and a newline.

See Also:

TableFormatter.writeHorizontalRuler()

open

public void open(java.lang.String name)

Opens the table (without effect for ASCII tables)

Parameters:

name - table name (not displayed)

close

public void close()

Closes the document by closing open rows and tables and writing the Desmo-J version footer

getFileFormat

public java.lang.String getFileFormat()

Returns:

"txt"

disableFooter

public static void disableFooter()

Disables the table footer (for all ASCII tables). The footer can be problematic for comparisons because it contains information that will change between runs.