Index
A
addLastException(DataRuntimeException) -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Adds the
DataRuntimeException newException
as the last Exception
in a linked list of
DataRuntimeException
s.
C
Call - Annotation Type in com.ibm.pdq.annotation
Used in an interface to indicate to the pureQuery Generator that the declared annotated method executes an SQL stored
procedure call.
call(String, CallHandler<CAL>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL stored procedure call
sql
and returns an object of type <CAL>
that indicates the results of the stored procedure call.
call(String, CallHandlerWithParameters<CAL>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL stored procedure call
sql
and returns an object of type <CAL>
that indicates the results of the stored procedure call.
call(String, ParameterHandler, CallHandlerWithParameters<CAL>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL stored procedure call
sql
and returns an object of type <CAL>
that indicates the results of the stored procedure call.
call(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL stored procedure call
sql
and returns an instance of StoredProcedureResult
that represents the results of running sql
.
Processes the results of an SQL stored procedure call and returns an object of type
T
that describes
the results.
Processes the results of an SQL stored procedure call and returns an object of type
CAL
that describes
the results.
Frees all resources and closes the associated instance of
Connection
by calling
Connection.close()
for that instance.
close() -
Method in interface com.ibm.pdq.runtime.ResultIterator
Closes the
ResultSet
that is associated with the ResultIterator
and, if possible, the Statement
that created the ResultSet
, freeing all associated JDBC and database
resources.
close() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Closes the
StoredProcedureResult
instance.
Column - Annotation Type in com.ibm.pdq.annotation
For queries against databases, indicates that the annotated property represents the described column.
ColumnOverride - Annotation Type in com.ibm.pdq.annotation
For queries against databases, indicates that a property in the pureQuery bean represents a particular column.
ColumnOverrides - Annotation Type in com.ibm.pdq.annotation
For queries against databases, specifies an array of
@ColumnOverride
annotations.
com.ibm.pdq.annotation - package com.ibm.pdq.annotation
com.ibm.pdq.runtime - package com.ibm.pdq.runtime
com.ibm.pdq.runtime.data.formatters - package com.ibm.pdq.runtime.data.formatters
com.ibm.pdq.runtime.data.handlers - package com.ibm.pdq.runtime.data.handlers
com.ibm.pdq.runtime.datasource - package com.ibm.pdq.runtime.datasource
com.ibm.pdq.runtime.datasource.datadirect - package com.ibm.pdq.runtime.datasource.datadirect
com.ibm.pdq.runtime.datasource.oracle - package com.ibm.pdq.runtime.datasource.oracle
com.ibm.pdq.runtime.exception - package com.ibm.pdq.runtime.exception
com.ibm.pdq.runtime.factory - package com.ibm.pdq.runtime.factory
com.ibm.pdq.runtime.handlers - package com.ibm.pdq.runtime.handlers
com.ibm.pdq.runtime.statement - package com.ibm.pdq.runtime.statement
Delegates a commit request (
Connection.commit()
) to the associated instance of
Connection
.
Cursor - Annotation Type in com.ibm.pdq.annotation
Specifies cursor attributes for the cursor that is created by the SQL statement that the method runs.
D
Data - Interface in com.ibm.pdq.runtime
Provides methods that can be used to access data sources, which can be databases or in-memory collections.
DataFactory - Class in com.ibm.pdq.runtime.factory
Creates and returns instances of implementations of the
Data
interface and of interfaces
that contain pureQuery annotated methods.
DataFactory() -
Constructor for class com.ibm.pdq.runtime.factory.DataFactory
DataRuntimeException - Exception in com.ibm.pdq.runtime.exception
Indicates the occurrence of an exception in a pureQuery method.
DateFormatter - Class in com.ibm.pdq.runtime.data.formatters
DateFormatter can be used with @Format annotation.
DateFormatter(String) -
Constructor for class com.ibm.pdq.runtime.data.formatters.DateFormatter
E
endBatch() -
Method in interface com.ibm.pdq.runtime.Data
Runs the INSERT, UPDATE, and DELETE SQL statements that are queued for a heterogeneous update with parameters and
returns an
int[][]
that describes the results of the execution.
Extends the class
oracle.jdbc.pool.OracleConnectionPoolDataSource
to provide support for pureQuery.
EnhancedConnectionPoolDataSourceForOracle() -
Constructor for class com.ibm.pdq.runtime.datasource.oracle.EnhancedConnectionPoolDataSourceForOracle
Constructs an instance of
EnhancedConnectionPoolDataSourceForOracle
.
EnhancedDataSource - Interface in com.ibm.pdq.runtime.datasource
Implemented by pureQuery data sources.
A wrapper for the class
com.ddtek.jdbcx.oracle.OracleDataSource
that provides support for pureQuery.
EnhancedDataSourceForOracle() -
Constructor for class com.ibm.pdq.runtime.datasource.datadirect.EnhancedDataSourceForOracle
Constructs an instance of
EnhancedDataSourceForOracle
.
Extends the class
oracle.jdbc.pool.OracleDataSource
to provide support for pureQuery.
EnhancedDataSourceForOracle() -
Constructor for class com.ibm.pdq.runtime.datasource.oracle.EnhancedDataSourceForOracle
Constructs an instance of
EnhancedDataSourceForOracle
.
Extends the class
oracle.jdbc.xa.client.OracleXADataSource
to provide support for pureQuery.
EnhancedXADataSourceForOracle() -
Constructor for class com.ibm.pdq.runtime.datasource.oracle.EnhancedXADataSourceForOracle
Constructs an instance of
EnhancedXADataSourceForOracle
.
ErrorType - Enum in com.ibm.pdq.runtime.exception
Categorizes the reasons for which exceptions are thrown.
F
Format - Annotation Type in com.ibm.pdq.annotation
The Format anotation is used to specify a class that contains methods for converting field data
between String format and JDBC Object, in both directions.
format(Object) -
Method in class com.ibm.pdq.runtime.data.formatters.DateFormatter
format(Object) -
Method in class com.ibm.pdq.runtime.data.formatters.TimeFormatter
format(Object) -
Method in class com.ibm.pdq.runtime.data.formatters.TimestampFormatter
G
GeneratedKey - Annotation Type in com.ibm.pdq.annotation
When used to annotate a property of a pureQuery bean, directs pureQuery to set the value of the property to the value
of the corresponding database column after an SQL INSERT statement runs.
GenerationException - Exception in com.ibm.pdq.runtime.exception
Indicates the occurrence of an exception in the pureQuery code while generating implementations for classes with
annotated methods.
getArray() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an array such that each element in the array contains the contents of a row of the query
result in a
Map
.
getArray(Class<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an array such that each element in the array contains the contents of a row of the query
result in a pureQuery bean that is an instance of the class
<ROW>
.
getArray(Class<ROW>, RowHandler<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an array such that each element in the array contains the contents of a row of the query
result in a an instance of the class
<ROW>
.
getArray(RowHandler<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Deprecated.
getAutoCommit() -
Method in interface com.ibm.pdq.runtime.Data
Returns a
boolean
that indicates whether auto-commit mode is enabled for the associated instance of Connection
.
getBatchKind() -
Method in interface com.ibm.pdq.runtime.Data
Returns a value of
HeterogeneousBatchKind
, which indicates that SQL statements are
being run immediately, or that a batch for a heterogeneous update with parameters is being created.
getColumnNumber() -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Returns the starting column of the annotated method declaration whose processing caused the exception.
getConnection() -
Method in interface com.ibm.pdq.runtime.Data
Returns the
Connection
object that is associated with the instance of Data
, if
such an object exists.
getData() -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface for queries over
collections.
getData(Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface for queries over
collections.
getData(Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface for queries over
collections.
getData(Connection) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(Connection, Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(Connection, Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(Connection, Hook, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(Connection, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(Connection, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the
Data
interface, with an
implementation that is based on whether the execution mode is dynamic or static.
getData(DataSource) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(DataSource, Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(DataSource, Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(DataSource, Hook, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(DataSource, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(DataSource, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface for queries over collections.
getData(Class<T>, Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface for queries over collections.
getData(Class<T>, Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface for queries over collections.
getData(Class<T>, Connection) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, Connection, Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, Connection, Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, Connection, Hook, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, Connection, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, Connection, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation that is based on whether the execution mode is
dynamic or static.
getData(Class<T>, DataSource) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, DataSource, Hook) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, DataSource, Hook, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, DataSource, Hook, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, DataSource, Map<Object, Object>) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, DataSource, Properties) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Establishes a
Connection
to the DataSource
ds
, if possible, and if
a Connection
is established, returns an instance of a class that implements both the
interfaceClass
interface and the Data
interface, with an implementation
that is based on whether the execution mode is dynamic or static.
getData(Class<T>, Data) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
Returns an instance of a class that implements the two interfaces
interfaceClass
and Data
.
getErrorCode() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns the error code for this
DataRuntimeException
.
getErrorType() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns an
ErrorType
object that indicates the error type of this
DataRuntimeException
.
getExceptionLocation() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns the
int
that indicates where in the code the exception occurred.
getHeterogeneousUpdateCounts() -
Method in exception com.ibm.pdq.runtime.exception.UpdateManyException
If the exception was thrown while executing
Data.endBatch()
, returns an
int
array of arrays that describes the results of executing the heterogeneous update with
parameters.
getIterator() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an
Iterator
instance such that each call to the
Iterator.next()
method of the instance provides the contents of a row of the query result in a
Map
.
getIterator(Class<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an
Iterator
instance such that each call to the
Iterator.next()
method of the Iterator
instance provides the contents of a row of
the query result in a pureQuery bean that is an instance of the class <ROW>
.
getIterator(RowHandler<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an
Iterator
instance such that each call to the
Iterator.next()
method of the Iterator
instance provides the contents of a row of
the query result in an instance of the class <ROW>
.
getLength() -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Returns the length of the annotated method declaration whose processing caused the exception.
getLineNumber() -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Returns the starting line number of the annotated method declaration whose processing caused the exception.
getList() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in a
List
instance such that each element in the instance contains the
contents of a row of the query result in a Map
.
getList(Class<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in a
List
instance such that each element in the List
instance
contains the contents of a row of the query result in a pureQuery bean that is an instance of the class
<ROW>
.
getList(RowHandler<ROW>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in a
List
instance such that each element in the List
instance
contains the contents of a row of the query result in an instance of the class <ROW>
.
getLogger() -
Method in interface com.ibm.pdq.runtime.Data
Returns the instance of
DataLogger
to use for all of the logging that
occurs in association with the instance of Data
.
getMessage() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns the message that is associated with the exception.
getNextException() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns the
DataRuntimeException nextException
that is the next Exception
in a linked
list of DataRuntimeException
s.
getOutputParms() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Returns an
Object[]
of OUT and INOUT parameters.
getPdqProperties() -
Method in class com.ibm.pdq.runtime.datasource.datadirect.EnhancedDataSourceForOracle
getPdqProperties() -
Method in interface com.ibm.pdq.runtime.datasource.EnhancedDataSource
Returns the string of pureQuery properties that was set by using the method
EnhancedDataSource.setPdqProperties(String pdqProperties)
.
getPdqProperties() -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedConnectionPoolDataSourceForOracle
getPdqProperties() -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedDataSourceForOracle
getPdqProperties() -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedXADataSourceForOracle
getProductVersion() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns a
String
that indicates the version of the pureQuery code in which the exception occurred.
getQuery(ResultHandler<RES>) -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one exists, and returns the contents
of the query result in an
Object
of type <RES>
.
getResults() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Advances to the next (or first) query result for the stored procedure call, if one eists, and returns the contents
of the query result in an instance of
ResultSet
.
getSQLState() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns the SQLState for this
DataRuntimeException
.
getSqlStatementType(String) -
Static method in enum com.ibm.pdq.runtime.statement.SqlStatementType
getStartPosition() -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Returns the starting position (in characters from the start of the file) of the annotated method declaration whose
processing caused the exception.
getUpdateCounts() -
Method in exception com.ibm.pdq.runtime.exception.UpdateManyException
Returns an
int[]
that provides the update counts for the execution of the SQL in the format that is
used for the return value of Statement.executeBatch()
.
Group - Annotation Type in com.ibm.pdq.annotation
This annotation can be used on pureQuery API DAO interfaces to indicate that the Interface should inherit Generator
and / or StaticBinder properties when those utilities operate on this Interface.
H
handle(ResultSet) -
Method in class com.ibm.pdq.runtime.data.handlers.IteratorPagingResultHandler
Returns an instance of
ResultIterator
that can be used to return each row of the
specified page of resultSet
in the specified format.
handle(ResultSet) -
Method in class com.ibm.pdq.runtime.data.handlers.IteratorResultHandler
Returns an instance of
ResultIterator
that can be used to return each row of
resultSet
in the specified format.
handle(ResultSet) -
Method in class com.ibm.pdq.runtime.data.handlers.JSONResultHandler
Returns the results of an SQL statement as a
String
in the JSON format.
handle(ResultSet) -
Method in class com.ibm.pdq.runtime.data.handlers.XMLResultHandler
Returns the results of an SQL statement as an XML
String
.
handle(ResultSet) -
Method in interface com.ibm.pdq.runtime.handlers.ResultHandler
Processes an entire
ResultSet
for an SQL statement and returns the contents in an object of type
RES
.
handle(ResultSet, ROW) -
Method in interface com.ibm.pdq.runtime.handlers.RowHandler
Processes one row from the
ResultSet
for an SQL statement and returns the contents in an object of
type ROW
.
handle(ResultSet, ROW, Object[]) -
Method in interface com.ibm.pdq.runtime.handlers.RowHandlerWithParameters
Processes one row from the
ResultSet
for an SQL statement and returns the contents in an object of
type ROW
.
handleCall(CallableStatement) -
Method in interface com.ibm.pdq.runtime.handlers.CallHandler
Processes the results of an SQL stored procedure call and returns an object of type
T
that describes
the results.
handleCall(CallableStatement, Object...) -
Method in interface com.ibm.pdq.runtime.handlers.CallHandlerWithParameters
Processes the results of an SQL stored procedure call and returns an object of type
CAL
that
describes the results.
handleParameters(PreparedStatement, Object...) -
Method in interface com.ibm.pdq.runtime.handlers.ParameterHandler
Registers any OUT or INOUT parameters and sets the values of the IN and INOUT parameters in the
PreparedStatement stmt
from the values in the passed-in parameters
.
Handler - Annotation Type in com.ibm.pdq.annotation
Annotation through which handlers may be specified for an annotated method.
HeterogeneousBatchKind - Enum in com.ibm.pdq.runtime
Indicates for an instance of
Data
that SQL statements are being executed immediately, or
that a batch for a heterogeneous update with parameters is being created.
Hook - Interface in com.ibm.pdq.runtime.statement
Provides the ability to provide pre-execution and post-execution methods bracketing the execution of any
Data
API or annotated method.
I
Id - Annotation Type in com.ibm.pdq.annotation
Indicates that the annotated property represents a Identity column for the purposes of Nested Query Bean support.
isQuery() -
Method in enum com.ibm.pdq.runtime.statement.SqlStatementType
isSqlSetOrSetMethod() -
Method in enum com.ibm.pdq.runtime.statement.SqlStatementType
isTransient() -
Method in exception com.ibm.pdq.runtime.exception.DataRuntimeException
Returns a
boolean
value that indicates whether the action that resulted in this exception has a
chance to succeed if attempted again.
An implementation of
ResultHandler
that can be specified to cause pureQuery to return content of a
specified page of the results of an SQL query as an instance of ResultIterator
.
IteratorPagingResultHandler(int, int, RowHandler<T>) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorPagingResultHandler
Constructs an instance of
IteratorPagingResultHandler<T>
that can be provided to a pureQuery
method so that the method returns an instance of ResultIterator
that uses
singleRowHandler
to process and to return each row of the specified page of the SQL query results.
IteratorPagingResultHandler(int, int, Class<T>) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorPagingResultHandler
Constructs an instance of
IteratorPagingResultHandler<T>
that can be provided to a pureQuery
method so that the method returns an instance of ResultIterator
that returns content of
the rows of the specified page of the SQL query results as instances of the class beanClass
.
IteratorPagingResultHandler(RowHandler<T>, int, int) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorPagingResultHandler
Constructs an instance of
IteratorPagingResultHandler<T>
that can be provided to a pureQuery
method so that the method returns an instance of ResultIterator
that uses the
singleRowHandler
to process and to return each row of the specified page of the SQL query results.
IteratorPagingResultHandler(Class<T>, int, int) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorPagingResultHandler
Constructs an instance of
IteratorPagingResultHandler<T>
that can be provided to a pureQuery
method so that the method returns an instance of ResultIterator
that returns content of
the rows of the specified page of the SQL query results as instances of the class beanClass
.
An implementation of
ResultHandler
that can be specified to cause pureQuery to return content of the
results of an SQL query as an instance of ResultIterator
.
IteratorResultHandler(RowHandler<T>) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorResultHandler
Constructs an instance of
IteratorResultHandler<T>
that can be provided to a pureQuery method
so that the method returns an instance of ResultIterator
that uses
singleRowHandler
to process and to return each row of the SQL query results.
IteratorResultHandler(RowHandler<T>, Object[]) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorResultHandler
Constructs an instance of
IteratorResultHandler<T>
that can be provided to a pureQuery method
so that the method returns an instance of ResultIterator
that uses
singleRowHandler
to process and to return each row of the SQL query results.
IteratorResultHandler(Class<T>) -
Constructor for class com.ibm.pdq.runtime.data.handlers.IteratorResultHandler
Constructs an instance of
IteratorResultHandler<T>
that can be provided to a pureQuery method
so that the method returns an instance of ResultIterator
that returns content of the
rows of the SQL query results as instances of the class beanClass
.
J
JoinColumn - Annotation Type in com.ibm.pdq.annotation
For queries against databases, indicates that the annotated property represents a Nested Query Bean.
JoinPoint - Annotation Type in com.ibm.pdq.annotation
For queries against databases, specifies an array of zero or more
@JoinColumn
annotations.
An implementation of
ResultHandler
that can be specified to cause pureQuery to return content of the
results of an SQL query as a String
in the JSON format, which is described at
http://www.json.org.
JSONResultHandler() -
Constructor for class com.ibm.pdq.runtime.data.handlers.JSONResultHandler
M
Metadata - Annotation Type in com.ibm.pdq.annotation
This annotation is used by some tools that work with pureQuery beans.
moveToNext() -
Method in interface com.ibm.pdq.runtime.StoredProcedureResult
Deprecated.
P
ParameterHandler - Interface in com.ibm.pdq.runtime.handlers
Sets the values of the parameters in the
PreparedStatement stmt
from the values in the passed-in
parameters
and registers any OUT or INOUT parameters.
parse(String) -
Method in class com.ibm.pdq.runtime.data.formatters.DateFormatter
parse(String) -
Method in class com.ibm.pdq.runtime.data.formatters.TimeFormatter
parse(String) -
Method in class com.ibm.pdq.runtime.data.formatters.TimestampFormatter
post(String, Data, Object, SqlStatementType, Object...) -
Method in interface com.ibm.pdq.runtime.statement.Hook
When an instance of
Hook
is assigned, the Hook.post
method is called after execution.
pre(String, Data, SqlStatementType, Object...) -
Method in interface com.ibm.pdq.runtime.statement.Hook
When an instance of
Hook
is assigned, the Hook.pre
method is called before execution.
processRepositoryDataFactoryX(CentralStoreKey) -
Static method in class com.ibm.pdq.runtime.factory.DataFactory
PureQueryInterface - Annotation Type in com.ibm.pdq.annotation
This annotation is used by IBM Data Studio on interfaces that have no pureQuery annotations but that extend other
interfaces that do have pureQuery annotations.
Q
query(String, ResultHandler<RES>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Object
of type
<RES>
that indicates the query results of the statement.
query(int, int, int, String, ResultHandler<RES>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Object
of type
<RES>
that indicates the results of the statement.
query(int, int, int, String, ParameterHandler, ResultHandler<RES>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Object
of type
<RES>
that indicates the results of the statement.
queryArray(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an array such that each element in the array contains
the contents of a row of the query results in a Map
.
queryArray(String, Class<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an array such that each element in the array contains
the contents of a row of the query results in a pureQuery bean that is an instance of the class
<ROW>
.
queryArray(String, Class<ROW>, RowHandler<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an array such that each element in the array contains
the contents of a row of the query results in an instance of the class <ROW>
.
queryFirst(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns a Map
that represents the first row
of the results that is returned from running the sql
statement.
queryFirst(String, Class<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns the contents of the first row of the query results in a
pureQuery bean that is an instance of the class <ROW>
.
queryFirst(String, RowHandler<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns the contents of the first
row of the
query results in an instance of the class <ROW>
.
queryIterator(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the instance provides the contents of a row of the query
results in a Map
.
queryIterator(int, int, int, String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the instance provides the contents of a row of the query
results in a Map
.
queryIterator(String, Class<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the Iterator
instance provides the contents
of a row of the query results in a pureQuery bean that is an instance of the class <ROW>
.
queryIterator(int, int, int, String, Class<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the Iterator
instance provides the contents
of a row of the query results in a pureQuery bean that is an instance of the class <ROW>
.
queryIterator(String, RowHandler<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the Iterator
instance provides the contents
of a row of the query results in an instance of the class <ROW>
.
queryIterator(int, int, int, String, RowHandler<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an Iterator
instance such that each
call to the Iterator.next()
method of the Iterator
instance provides the contents
of a row of the query results in an instance of the class <ROW>
.
queryList(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns a List
instance such that each
element in the List
instance contains the contents of a row of the query results in a Map
.
queryList(String, Class<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns a List
instance such that each
element in the List
instance contains the contents of a row of the query results in a pureQuery bean
that is an instance of the class <ROW>
.
queryList(String, RowHandler<ROW>, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns a List
instance such that each
element in the List
instance contains the contents of a row of the query results in an instance of
the class <ROW>
.
queryResults(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns the contents of the query results in an instance of ResultSet
.
queryResults(int, int, int, String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns the contents of the query results in an instance of ResultSet
.
R
Required - Annotation Type in com.ibm.pdq.annotation
Indicates that the annotated property must contain a non-null value when the property is used as input for a DAO
or Inline style method invocation.
Processes the entire query result of an SQL statement and returns the contents in an object of type
RES
.
The implementation of
Iterator
in which pureQuery returns the query results of an SQL statement
when the query results are to be returned as an Iterator<T>
.
rollback() -
Method in interface com.ibm.pdq.runtime.Data
Delegates a rollback request
Connection.rollback()
to the associated instance of
Connection
.
Processes one row from the query result of an SQL statement and returns the contents of that row in an object of type
ROW
.
Processes one row from the query result of an SQL statement and returns the contents of that row in an object of type
ROW
.
S
Select - Annotation Type in com.ibm.pdq.annotation
Used in an interface to indicate to the pureQuery Generator that the annotated declared method executes an SQL SELECT
statement.
serialVersionUID -
Static variable in class com.ibm.pdq.runtime.datasource.datadirect.EnhancedDataSourceForOracle
serialVersionUID -
Static variable in class com.ibm.pdq.runtime.datasource.oracle.EnhancedConnectionPoolDataSourceForOracle
serialVersionUID -
Static variable in class com.ibm.pdq.runtime.datasource.oracle.EnhancedDataSourceForOracle
serialVersionUID -
Static variable in class com.ibm.pdq.runtime.datasource.oracle.EnhancedXADataSourceForOracle
setAutoCommit(boolean) -
Method in interface com.ibm.pdq.runtime.Data
Sets whether auto-commit mode is enabled for the associated instance of
Connection
by calling
Connection.setAutoCommit(boolean)
for the Connection
instance.
setColumnNumber(int) -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Sets the value of
columnNumber
as the starting column of the annotated method declaration whose
processing caused the exception.
setHeterogeneousUpdateCounts(int[][]) -
Method in exception com.ibm.pdq.runtime.exception.UpdateManyException
Sets the
int[][] heteroUpdateCounts
to indicate the results from the execution of the SQL.
setLength(int) -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Sets the value of
length
as the length of the annotated method declaration whose processing caused
the exception.
setLineNumber(int) -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Sets the value of
lineNumber
as the starting line number of the annotated method declaration whose
processing caused the exception.
setPdqProperties(String) -
Method in class com.ibm.pdq.runtime.datasource.datadirect.EnhancedDataSourceForOracle
setPdqProperties(String) -
Method in interface com.ibm.pdq.runtime.datasource.EnhancedDataSource
Sets the pureQuery properties for this data source.
setPdqProperties(String) -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedConnectionPoolDataSourceForOracle
setPdqProperties(String) -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedDataSourceForOracle
setPdqProperties(String) -
Method in class com.ibm.pdq.runtime.datasource.oracle.EnhancedXADataSourceForOracle
setStartPosition(int) -
Method in exception com.ibm.pdq.runtime.exception.GenerationException
Sets the value of
startPosition
as the starting position (in characters from the start of the file)
of the annotated method declaration whose processing caused the exception.
setUpdateCounts(int[]) -
Method in exception com.ibm.pdq.runtime.exception.UpdateManyException
Sets the
int[] updateCounts
to indicate the update counts from the execution of the SQL.
Sql - Annotation Type in com.ibm.pdq.annotation
This annotation is used by some tools that work with pureQuery beans.
Describes the type of an SQL statement.
startBatch(HeterogeneousBatchKind) -
Method in interface com.ibm.pdq.runtime.Data
Starts a batch for a heterogeneous update with parameters.
StoredProcedureResult - Interface in com.ibm.pdq.runtime
Provides methods that can be used to retrieve the OUT and INOUT parameters of an SQL stored procedure call and also
can be used to access its series of query results sequentially.
T
Table - Annotation Type in com.ibm.pdq.annotation
For queries against databases, indicates that all of the properties in the class use the defined table name as the
default table name instead of "*", i.e., table name ignored.
TimeFormatter - Class in com.ibm.pdq.runtime.data.formatters
TimeFormatter can be used with @Format annotation.
TimeFormatter(String) -
Constructor for class com.ibm.pdq.runtime.data.formatters.TimeFormatter
TimestampFormatter can be used with @Format annotation.
TimestampFormatter(String) -
Constructor for class com.ibm.pdq.runtime.data.formatters.TimestampFormatter
U
Update - Annotation Type in com.ibm.pdq.annotation
Used in an interface to indicate to the pureQuery Generator that the annotated declared method runs an SQL INSERT,
UPDATE, DELETE, or DDL statement.
update(String, Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
and returns an int
that indicates how many rows in
the data source are updated.
update(String, Class<ROW>, String[], Object...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
, retrieves the new values of a set of columns, and returns an
object of type returnClass
that describes the results.
updateMany(String, Iterable<T>) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
once for each element in parameters
and returns an
int[]
in which each element in the int[]
indicates the update count (that is, the
number of rows that were updated) for the corresponding execution of sql
.
updateMany(String, Iterator<T>) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
once for each element in parameters
and returns an
int[]
in which each element in the int[]
indicates the update count (that is, the
number of rows that were updated) for the corresponding execution of the sql
statement.
updateMany(String, T[]) -
Method in interface com.ibm.pdq.runtime.Data
Runs the given SQL statement
sql
once for each element in parameters
and returns an
int[]
in which each element in the int[]
indicates the update count (that is, the
number of rows that were updated) for the corresponding execution of sql
.
updateMany(String...) -
Method in interface com.ibm.pdq.runtime.Data
Runs the multiple SQL strings given in one round trip to the server (or in a batch, if the JDBC driver supports
round trip processing).
UpdateManyException - Exception in com.ibm.pdq.runtime.exception
This exception indicates that an error occurred while performing a batch update.
V
valueOf(String) -
Static method in enum com.ibm.pdq.runtime.exception.ErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) -
Static method in enum com.ibm.pdq.runtime.HeterogeneousBatchKind
Returns the enum constant of this type with the specified name.
valueOf(String) -
Static method in enum com.ibm.pdq.runtime.statement.SqlStatementType
Returns the enum constant of this type with the specified name.
Returns an array containing the constants of this enum type, in
the order they are declared.
values() -
Static method in enum com.ibm.pdq.runtime.HeterogeneousBatchKind
Returns an array containing the constants of this enum type, in
the order they are declared.
values() -
Static method in enum com.ibm.pdq.runtime.statement.SqlStatementType
Returns an array containing the constants of this enum type, in
the order they are declared.
X
An implementation of
ResultHandler
that can be specified to cause pureQuery to return content of the
results of an SQL query as an XML String
.
XMLResultHandler() -
Constructor for class com.ibm.pdq.runtime.data.handlers.XMLResultHandler