com.beasys.commerce.axiom.document.jdbc
Class FindDocumentsStatement

java.lang.Object
  |
  +--com.beasys.commerce.axiom.document.jdbc.CallableStatement
        |
        +--com.beasys.commerce.axiom.document.jdbc.SearchStatement
              |
              +--com.beasys.commerce.axiom.document.jdbc.FindDocumentsStatement

All Implemented Interfaces:

java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

public class FindDocumentsStatement

extends SearchStatement

A callable statement which handles finding documents.

This expects InParam1 to be either a Search or a string query which can be converted to a Search. OutParam1 will be the DocumentIterator of DocumentDefs.

Version:

1.0

Author:

BEA Systems, Inc.

Fields inherited from class com.beasys.commerce.axiom.document.jdbc.SearchStatement

iterator, searchParameters

Fields inherited from class com.beasys.commerce.axiom.document.jdbc.CallableStatement

connection

Constructor Summary

FindDocumentsStatement(Connection con)
Constructor.

Method Summary

protected DocumentIterator

createIterator(DocumentProvider provider, Search params) This method is invoked to generate the DocumentIterator for this object.

Methods inherited from class com.beasys.commerce.axiom.document.jdbc.SearchStatement

clearParameters, close, closeIterator, execute, getObject, setObject, setString

Methods inherited from class com.beasys.commerce.axiom.document.jdbc.CallableStatement

addBatch, addBatch, cancel, clearBatch, clearWarnings, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, getArray, getBigDecimal, getBigDecimal, getBlob, getBoolean, getByte, getBytes, getClob, getConnection, getDate, getDate, getDocumentProvider, getDouble, getFetchDirection, getFetchSize, getFloat, getInt, getLong, getMaxFieldSize, getMaxRows, getMetaData,

Methods inherited from class java.lang.Object

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

Constructor Detail

FindDocumentsStatement

public FindDocumentsStatement(Connection con)

Constructor.

Parameters:

con - the connection that spawned us.

Method Detail

createIterator

protected DocumentIterator createIterator(DocumentProvider provider,
                                          Search params)
                                   throws DocumentException

This method is invoked to generate the DocumentIterator for this object.

Overrides:

createIterator in class SearchStatement

Following copied from class: com.beasys.commerce.axiom.document.jdbc.SearchStatement

Parameters:

p - the DocumentProvider to use.

params - the Search parameters passed into the statement.

Returns:

the DocumentIterator for the resulting search.

Throws:

DocumentException - thrown on an error.