public class JDBCDisplayUtil
extends java.lang.Object
All of the methods are static. The output stream to write to is always passed in, along with the JDBC objects to display.
Modifier and Type | Field and Description |
---|---|
private static int |
MAX_RETRIES |
private static int |
maxWidth |
private static int |
MINWIDTH |
private static boolean |
showSelectCount |
Constructor and Description |
---|
JDBCDisplayUtil() |
Modifier and Type | Method and Description |
---|---|
static void |
checkNotNull(java.lang.Object o,
java.lang.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(java.io.PrintStream out,
java.sql.ResultSetMetaData rsmd) |
static int |
DisplayBanner(java.io.PrintWriter out,
java.sql.ResultSetMetaData rsmd)
Print a banner containing the column labels separated with '|'s
and a line of '-'s.
|
static void |
DisplayCurrentRow(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn) |
static void |
DisplayCurrentRow(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn)
Display the current row of the result set along with
a banner.
|
static void |
DisplayMultipleResults(java.io.PrintWriter out,
java.util.List<java.sql.ResultSet> resultSets,
java.sql.Connection conn,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
DisplayNestedResults(java.io.PrintStream out,
java.util.Vector<java.sql.ResultSet> nr,
java.sql.Connection conn,
int indentLevel) |
private static void |
DisplayNestedResults(java.io.PrintWriter out,
java.util.Vector<java.sql.ResultSet> nr,
java.sql.Connection conn,
int indentLevel) |
static void |
DisplayNextRow(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn) |
static void |
DisplayNextRow(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn)
Fetch the next row of the result set, and if it
exists format and display a banner and the row.
|
static void |
DisplayResults(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn) |
static void |
DisplayResults(java.io.PrintStream out,
java.sql.Statement stmt,
java.sql.Connection conn) |
static void |
DisplayResults(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int[] displayColumns,
int[] displayColumnWidths) |
static void |
DisplayResults(java.io.PrintWriter out,
java.sql.Statement stmt,
java.sql.Connection conn)
Pretty-print the results of a statement that has been executed.
|
private static void |
DisplayRow(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.ResultSetMetaData rsmd,
int rowLen,
java.util.Vector<java.sql.ResultSet> nestedResults,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
DisplayRow(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.ResultSetMetaData rsmd,
int rowLen,
java.util.Vector<java.sql.ResultSet> nestedResults,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths)
Print one row of a result set, padding each field to the
display width and separating them with '|'s
|
(package private) static void |
DisplayUpdateCount(java.io.PrintStream out,
int count,
int indentLevel) |
(package private) static void |
DisplayUpdateCount(java.io.PrintWriter out,
int count,
int indentLevel) |
static void |
doTrace(java.io.PrintStream out,
java.lang.Exception e) |
static void |
doTrace(java.io.PrintWriter out,
java.lang.Exception e)
If the property ij.exceptionTrace is true, display the stack
trace to the print stream.
|
private static int[] |
getColumnDisplayWidths(java.sql.ResultSetMetaData rsmd,
int[] dispColumns,
boolean localizedOutput)
Calculates column display widths from the default widths of the
result set.
|
static boolean |
getShowSelectCount() |
private static boolean |
getSystemBoolean(java.lang.String name)
Get an ij boolean system property.
|
private static int |
indent_DisplayBanner(java.io.PrintStream out,
java.sql.ResultSetMetaData rsmd,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static int |
indent_DisplayBanner(java.io.PrintWriter out,
java.sql.ResultSetMetaData rsmd,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayCurrentRow(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayCurrentRow(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayNextRow(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayNextRow(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayResults(java.io.PrintStream out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayResults(java.io.PrintStream out,
java.sql.Statement stmt,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayResults(java.io.PrintWriter out,
java.util.List<java.sql.ResultSet> resultSets,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayResults(java.io.PrintWriter out,
java.sql.ResultSet rs,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent_DisplayResults(java.io.PrintWriter out,
java.sql.Statement stmt,
java.sql.Connection conn,
int indentLevel,
int[] displayColumns,
int[] displayColumnWidths) |
private static void |
indent(java.io.PrintStream out,
int indentLevel) |
private static void |
indent(java.io.PrintWriter out,
int indentLevel) |
private static void |
indentedPrintLine(java.io.PrintStream out,
int indentLevel,
java.lang.String text) |
private static void |
indentedPrintLine(java.io.PrintStream out,
int indentLevel,
java.lang.StringBuffer text) |
private static void |
indentedPrintLine(java.io.PrintWriter out,
int indentLevel,
java.lang.String text) |
private static void |
indentedPrintLine(java.io.PrintWriter out,
int indentLevel,
java.lang.StringBuffer text) |
static java.lang.String |
mapNull(java.lang.String s,
java.lang.String nullValue)
Map the string to the value if it is null.
|
static void |
setMaxDisplayWidth(int maxDisplayWidth) |
static void |
setShowSelectCount(boolean newValue) |
static void |
ShowException(java.io.PrintStream out,
java.lang.Throwable e) |
static void |
ShowException(java.io.PrintWriter out,
java.lang.Throwable e)
Print information about the exception to the given PrintWriter.
|
static void |
ShowSQLException(java.io.PrintStream out,
java.sql.SQLException e) |
static void |
ShowSQLException(java.io.PrintWriter out,
java.sql.SQLException e)
Print information about the SQL exception to the given PrintWriter.
|
static void |
ShowWarnings(java.io.PrintStream out,
java.sql.Connection theConnection) |
static void |
ShowWarnings(java.io.PrintStream out,
java.sql.ResultSet rs) |
static void |
ShowWarnings(java.io.PrintStream out,
java.sql.SQLWarning warning) |
static void |
ShowWarnings(java.io.PrintStream out,
java.sql.Statement s) |
static void |
ShowWarnings(java.io.PrintWriter out,
java.sql.Connection theConnection)
Print information about the SQL warnings for the connection
to the given PrintWriter.
|
static void |
ShowWarnings(java.io.PrintWriter out,
java.sql.ResultSet rs)
Print information about the SQL warnings for the ResultSet
to the given PrintWriter.
|
static void |
ShowWarnings(java.io.PrintWriter out,
java.sql.SQLWarning warning) |
static void |
ShowWarnings(java.io.PrintWriter out,
java.sql.Statement s)
Print information about the SQL warnings for the Statement
to the given PrintWriter.
|
private static final int MINWIDTH
private static int maxWidth
private static boolean showSelectCount
private static final int MAX_RETRIES
public static boolean getShowSelectCount()
public static void setShowSelectCount(boolean newValue)
public static void ShowException(java.io.PrintWriter out, java.lang.Throwable e)
out
- the place to write toe
- the exception to displaypublic static void ShowSQLException(java.io.PrintWriter out, java.sql.SQLException e)
out
- the place to write toe
- the exception to displaypublic static void ShowWarnings(java.io.PrintWriter out, java.sql.Connection theConnection)
out
- the place to write totheConnection
- the connection that may have warnings.public static void ShowWarnings(java.io.PrintWriter out, java.sql.SQLWarning warning)
out
- the place to write towarning
- the SQLWarningpublic static void ShowWarnings(java.io.PrintWriter out, java.sql.ResultSet rs)
out
- the place to write tors
- the ResultSet that may have warnings on itpublic static void ShowWarnings(java.io.PrintWriter out, java.sql.Statement s)
out
- the place to write tos
- the Statement that may have warnings on itpublic static void DisplayResults(java.io.PrintWriter out, java.sql.Statement stmt, java.sql.Connection conn) throws java.sql.SQLException
out
- the place to write tostmt
- the Statement to displayconn
- the Connection against which the statement was executedjava.sql.SQLException
- on JDBC access failureprivate static void indent_DisplayResults(java.io.PrintWriter out, java.sql.Statement stmt, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
static void DisplayUpdateCount(java.io.PrintWriter out, int count, int indentLevel)
out
- the place to write tocount
- the update count to displayindentLevel
- number of tab stops to indent lineprivate static int[] getColumnDisplayWidths(java.sql.ResultSetMetaData rsmd, int[] dispColumns, boolean localizedOutput) throws java.sql.SQLException
java.sql.SQLException
public static void DisplayMultipleResults(java.io.PrintWriter out, java.util.List<java.sql.ResultSet> resultSets, java.sql.Connection conn, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
out
- the place to write toresultSets
- list of ResultSet
s to displayconn
- the connection against which the ResultSet
s
were retrieveddisplayColumns
- column numbers to display, null
if alldisplayColumnWidths
- column widths, in characters, if
displayColumns
is specifiedjava.sql.SQLException
- on JDBC access failurepublic static void DisplayResults(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
out
- the place to write tors
- the ResultSet
to displayconn
- the connection against which the ResultSet
was retrieveddisplayColumns
- column numbers to display, null
if alldisplayColumnWidths
- column widths, in characters, if
displayColumns
is specifiedjava.sql.SQLException
- on JDBC access failureprivate static void indent_DisplayResults(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
private static void indent_DisplayResults(java.io.PrintWriter out, java.util.List<java.sql.ResultSet> resultSets, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
private static void DisplayNestedResults(java.io.PrintWriter out, java.util.Vector<java.sql.ResultSet> nr, java.sql.Connection conn, int indentLevel) throws java.sql.SQLException
out
- the place to write tonr
- the vector of resultsconn
- the Connection against which the ResultSet was retrievedindentLevel
- number of tab stops to indent linejava.sql.SQLException
- thrown on access errorpublic static void DisplayNextRow(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn) throws java.sql.SQLException
out
- the place to write tors
- the ResultSet in useconn
- the Connection against which the ResultSet was retrievedjava.sql.SQLException
- on JDBC access failureprivate static void indent_DisplayNextRow(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
public static void DisplayCurrentRow(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn) throws java.sql.SQLException
out
- the place to write tors
- the ResultSet in useconn
- the Connection against which the ResultSet was retrievedjava.sql.SQLException
- on JDBC access failureprivate static void indent_DisplayCurrentRow(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
public static int DisplayBanner(java.io.PrintWriter out, java.sql.ResultSetMetaData rsmd) throws java.sql.SQLException
out
- the place to write torsmd
- the ResultSetMetaData to usejava.sql.SQLException
- on JDBC access failureprivate static int indent_DisplayBanner(java.io.PrintWriter out, java.sql.ResultSetMetaData rsmd, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
private static void DisplayRow(java.io.PrintWriter out, java.sql.ResultSet rs, java.sql.ResultSetMetaData rsmd, int rowLen, java.util.Vector<java.sql.ResultSet> nestedResults, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
out
- the place to write tors
- the ResultSet to usersmd
- the ResultSetMetaData to userowLen
- nestedResults
- conn
- indentLevel
- number of tab stops to indent linedisplayColumns
- A list of column numbers to displaydisplayColumnWidths
- If displayColumns is set, the width of
columns to display, in characters.java.sql.SQLException
- thrown on JDBC access failurepublic static void checkNotNull(java.lang.Object o, java.lang.String what)
o
- the object to testwhat
- the information to include in the error if it is nullpublic static java.lang.String mapNull(java.lang.String s, java.lang.String nullValue)
s
- the string to test for nullnullValue
- the value to use if s is nullpublic static void doTrace(java.io.PrintWriter out, java.lang.Exception e)
out
- the output stream to write toe
- the exception to displaypublic static void setMaxDisplayWidth(int maxDisplayWidth)
private static void indentedPrintLine(java.io.PrintWriter out, int indentLevel, java.lang.String text)
private static void indentedPrintLine(java.io.PrintWriter out, int indentLevel, java.lang.StringBuffer text)
private static void indent(java.io.PrintWriter out, int indentLevel)
public static void ShowException(java.io.PrintStream out, java.lang.Throwable e)
public static void ShowSQLException(java.io.PrintStream out, java.sql.SQLException e)
public static void ShowWarnings(java.io.PrintStream out, java.sql.Connection theConnection)
public static void ShowWarnings(java.io.PrintStream out, java.sql.SQLWarning warning)
public static void ShowWarnings(java.io.PrintStream out, java.sql.ResultSet rs)
public static void ShowWarnings(java.io.PrintStream out, java.sql.Statement s)
public static void DisplayResults(java.io.PrintStream out, java.sql.Statement stmt, java.sql.Connection conn) throws java.sql.SQLException
java.sql.SQLException
private static void indent_DisplayResults(java.io.PrintStream out, java.sql.Statement stmt, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
static void DisplayUpdateCount(java.io.PrintStream out, int count, int indentLevel)
public static void DisplayResults(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn) throws java.sql.SQLException
java.sql.SQLException
private static void indent_DisplayResults(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
private static void DisplayNestedResults(java.io.PrintStream out, java.util.Vector<java.sql.ResultSet> nr, java.sql.Connection conn, int indentLevel) throws java.sql.SQLException
java.sql.SQLException
public static void DisplayNextRow(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn) throws java.sql.SQLException
java.sql.SQLException
private static void indent_DisplayNextRow(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
public static void DisplayCurrentRow(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn) throws java.sql.SQLException
java.sql.SQLException
private static void indent_DisplayCurrentRow(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
public static int DisplayBanner(java.io.PrintStream out, java.sql.ResultSetMetaData rsmd) throws java.sql.SQLException
java.sql.SQLException
private static int indent_DisplayBanner(java.io.PrintStream out, java.sql.ResultSetMetaData rsmd, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
private static void DisplayRow(java.io.PrintStream out, java.sql.ResultSet rs, java.sql.ResultSetMetaData rsmd, int rowLen, java.util.Vector<java.sql.ResultSet> nestedResults, java.sql.Connection conn, int indentLevel, int[] displayColumns, int[] displayColumnWidths) throws java.sql.SQLException
java.sql.SQLException
public static void doTrace(java.io.PrintStream out, java.lang.Exception e)
private static void indentedPrintLine(java.io.PrintStream out, int indentLevel, java.lang.String text)
private static void indentedPrintLine(java.io.PrintStream out, int indentLevel, java.lang.StringBuffer text)
private static void indent(java.io.PrintStream out, int indentLevel)
private static boolean getSystemBoolean(java.lang.String name)
name
- name of the propertyApache Derby V10.13 Internals - Copyright © 2004,2016 The Apache Software Foundation. All Rights Reserved.