org.skife.jdbi.v2

Class ConcreteStatementContext

java.lang.Object

org.skife.jdbi.v2.ConcreteStatementContext

All Implemented Interfaces:

StatementContext

public final class ConcreteStatementContext
extends Object
implements StatementContext

Method Summary

Modifier and Type	Method and Description
void	addCleanable(Cleanable cleanable)
ResultColumnMapper	columnMapperFor(Class type) Obtain a column mapper for the given type in this context.
Object	getAttribute(String key) Obtain the value of an attribute
Map<String,Object>	getAttributes() Obtain all the attributes associated with this context as a map.
Binding	getBinding()
Collection<Cleanable>	getCleanables()
Connection	getConnection() Obtain the JDBC connection being used for this statement
Foreman	getForeman() Obtain the Foreman that can be used to create dynamically determined Argument instances given the registered ArgumentFactory instances.
String[]	getGeneratedKeysColumnNames()
String	getLocatedSql() Obtain the located sql Not available until until statement execution time
String	getRawSql() Obtain the initial sql for the statement used to create the statement
String	getRewrittenSql() Obtain the located and rewritten sql Not available until until statement execution time
Method	getSqlObjectMethod()
Class<?>	getSqlObjectType()
PreparedStatement	getStatement() Obtain the actual prepared statement being used.
boolean	isConcurrentUpdatable() Return if the statement should be concurrent updatable.
boolean	isReturningGeneratedKeys() Is the statement being generated expected to return the generated keys?
Object	setAttribute(String key, Object value) Specify an attribute on the statement context
void	setBinding(Binding b)
void	setConcurrentUpdatable(boolean concurrentUpdatable) Set the context to create a concurrent updatable result set.
void	setGeneratedKeysColumnNames(String[] generatedKeysColumnNames)
void	setReturningGeneratedKeys(boolean b)
void	setSqlObjectMethod(Method sqlObjectMethod)
void	setSqlObjectType(Class<?> sqlObjectType)

Methods inherited from class java.lang.Object

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

Method Detail

addCleanable

public void addCleanable(Cleanable cleanable)

Specified by:

addCleanable in interface StatementContext

columnMapperFor

public ResultColumnMapper columnMapperFor(Class type)

Description copied from interface: StatementContext

Obtain a column mapper for the given type in this context.

Specified by:

columnMapperFor in interface StatementContext

Parameters:

type - the target type to map to

Returns:

a ResultColumnMapper for the given type, or null if no column mapper is registered for the given type.

getAttribute

public Object getAttribute(String key)

Obtain the value of an attribute

Specified by:

getAttribute in interface StatementContext

Parameters:

key - The name of the attribute

Returns:

the value of the attribute

getAttributes

public Map<String,Object> getAttributes()

Obtain all the attributes associated with this context as a map. Changes to the map or to the attributes on the context will be reflected across both

Specified by:

getAttributes in interface StatementContext

Returns:

a map f attributes

getBinding

public Binding getBinding()

Specified by:

getBinding in interface StatementContext

getCleanables

public Collection<Cleanable> getCleanables()

getConnection

public Connection getConnection()

Obtain the JDBC connection being used for this statement

Specified by:

getConnection in interface StatementContext

Returns:

the JDBC connection

getForeman

public Foreman getForeman()

Description copied from interface: StatementContext

Obtain the Foreman that can be used to create dynamically determined Argument instances given the registered ArgumentFactory instances.

Specified by:

getForeman in interface StatementContext

getGeneratedKeysColumnNames

public String[] getGeneratedKeysColumnNames()

Specified by:

getGeneratedKeysColumnNames in interface StatementContext

getLocatedSql

public String getLocatedSql()

Obtain the located sql

Not available until until statement execution time

Specified by:

getLocatedSql in interface StatementContext

Returns:

the sql which will be passed to the statement rewriter

getRawSql

public String getRawSql()

Obtain the initial sql for the statement used to create the statement

Specified by:

getRawSql in interface StatementContext

Returns:

the initial sql

getRewrittenSql

public String getRewrittenSql()

Obtain the located and rewritten sql

Not available until until statement execution time

Specified by:

getRewrittenSql in interface StatementContext

Returns:

the sql as it will be executed against the database

getSqlObjectMethod

public Method getSqlObjectMethod()

Specified by:

getSqlObjectMethod in interface StatementContext

getSqlObjectType

public Class<?> getSqlObjectType()

Specified by:

getSqlObjectType in interface StatementContext

getStatement

public PreparedStatement getStatement()

Obtain the actual prepared statement being used.

Not available until execution time

Specified by:

getStatement in interface StatementContext

Returns:

Obtain the actual prepared statement being used.

isConcurrentUpdatable

public boolean isConcurrentUpdatable()

Description copied from interface: StatementContext

Return if the statement should be concurrent updatable. If this returns true, the concurrency level of the created ResultSet will be ResultSet.CONCUR_UPDATABLE, otherwise the result set is not updatable, and will have concurrency level ResultSet.CONCUR_READ_ONLY.

Specified by:

isConcurrentUpdatable in interface StatementContext

Returns:

if the statement generated should be concurrent updatable.

isReturningGeneratedKeys

public boolean isReturningGeneratedKeys()

Description copied from interface: StatementContext

Is the statement being generated expected to return the generated keys?

Specified by:

isReturningGeneratedKeys in interface StatementContext

setAttribute

public Object setAttribute(String key,
                           Object value)

Specify an attribute on the statement context

Specified by:

setAttribute in interface StatementContext

Parameters:

key - name of the attribute

value - value for the attribute

Returns:

previous value of this attribute

setBinding

public void setBinding(Binding b)

setConcurrentUpdatable

public void setConcurrentUpdatable(boolean concurrentUpdatable)

Set the context to create a concurrent updatable result set. This cannot be combined with isReturningGeneratedKeys(), only one option may be selected. It does not make sense to combine these either, as one applies to queries, and the other applies to updates.

Parameters:

concurrentUpdatable - if the result set should be concurrent updatable.

setGeneratedKeysColumnNames

public void setGeneratedKeysColumnNames(String[] generatedKeysColumnNames)

setReturningGeneratedKeys

public void setReturningGeneratedKeys(boolean b)

setSqlObjectMethod

public void setSqlObjectMethod(Method sqlObjectMethod)

setSqlObjectType

public void setSqlObjectType(Class<?> sqlObjectType)