org.afcs.warts.report
Class TableHighBitAnalysisReport

java.lang.Object
  org.afcs.warts.report.TableHighBitAnalysisReport

public final class TableHighBitAnalysisReport

extends java.lang.Object

The TableHighBitAnalysisReport class generates reports on the results of running non-ascii character analysis on a table. These reports can then be printed to the command line or into a GUI window (in which they will look best in a monospace font).

There are two styles of report available, long and short. The short version contains columns for the number of Latin-1, 2 byte UTF-8, 3 byte UTF-8, and ambiguous characters and rows for each column in a table that contains such characters. The long report also includes descriptive information about each column (such as type, size, nullable, etc.). A report on each table is preceded by a title that includes the total number of rows in the table. If a table contains no non-ascii characters, then the report indicates that fact.

LICENSE: This code is released to the public domain and may be used for any purpose whatsoever without permission or acknowledgment.

Version:

Last Modified 18 September 2003

Author:

Warren Hedley ( whedley at sdsc dot edu )

Method Summary

static java.lang.String	longReport(TableHighBitAnalysis analysis) Returns a long report on the specified non-ascii character analysis of a table.
static java.lang.String	shortReport(AccountConfiguration configuration) Iterates through all of the tables accessible via the specified account configuration, analysing each of them for non-ascii characters, and compiling the short reports on the analysis of each table into a larger report, which is returned.
static java.lang.String	shortReport(TableHighBitAnalysis analysis) Returns a short report on the specified non-ascii character analysis of a table.

Methods inherited from class java.lang.Object

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

Method Detail

shortReport

public static java.lang.String shortReport(AccountConfiguration configuration)

Iterates through all of the tables accessible via the specified account configuration, analysing each of them for non-ascii characters, and compiling the short reports on the analysis of each table into a larger report, which is returned.

Parameters:

configuration - The account configuration to work with.

Returns:

A compilation of short reports for all of the tables accessible via the specified account configuration.

Throws:

java.lang.NullPointerException - If configuration is null.

longReport

public static java.lang.String longReport(TableHighBitAnalysis analysis)

Returns a long report on the specified non-ascii character analysis of a table. The contents of a long report are discussed in the class documentation.

Parameters:

analysis - The analysis to report on.

Returns:

A long report on the specified analysis.

Throws:

java.lang.NullPointerException - If analysis is null.

shortReport

public static java.lang.String shortReport(TableHighBitAnalysis analysis)

Returns a short report on the specified non-ascii character analysis of a table. The contents of a short report are discussed in the class documentation.

Parameters:

analysis - The analysis to report on.

Returns:

A short report on the specified analysis.

Throws:

java.lang.NullPointerException - If analysis is null.