com.continuent.tungsten.common.utils
Class ResultFormatter

java.lang.Object
  com.continuent.tungsten.common.utils.ResultFormatter

public class ResultFormatter
extends java.lang.Object

Implements a client result formatter. Default result formatting is to call Object.toString(). Tabular values are formatted appropriately.

Version:

1.0

Author:

Robert Hodges

Field Summary

static java.lang.String	DEFAULT_INDENT
static int	DEFAULT_WIDTH
static java.lang.String	NEWLINE
protected java.lang.Object	result
static java.lang.String	ROW_BEGIN_END
static java.lang.String	ROW_SEPARATOR

Constructor Summary

ResultFormatter(java.lang.Object result)
Creates a new formatter for a particular object.

ResultFormatter(java.lang.Object result, boolean printHeader, java.lang.String indentToUse)

Method Summary

java.lang.String	format() Returns a formatted value.
java.lang.String	format(int wrapColumn)
protected java.lang.String	format(java.util.Map<?,?> props)
protected java.lang.String	format(java.util.Map<?,?> props, int maxLength) Object formatter for Map instance.
protected java.lang.String	format(java.lang.Object o) Default object formatter using Object.toString().
static java.lang.String	formatMap(java.util.Map<java.lang.String,?> map)
static java.lang.String	formatProperties(java.lang.String entityName, TungstenProperties properties, boolean printHeader)
static java.lang.String	formatResult(java.lang.String entityName, java.lang.String result)
static java.lang.String	formatResult(java.lang.String entityName, java.lang.String result, boolean ignoreColon)
static java.lang.String	formatResult(java.lang.String entityName, java.lang.String result, boolean ignoreColon, boolean useDelimiters)
static java.lang.String	formatResults(java.lang.String entityName, java.lang.String[] columnNames, java.util.Vector<java.lang.String[]> results, int entryWidth)
static java.lang.String	formatResults(java.lang.String entityName, java.lang.String[] columnNames, java.util.Vector<java.lang.String[]> results, int entryWidth, boolean ignoreColon)
static java.lang.String	formatResults(java.lang.String entityName, java.lang.String[] columnNames, java.util.Vector<java.lang.String[]> results, int entryWidth, boolean ignoreColon, boolean useDelimiters)
static java.lang.String	makeDataRow(java.lang.String[] entries, int entryWidth, int indentToUse, boolean ignoreColon, boolean useDelimiters)
static java.lang.String	makeRow(java.lang.String[] entries, int entryWidth)
static java.lang.String	makeRow(java.lang.String[] entries, int entryWidth, boolean ignoreColon)
static java.lang.String	makeRow(java.lang.String[] entries, int entryWidth, int indentToUse, boolean ignoreColon)
static java.lang.String	makeRow(java.lang.String[] entries, int entryWidth, int indentToUse, boolean ignoreColon, boolean useDelimiters)
static java.lang.String	makeSeparator(int entryWidth, int columnCount)
static java.lang.String	makeSeparator(int entryWidth, int columnCount, boolean useDelimiters)
static java.lang.String[]	wrap(java.lang.String value, int maxLength)
static java.lang.String[]	wrap(java.lang.String value, int maxLength, boolean ignoreColon)
static java.lang.String[]	wrap(java.lang.String value, int maxLength, int hangingIndent, boolean ignoreColon)
static java.lang.String[]	wrap2(java.lang.String value, int maxLength, boolean ignoreColon)

Methods inherited from class java.lang.Object

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

Field Detail

NEWLINE

public static final java.lang.String NEWLINE

See Also:

Constant Field Values

DEFAULT_INDENT

public static final java.lang.String DEFAULT_INDENT

See Also:

Constant Field Values

ROW_SEPARATOR

public static final java.lang.String ROW_SEPARATOR

See Also:

Constant Field Values

ROW_BEGIN_END

public static final java.lang.String ROW_BEGIN_END

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

result

protected final java.lang.Object result

Constructor Detail

ResultFormatter

public ResultFormatter(java.lang.Object result)

Creates a new formatter for a particular object.

ResultFormatter

public ResultFormatter(java.lang.Object result,
                       boolean printHeader,
                       java.lang.String indentToUse)

Method Detail

format

public java.lang.String format()

Returns a formatted value.

format

public java.lang.String format(int wrapColumn)

format

protected java.lang.String format(java.lang.Object o)

Default object formatter using Object.toString().

format

protected java.lang.String format(java.util.Map<?,?> props,
                                  int maxLength)

Object formatter for Map instance. This sorts keys and then formats the key value pairs into a nice tabular representation.

format

protected java.lang.String format(java.util.Map<?,?> props)

wrap

public static java.lang.String[] wrap(java.lang.String value,
                                      int maxLength)

wrap2

public static java.lang.String[] wrap2(java.lang.String value,
                                       int maxLength,
                                       boolean ignoreColon)

wrap

public static java.lang.String[] wrap(java.lang.String value,
                                      int maxLength,
                                      boolean ignoreColon)

wrap

public static java.lang.String[] wrap(java.lang.String value,
                                      int maxLength,
                                      int hangingIndent,
                                      boolean ignoreColon)

formatProperties

public static java.lang.String formatProperties(java.lang.String entityName,
                                                TungstenProperties properties,
                                                boolean printHeader)

formatResults

public static java.lang.String formatResults(java.lang.String entityName,
                                             java.lang.String[] columnNames,
                                             java.util.Vector<java.lang.String[]> results,
                                             int entryWidth)

formatResults

public static java.lang.String formatResults(java.lang.String entityName,
                                             java.lang.String[] columnNames,
                                             java.util.Vector<java.lang.String[]> results,
                                             int entryWidth,
                                             boolean ignoreColon)

formatResults

public static java.lang.String formatResults(java.lang.String entityName,
                                             java.lang.String[] columnNames,
                                             java.util.Vector<java.lang.String[]> results,
                                             int entryWidth,
                                             boolean ignoreColon,
                                             boolean useDelimiters)

formatResult

public static java.lang.String formatResult(java.lang.String entityName,
                                            java.lang.String result)

formatResult

public static java.lang.String formatResult(java.lang.String entityName,
                                            java.lang.String result,
                                            boolean ignoreColon)

formatResult

public static java.lang.String formatResult(java.lang.String entityName,
                                            java.lang.String result,
                                            boolean ignoreColon,
                                            boolean useDelimiters)

makeRow

public static java.lang.String makeRow(java.lang.String[] entries,
                                       int entryWidth)

makeRow

public static java.lang.String makeRow(java.lang.String[] entries,
                                       int entryWidth,
                                       boolean ignoreColon)

makeRow

public static java.lang.String makeRow(java.lang.String[] entries,
                                       int entryWidth,
                                       int indentToUse,
                                       boolean ignoreColon)

makeRow

public static java.lang.String makeRow(java.lang.String[] entries,
                                       int entryWidth,
                                       int indentToUse,
                                       boolean ignoreColon,
                                       boolean useDelimiters)

makeDataRow

public static java.lang.String makeDataRow(java.lang.String[] entries,
                                           int entryWidth,
                                           int indentToUse,
                                           boolean ignoreColon,
                                           boolean useDelimiters)

makeSeparator

public static java.lang.String makeSeparator(int entryWidth,
                                             int columnCount)

makeSeparator

public static java.lang.String makeSeparator(int entryWidth,
                                             int columnCount,
                                             boolean useDelimiters)

formatMap

public static java.lang.String formatMap(java.util.Map<java.lang.String,?> map)