com.j256.ormlite.stmt
Interface PreparedStmt<T>

All Superinterfaces:
GenericRowMapper<T>
All Known Subinterfaces:
PreparedDelete<T>, PreparedQuery<T>, PreparedUpdate<T>
All Known Implementing Classes:
MappedPreparedStmt

public interface PreparedStmt<T>
extends GenericRowMapper<T>

Parent interface for the PreparedQuery, PreparedUpdate, and PreparedDelete interfaces.


Method Summary
 CompiledStatement compile(DatabaseConnection databaseConnection, StatementBuilder.StatementType type)
          Create and return the associated compiled statement.
 CompiledStatement compile(DatabaseConnection databaseConnection, StatementBuilder.StatementType type, int resultFlags)
          Like compile(DatabaseConnection, StatementType) but allows to specify the result flags.
 String getStatement()
          Return the associated SQL statement string for logging purposes.
 StatementBuilder.StatementType getType()
          Return the type of the statement for internal consistency checking.
 void setArgumentHolderValue(int index, Object value)
          If any argument holder's have been set in this prepared statement then this is a convenience method to be able to set them.
 
Methods inherited from interface com.j256.ormlite.stmt.GenericRowMapper
mapRow
 

Method Detail

compile

CompiledStatement compile(DatabaseConnection databaseConnection,
                          StatementBuilder.StatementType type)
                          throws SQLException
Create and return the associated compiled statement. You must call CompiledStatement.close() after you are done with the statement so any database connections can be freed.

Throws:
SQLException

compile

CompiledStatement compile(DatabaseConnection databaseConnection,
                          StatementBuilder.StatementType type,
                          int resultFlags)
                          throws SQLException
Like compile(DatabaseConnection, StatementType) but allows to specify the result flags.

Parameters:
resultFlags - Set to -1 for default.
Throws:
SQLException

getStatement

String getStatement()
                    throws SQLException
Return the associated SQL statement string for logging purposes.

Throws:
SQLException

getType

StatementBuilder.StatementType getType()
Return the type of the statement for internal consistency checking.


setArgumentHolderValue

void setArgumentHolderValue(int index,
                            Object value)
                            throws SQLException
If any argument holder's have been set in this prepared statement then this is a convenience method to be able to set them.

NOTE This method is for folks who know what they are doing. Unfortunately the index of the argument holder is dependent on how the query was built which for complex queries may be difficult to determine. Also, certain field types (such as a Date) allocate an argument internally so you will need to take this into account.

Parameters:
index - The index of the holder you are going to set, 0 based. See NOTE above.
value - Object to set in the argument holder.
Throws:
SQLException


This documentation is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.