cds.util

Class AsciiTable

java.lang.Object

cds.util.AsciiTable

Deprecated.

This class suffers a lot of memory issues when dealing with large tables. LargeAsciiTable should be used instead.

@Deprecated
public class AsciiTable
extends java.lang.Object

An object of this class manages an ASCII table: it receives lines to add, made of columns separated by a given separator char. Columns can be aligned (RIGHT, LEFT or CENTER) before display

Version:

1.0 May 2008 MW Creation, 1.1 May 2008 MW Fix a bug: lines are kept without a newline at the end, 1.2 Jun 2008 MW Add a toString method (items aligned) ; Fix a bug in align() when the last line is not full, 1.3 Nov 2018 GM Make the alignment process - align() - interruptible

Author:

Marc Wenger/CDS, Grégory Mantelet/CDS

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER Deprecated.
static int	LEFT Deprecated.
static int	RIGHT Deprecated.

Constructor Summary

Constructors

Constructor and Description
AsciiTable(char separ) Deprecated. Constructor

Method Summary

Modifier and Type	Method and Description
void	addHeaderLine(java.lang.String headerline) Deprecated. Add a header line.
void	addLine(java.lang.String line) Deprecated. Add a line to the table
java.lang.String[]	displayAligned(int[] pos) Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[]).
java.lang.String[]	displayAligned(int[] pos, char newsep) Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[], char).
java.lang.String[]	displayAligned(int[] pos, char newsep, java.lang.Thread thread) Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[], char, Thread).
java.lang.String[]	displayRaw() Deprecated. Get all the lines without alignment, as they were entered
java.lang.String[]	displayRaw(char newsep) Deprecated. Get all the lines without alignment, as they were entered, with separator control
void	endHeaderLine() Deprecated. Specifies that the header lines are finished.
void	endHeaderLine(java.lang.String postfix) Deprecated. Specifies that the header lines are finished.
java.lang.String	toString() Deprecated. Display the whole table, with left alignment

Methods inherited from class java.lang.Object

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

Field Detail

LEFT

public static final int LEFT

Deprecated.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Deprecated.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AsciiTable

public AsciiTable(char separ)

Deprecated.

Constructor

Parameters:

separ - character defining the column separator in the input lines

Method Detail

addHeaderLine

public void addHeaderLine(java.lang.String headerline)

Deprecated.

Add a header line. Several lines of header can be defined.

Parameters:

headerline - header string

endHeaderLine

public void endHeaderLine(java.lang.String postfix)

Deprecated.

Specifies that the header lines are finished. This call is mandatory

Parameters:

postfix - String to append after the header lines (i.e. "\n")

See Also:

endHeaderLine()

endHeaderLine

public void endHeaderLine()

Deprecated.

Specifies that the header lines are finished. This call is mandatory

See Also:

endHeaderLine(String)

addLine

public void addLine(java.lang.String line)

Deprecated.

Add a line to the table

Parameters:

line - string containing the line with all the columns separated by the column separator. The line should not end up with a newline char. If it is the case, alignment errors can be experienced depending on the alignment type of the last column.

displayRaw

public java.lang.String[] displayRaw()

Deprecated.

Get all the lines without alignment, as they were entered

Returns:

the array of the lines in the table

displayRaw

public java.lang.String[] displayRaw(char newsep)

Deprecated.

Get all the lines without alignment, as they were entered, with separator control

Parameters:

newsep - separator to use, replacing the original one

Returns:

the array of the lines in the table

displayAligned

@Deprecated
public java.lang.String[] displayAligned(int[] pos)
                                              throws java.lang.InterruptedException

Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[]).

Get all the lines in the table, properly aligned.

IMPORTANT: The array must have as many columns as the table has. Each column can contain either LEFT, CENTER or RIGHT. If the array contains ONE item, it will be used for every column.

Parameters:

pos - Array of flags, indicating how each column should be justified.

Returns:

An array of the table lines, aligned and justified.

Throws:

java.lang.InterruptedException - If the current thread has been interrupted. This interruption is useful when this alignment operation becomes time and memory consuming.

displayAligned

@Deprecated
public java.lang.String[] displayAligned(int[] pos,
                                                     char newsep)
                                              throws java.lang.InterruptedException

Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[], char).

Get all the lines in the table, properly aligned.

IMPORTANT: The array must have as many columns as the table has. Each column can contain either LEFT, CENTER or RIGHT. If the array contains ONE item, it will be used for every column.

Parameters:

pos - Array of flags, indicating how each column should be justified.

newsep - Separator to use, replacing the original one.

Returns:

An array of the table lines, aligned and justified.

Throws:

java.lang.InterruptedException - If the current thread has been interrupted. This interruption is useful when this alignment operation becomes time and memory consuming.

displayAligned

@Deprecated
public java.lang.String[] displayAligned(int[] pos,
                                                     char newsep,
                                                     java.lang.Thread thread)
                                              throws java.lang.InterruptedException

Deprecated. Deprecated because of memory issues. Instead, you should use LargeAsciiTable.streamAligned(cds.util.LargeAsciiTable.LineProcessor, int[], char, Thread).

Get all the lines in the table, properly aligned.

IMPORTANT: The array must have as many columns as the table has. Each column can contain either LEFT, CENTER or RIGHT. If the array contains ONE item, it will be used for every column.

Parameters:

pos - Array of flags, indicating how each column should be justified.

newsep - Separator to use, replacing the original one.

thread - Thread to watch. If it is interrupted, this task should be as well.

Returns:

An array of the table lines, aligned and justified.

Throws:

java.lang.InterruptedException - If the current thread has been interrupted. This interruption is useful when this alignment operation becomes time and memory consuming.

toString

public java.lang.String toString()

Deprecated.

Display the whole table, with left alignment

Overrides:

toString in class java.lang.Object

Returns:

the table as a unique string