com.pivotal.gemfirexd.internal.tools

Class JDBCDisplayUtil

java.lang.Object

com.pivotal.gemfirexd.internal.tools.JDBCDisplayUtil

public class JDBCDisplayUtil
extends Object

This class contains utility methods for displaying JDBC objects and results.

All of the methods are static. The output stream to write to is always passed in, along with the JDBC objects to display.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	showSelectCount
static boolean	showSelectRows

Constructor Summary

Constructors

Constructor and Description
JDBCDisplayUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkNotNull(Object o, String what) Check if an object is null, and if it is, throw an exception with an informative parameter about what was null.
static int	DisplayBanner(PrintStream out, ResultSetMetaData rsmd)
static int	DisplayBanner(PrintWriter out, ResultSetMetaData rsmd) Print a banner containing the column labels separated with '|'s and a line of '-'s.
static void	DisplayCurrentRow(PrintStream out, ResultSet rs, Connection conn)
static void	DisplayCurrentRow(PrintWriter out, ResultSet rs, Connection conn, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer) Display the current row of the result set along with a banner.
static void	DisplayMultipleResults(PrintWriter out, List resultSets, Connection conn, int[] displayColumns, int[] displayColumnWidths, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
static void	DisplayNextRow(PrintStream out, ResultSet rs, Connection conn)
static void	DisplayNextRow(PrintWriter out, ResultSet rs, Connection conn, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer) Fetch the next row of the result set, and if it exists format and display a banner and the row.
static void	DisplayResults(PrintStream out, ResultSet rs, Connection conn)
static void	DisplayResults(PrintStream out, Statement stmt, Connection conn)
static void	DisplayResults(PrintWriter out, ResultSet rs, Connection conn, int[] displayColumns, int[] displayColumnWidths, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
static void	DisplayResults(PrintWriter out, Statement stmt, Connection conn, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer) Pretty-print the results of a statement that has been executed.
static void	doTrace(PrintStream out, Exception e)
static void	doTrace(PrintWriter out, Exception e) If the property gfxd.exceptionTrace is true, display the stack trace to the print stream.
static int	getMaxColumnWidth(String columnName)
static int	getMaxColumnWidthExplicit(String columnName)
static int	getMaxDisplayWidth()
static int	getMaxLineWidth()
static String	mapNull(String s, String nullValue) Map the string to the value if it is null.
static void	setMaxDisplayWidth(int maxDisplayWidth)
static void	setMaxDisplayWidth(String columnName, int maxDisplayWidth)
static void	setMaxLineWidth(int width, boolean explicit)
static void	setPaging(boolean on)
static void	ShowException(PrintStream out, Throwable e)
static void	ShowException(PrintWriter out, Throwable e) Print information about the exception to the given PrintWriter.
static void	ShowSQLException(PrintStream out, SQLException e)
static void	ShowSQLException(PrintWriter out, SQLException e) Print information about the SQL exception to the given PrintWriter.
static void	ShowWarnings(PrintStream out, Connection theConnection)
static void	ShowWarnings(PrintStream out, ResultSet rs)
static void	ShowWarnings(PrintStream out, SQLWarning warning)
static void	ShowWarnings(PrintStream out, Statement s)
static void	ShowWarnings(PrintWriter out, Connection theConnection) Print information about the SQL warnings for the connection to the given PrintWriter.
static int	ShowWarnings(PrintWriter out, ResultSet rs) Print information about the SQL warnings for the ResultSet to the given PrintWriter.
static int	ShowWarnings(PrintWriter out, SQLWarning warning)
static void	ShowWarnings(PrintWriter out, Statement s) Print information about the SQL warnings for the Statement to the given PrintWriter.

Methods inherited from class java.lang.Object

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

Field Detail

showSelectCount

public static boolean showSelectCount

showSelectRows

public static boolean showSelectRows

Constructor Detail

JDBCDisplayUtil

public JDBCDisplayUtil()

Method Detail

ShowException

public static void ShowException(PrintWriter out,
                 Throwable e)

Print information about the exception to the given PrintWriter. For non-SQLExceptions, does a stack trace. For SQLExceptions, print a standard error message and walk the list, if any.

Parameters:

out - the place to write to

e - the exception to display

ShowSQLException

public static void ShowSQLException(PrintWriter out,
                    SQLException e)

Print information about the SQL exception to the given PrintWriter. Walk the list of exceptions, if any.

Parameters:

out - the place to write to

e - the exception to display

ShowWarnings

public static void ShowWarnings(PrintWriter out,
                Connection theConnection)

Print information about the SQL warnings for the connection to the given PrintWriter. Walks the list of exceptions, if any.

Parameters:

out - the place to write to

theConnection - the connection that may have warnings.

ShowWarnings

public static int ShowWarnings(PrintWriter out,
               SQLWarning warning)

Parameters:

out - the place to write to

warning - the SQLWarning

ShowWarnings

public static int ShowWarnings(PrintWriter out,
               ResultSet rs)

Print information about the SQL warnings for the ResultSet to the given PrintWriter. Walk the list of exceptions, if any.

Parameters:

out - the place to write to

rs - the ResultSet that may have warnings on it

ShowWarnings

public static void ShowWarnings(PrintWriter out,
                Statement s)

Print information about the SQL warnings for the Statement to the given PrintWriter. Walks the list of exceptions, if any.

Parameters:

out - the place to write to

s - the Statement that may have warnings on it

DisplayResults

public static void DisplayResults(PrintWriter out,
                  Statement stmt,
                  Connection conn,
                  scala.tools.jline.console.ConsoleReader reader,
                  com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                           throws SQLException

Pretty-print the results of a statement that has been executed. If it is a select, gathers and prints the results. Display partial results up to the first error. If it is not a SELECT, determine if rows were involved or not, and print the appropriate message.

Parameters:

out - the place to write to

stmt - the Statement to display

conn - the Connection against which the statement was executed

Throws:

SQLException - on JDBC access failure

DisplayMultipleResults

public static void DisplayMultipleResults(PrintWriter out,
                          List resultSets,
                          Connection conn,
                          int[] displayColumns,
                          int[] displayColumnWidths,
                          scala.tools.jline.console.ConsoleReader reader,
                          com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                                   throws SQLException

Parameters:

out - the place to write to

resultSets - list of ResultSets to display

conn - the connection against which the ResultSets were retrieved

displayColumns - column numbers to display, null if all

displayColumnWidths - column widths, in characters, if displayColumns is specified

Throws:

SQLException - on JDBC access failure

DisplayResults

public static void DisplayResults(PrintWriter out,
                  ResultSet rs,
                  Connection conn,
                  int[] displayColumns,
                  int[] displayColumnWidths,
                  scala.tools.jline.console.ConsoleReader reader,
                  com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                           throws SQLException

Parameters:

out - the place to write to

rs - the ResultSet to display

conn - the connection against which the ResultSet was retrieved

displayColumns - column numbers to display, null if all

displayColumnWidths - column widths, in characters, if displayColumns is specified

Throws:

SQLException - on JDBC access failure

DisplayNextRow

public static void DisplayNextRow(PrintWriter out,
                  ResultSet rs,
                  Connection conn,
                  scala.tools.jline.console.ConsoleReader reader,
                  com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                           throws SQLException

Fetch the next row of the result set, and if it exists format and display a banner and the row.

Parameters:

out - the place to write to

rs - the ResultSet in use

conn - the Connection against which the ResultSet was retrieved

Throws:

SQLException - on JDBC access failure

DisplayCurrentRow

public static void DisplayCurrentRow(PrintWriter out,
                     ResultSet rs,
                     Connection conn,
                     scala.tools.jline.console.ConsoleReader reader,
                     com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                              throws SQLException

Display the current row of the result set along with a banner. Assume the result set is on a row.

Parameters:

out - the place to write to

rs - the ResultSet in use

conn - the Connection against which the ResultSet was retrieved

Throws:

SQLException - on JDBC access failure

DisplayBanner

public static int DisplayBanner(PrintWriter out,
                ResultSetMetaData rsmd)
                         throws SQLException

Print a banner containing the column labels separated with '|'s and a line of '-'s. Each field is as wide as the display width reported by the metadata.

Parameters:

out - the place to write to

rsmd - the ResultSetMetaData to use

Throws:

SQLException - on JDBC access failure

checkNotNull

public static void checkNotNull(Object o,
                String what)

Check if an object is null, and if it is, throw an exception with an informative parameter about what was null. The exception is a run-time exception that is internal to ij.

Parameters:

o - the object to test

what - the information to include in the error if it is null

mapNull

public static String mapNull(String s,
             String nullValue)

Map the string to the value if it is null.

Parameters:

s - the string to test for null

nullValue - the value to use if s is null

Returns:

if s is non-null, s; else nullValue.

doTrace

public static void doTrace(PrintWriter out,
           Exception e)

If the property gfxd.exceptionTrace is true, display the stack trace to the print stream. Otherwise, do nothing.

Parameters:

out - the output stream to write to

e - the exception to display

setMaxDisplayWidth

public static void setMaxDisplayWidth(int maxDisplayWidth)

ShowException

public static void ShowException(PrintStream out,
                 Throwable e)

ShowSQLException

public static void ShowSQLException(PrintStream out,
                    SQLException e)

ShowWarnings

public static void ShowWarnings(PrintStream out,
                Connection theConnection)

ShowWarnings

public static void ShowWarnings(PrintStream out,
                SQLWarning warning)

ShowWarnings

public static void ShowWarnings(PrintStream out,
                ResultSet rs)

ShowWarnings

public static void ShowWarnings(PrintStream out,
                Statement s)

DisplayResults

public static void DisplayResults(PrintStream out,
                  Statement stmt,
                  Connection conn)
                           throws SQLException

Throws:

SQLException

DisplayResults

public static void DisplayResults(PrintStream out,
                  ResultSet rs,
                  Connection conn)
                           throws SQLException

Throws:

SQLException

DisplayNextRow

public static void DisplayNextRow(PrintStream out,
                  ResultSet rs,
                  Connection conn)
                           throws SQLException

Throws:

SQLException

DisplayCurrentRow

public static void DisplayCurrentRow(PrintStream out,
                     ResultSet rs,
                     Connection conn)
                              throws SQLException

Throws:

SQLException

DisplayBanner

public static int DisplayBanner(PrintStream out,
                ResultSetMetaData rsmd)
                         throws SQLException

Throws:

SQLException

doTrace

public static void doTrace(PrintStream out,
           Exception e)

setMaxLineWidth

public static void setMaxLineWidth(int width,
                   boolean explicit)

getMaxDisplayWidth

public static int getMaxDisplayWidth()

getMaxColumnWidth

public static int getMaxColumnWidth(String columnName)

getMaxColumnWidthExplicit

public static int getMaxColumnWidthExplicit(String columnName)

getMaxLineWidth

public static int getMaxLineWidth()

setMaxDisplayWidth

public static void setMaxDisplayWidth(String columnName,
                      int maxDisplayWidth)

setPaging

public static void setPaging(boolean on)