wt.pds
Class BasicResultCursor

java.lang.Object
  wt.pds.BasicResultCursor

All Implemented Interfaces:

Cloneable, Externalizable, ResultCursor, Serializable

public class BasicResultCursor

extends Object

implements ResultCursor, Cloneable, Externalizable

This class provides functionality for accessing the rows in a result set. Each statement is executed as needed and the result set next() method is used to advance sequentially. When a result set is exhausted, then the next statement is executed until all statements have been processed.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private WTConnection	connection
private int	count
private ResultSet	currentResultSet
private PreparedStatement	currentStatement
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static int	QUERY_LIMIT_DEFAULT
private int	queryLimit
private boolean	reset
private static String	RESOURCE
private ResultBuilder	resultBuilder
(package private) static long	serialVersionUID
private int	sqlIndex
private StatementBuilder	statementBuilder

Fields inherited from interface wt.pds.ResultCursor

CONNECTION, COUNT, QUERY_LIMIT, RESET, RESULT_BUILDER, STATEMENT_BUILDER

Constructor Summary

BasicResultCursor()

Method Summary

boolean	advance(int a_relative) Advances the ResultCursor the relative number of rows without result processing.
Object	clone() Create a shallow-copy of this object.
void	close() Ensures that any associated result sets and/or statements are closed.
WTConnection	getConnection() Gets the value of the attribute: connection.
int	getCount() Gets the value of the attribute: count; Total number of rows that were traversed (not necessarily returned results).
private boolean	getNextResultSet() Advance to the next valid row in the result set.
int	getQueryLimit() Gets the value of the attribute: queryLimit.
ResultBuilder	getResultBuilder() Gets the object for the association that plays role: resultBuilder.
StatementBuilder	getStatementBuilder() Gets the object for the association that plays role: statementBuilder.
boolean	isReset() Gets the value of the attribute: reset; Indicates if the result cursor has been reset.
Object[]	next(AccessController a_accessController) Advance to the next valid row in the result set and returned the built objects.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(BasicResultCursor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	resultBuilderValidate(ResultBuilder a_ResultBuilder)
void	setConnection(WTConnection a_Connection) Sets the value of the attribute: connection.
void	setQueryLimit(int a_QueryLimit) Sets the value of the attribute: queryLimit.
void	setReset(boolean a_Reset) Sets the value of the attribute: reset; Indicates if the result cursor has been reset.
void	setResultBuilder(ResultBuilder a_ResultBuilder) Sets the object for the association that plays role: resultBuilder.
void	setStatementBuilder(StatementBuilder a_StatementBuilder) Sets the object for the association that plays role: statementBuilder.
private void	statementBuilderValidate(StatementBuilder a_StatementBuilder)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

count

private transient int count

queryLimit

private int queryLimit

QUERY_LIMIT_DEFAULT

private static final int QUERY_LIMIT_DEFAULT

statementBuilder

private transient StatementBuilder statementBuilder

resultBuilder

private transient ResultBuilder resultBuilder

reset

private boolean reset

connection

private transient WTConnection connection

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

currentStatement

private transient PreparedStatement currentStatement

currentResultSet

private transient ResultSet currentResultSet

sqlIndex

private transient int sqlIndex

Constructor Detail

BasicResultCursor

public BasicResultCursor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(BasicResultCursor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getCount

public int getCount()

Gets the value of the attribute: count; Total number of rows that were traversed (not necessarily returned results).

Supported API: false

Specified by:

getCount in interface ResultCursor

Returns:

int

getQueryLimit

public int getQueryLimit()

Gets the value of the attribute: queryLimit.

Supported API: false

Specified by:

getQueryLimit in interface ResultCursor

Returns:

int

setQueryLimit

public void setQueryLimit(int a_QueryLimit)

Sets the value of the attribute: queryLimit.

Supported API: false

Parameters:

a_QueryLimit -

getStatementBuilder

public StatementBuilder getStatementBuilder()

Gets the object for the association that plays role: statementBuilder.

Supported API: false

Specified by:

getStatementBuilder in interface ResultCursor

Returns:

StatementBuilder

setStatementBuilder

public void setStatementBuilder(StatementBuilder a_StatementBuilder)
                         throws WTPropertyVetoException

Sets the object for the association that plays role: statementBuilder.

Supported API: false

Specified by:

setStatementBuilder in interface ResultCursor

Parameters:

a_StatementBuilder -

Throws:

WTPropertyVetoException

statementBuilderValidate

private void statementBuilderValidate(StatementBuilder a_StatementBuilder)
                               throws WTPropertyVetoException

Parameters:

a_StatementBuilder -

Throws:

WTPropertyVetoException

getResultBuilder

public ResultBuilder getResultBuilder()

Gets the object for the association that plays role: resultBuilder.

Supported API: false

Specified by:

getResultBuilder in interface ResultCursor

Returns:

ResultBuilder

setResultBuilder

public void setResultBuilder(ResultBuilder a_ResultBuilder)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: resultBuilder.

Supported API: false

Specified by:

setResultBuilder in interface ResultCursor

Parameters:

a_ResultBuilder -

Throws:

WTPropertyVetoException

resultBuilderValidate

private void resultBuilderValidate(ResultBuilder a_ResultBuilder)
                            throws WTPropertyVetoException

Parameters:

a_ResultBuilder -

Throws:

WTPropertyVetoException

isReset

public boolean isReset()

Gets the value of the attribute: reset; Indicates if the result cursor has been reset.

Supported API: false

Specified by:

isReset in interface ResultCursor

Returns:

boolean

setReset

public void setReset(boolean a_Reset)
              throws WTPropertyVetoException

Sets the value of the attribute: reset; Indicates if the result cursor has been reset.

Supported API: false

Specified by:

setReset in interface ResultCursor

Parameters:

a_Reset -

Throws:

WTPropertyVetoException

getConnection

public WTConnection getConnection()

Gets the value of the attribute: connection.

Supported API: false

Specified by:

getConnection in interface ResultCursor

Returns:

WTConnection

setConnection

public void setConnection(WTConnection a_Connection)
                   throws WTPropertyVetoException

Sets the value of the attribute: connection.

Supported API: false

Specified by:

setConnection in interface ResultCursor

Parameters:

a_Connection -

Throws:

WTPropertyVetoException

next

public Object[] next(AccessController a_accessController)
              throws PersistenceException

Advance to the next valid row in the result set and returned the built objects.

Supported API: false

Specified by:

next in interface ResultCursor

Parameters:

a_accessController -

Returns:

Object[]

Throws:

PersistenceException

close

public void close()

Ensures that any associated result sets and/or statements are closed.

Supported API: false

Specified by:

close in interface ResultCursor

advance

public boolean advance(int a_relative)
                throws PersistenceException

Advances the ResultCursor the relative number of rows without result processing.

Supported API: false

Specified by:

advance in interface ResultCursor

Parameters:

a_relative -

Returns:

boolean

Throws:

PersistenceException

getNextResultSet

private boolean getNextResultSet()
                          throws PersistenceException,
                                 SQLException,
                                 WTPropertyVetoException

Advance to the next valid row in the result set.

Throws:

PersistenceException

SQLException

WTPropertyVetoException

clone

public Object clone()

Create a shallow-copy of this object.