com.mitchtalmadge.asciidata.table.formats

Class TableFormatAbstract

java.lang.Object

com.mitchtalmadge.asciidata.table.formats.TableFormatAbstract

Direct Known Subclasses:

ASCIITableFormat, UTF8TableFormat

public abstract class TableFormatAbstract
extends Object

Determines the characters that make up an ASCIITable. Default is UTF8TableFormat.

Author:

MitchTalmadge

Constructor Summary

Constructors

Constructor and Description
TableFormatAbstract()

Method Summary

Modifier and Type	Method and Description
abstract char	getBottomEdgeBorderDivider()
abstract char	getBottomLeftCorner()
abstract char	getBottomRightCorner()
abstract char	getCross(boolean underHeaders, boolean emptyData)
abstract char	getHorizontalBorderFill(boolean edge, boolean underHeaders)
abstract char	getLeftEdgeBorderDivider(boolean underHeaders)
abstract char	getRightEdgeBorderDivider(boolean underHeaders)
abstract char	getTopEdgeBorderDivider()
abstract char	getTopLeftCorner()
abstract char	getTopRightCorner()
abstract char	getVerticalBorderFill(boolean edge)

Methods inherited from class java.lang.Object

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

Constructor Detail

TableFormatAbstract

public TableFormatAbstract()

Method Detail

getTopLeftCorner

public abstract char getTopLeftCorner()

Returns:

The top left corner of the table. Ex: ╔

getTopRightCorner

public abstract char getTopRightCorner()

Returns:

The top right corner of the table. Ex: ╗

getBottomLeftCorner

public abstract char getBottomLeftCorner()

Returns:

The bottom left corner of the table. Ex: ╚

getBottomRightCorner

public abstract char getBottomRightCorner()

Returns:

The bottom right corner of the table. Ex: ╝

getTopEdgeBorderDivider

public abstract char getTopEdgeBorderDivider()

Returns:

The character used when dividing columns on the top edge of the table. Ex: ╤

getBottomEdgeBorderDivider

public abstract char getBottomEdgeBorderDivider()

Returns:

The character used when dividing columns on the bottom edge of the table. Ex: ╧

getLeftEdgeBorderDivider

public abstract char getLeftEdgeBorderDivider(boolean underHeaders)

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used when dividing rows on the left edge of the table. Ex: ╠ under the headers, and ╟ everywhere else.

getRightEdgeBorderDivider

public abstract char getRightEdgeBorderDivider(boolean underHeaders)

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used when dividing rows on the right edge of the table. Ex: ╣ under the headers, and ╢ everywhere else.

getHorizontalBorderFill

public abstract char getHorizontalBorderFill(boolean edge,
                                             boolean underHeaders)

Parameters:

edge - True if the border is on the top or bottom edge of the table.

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used for horizontal stretches in the table. Ex: ═ for edges and under the headers, and ─ everywhere else.

getVerticalBorderFill

public abstract char getVerticalBorderFill(boolean edge)

Parameters:

edge - True if the border is on the left or right edge of the table.

Returns:

The character used for vertical stretches in the table. Ex: ║ for edges, and │ everywhere else.

getCross

public abstract char getCross(boolean underHeaders,
                              boolean emptyData)

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

emptyData - True if the table has no data. In this case it can be more aesthetically pleasing to use a bottom edge divider to provide a flat surface for the bottom of the border. (The cross will only appear under the headers at this point, so underHeaders is true when emptyData is true).

Returns:

The character used where horizontal and vertical borders intersect. Ex: ╪ under the headers, ╧ when table has no data, and ┼ everywhere else.