com.aspc.commander.sql.results

Class CommandBuildResultsUtil

java.lang.Object

com.aspc.commander.sql.results.CommandBuildResultsUtil

public final class CommandBuildResultsUtil
extends java.lang.Object

Builds an xml version of a result set. Methods are called on the supplied plugin to fill in details of the result set.
THREAD MODE: SINGLE THREADED command

Since:

May 18 2005

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURSOR_SIZE the default cursor size

Method Summary

Modifier and Type	Method and Description
static void	appendResult(CommandBuildResultsPlugin plugin, Connection connection, org.w3c.dom.Element group, int seq) append the result set to a result group.
static void	appendResult(CommandBuildResultsPlugin plugin, Connection connection, org.w3c.dom.Element group, int offset, int size, java.lang.String cursorName, int seq) Append a result set to a result group for a cursor.
static java.lang.String[]	getAttributeNames(CommandBuildResultsAttPlugin plugin, int row) The attribute Names for this row.
static java.lang.String[]	getAttributeNames(CommandBuildResultsAttPlugin plugin, int row, int col) The attribute value for this column/row.
static java.lang.String	makeString(CommandBuildResultsPlugin plugin, Connection connection, java.util.ArrayList columns, int row, int col) The string value for this column/row.

Methods inherited from class java.lang.Object

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

Field Detail

CURSOR_SIZE

public static final int CURSOR_SIZE

the default cursor size

See Also:

Constant Field Values

Method Detail

appendResult

public static void appendResult(CommandBuildResultsPlugin plugin,
                                Connection connection,
                                org.w3c.dom.Element group,
                                int seq)
                         throws java.lang.Exception

append the result set to a result group.

Parameters:

plugin - The plugin

connection - the connection

group - The XML Element for the result group

seq - The sequence in the result group.

Throws:

java.lang.Exception - A serious problem.

appendResult

public static void appendResult(CommandBuildResultsPlugin plugin,
                                Connection connection,
                                org.w3c.dom.Element group,
                                int offset,
                                int size,
                                java.lang.String cursorName,
                                int seq)
                         throws java.lang.Exception

Append a result set to a result group for a cursor.

Parameters:

plugin - The plugin

connection - the connection

group - The XML Element for the result group

offset - The row offset

size - The number of rows to append

cursorName - The cursor name to use

seq - The sequence number in the result group.

Throws:

java.lang.Exception - A serious problem.

getAttributeNames

public static java.lang.String[] getAttributeNames(CommandBuildResultsAttPlugin plugin,
                                                   int row)
                                            throws java.lang.Exception

The attribute Names for this row.

Parameters:

plugin - The plugin

row - The row number ( offset from 1)

Returns:

The string version of the value.

Throws:

java.lang.Exception - A serious problem

getAttributeNames

public static java.lang.String[] getAttributeNames(CommandBuildResultsAttPlugin plugin,
                                                   int row,
                                                   int col)
                                            throws java.lang.Exception

The attribute value for this column/row.

Parameters:

plugin - The plugin

row - The row number ( offset from 1)

col - The column number (offset from 1)

Returns:

The string version of the value.

Throws:

java.lang.Exception - A serious problem

makeString

public static java.lang.String makeString(CommandBuildResultsPlugin plugin,
                                          Connection connection,
                                          java.util.ArrayList columns,
                                          int row,
                                          int col)
                                   throws java.lang.Exception

The string value for this column/row.

Parameters:

plugin - The plugin

connection - the connection

columns - the columns

row - The row number ( offset from 1)

col - The column number (offset from 1)

Returns:

The string version of the value.

Throws:

java.lang.Exception - A serious problem