org.spincast.plugins.jdbc.statements

Class StatementBase

java.lang.Object

org.spincast.plugins.jdbc.statements.StatementBase

All Implemented Interfaces:

Statement

Direct Known Subclasses:

BatchInsertStatementDefault, DeleteStatementDefault, InsertStatementDefault, SelectStatementDefault, UpdateStatementDefault

public abstract class StatementBase
extends Object
implements Statement

If the connection's Connection.getAutoCommit() is true/code>, the connection will be automatically closed. If you want to prevent this, you can use the disableCloseConnection parameter... You can then reuse the connection, but it's up to you to close it when you're done.

Some code based on :

Author:

adam_crume http://www.javaworld.com/article/2077706/core-java/named-parameters-for-preparedstatement.html

Constructor Summary

Constructors

Constructor and Description
StatementBase(Connection connection)

Method Summary

Modifier and Type	Method and Description
protected void	addCurrentParamsToStatement(PreparedStatement statement)
void	addParam(String paramName, Object value)
protected void	addParamsToStatement(PreparedStatement statement, Map<String,Object> params)
protected void	clearParams()
void	clearSql() Clears the current SQL query being built.
void	clearSql(boolean keepCurrentBoundParams) Clears the current SQL query being built.
protected void	close(PreparedStatement statement) Closes statement quietly
protected void	close(ResultSet resultSet) Closes resultSet quietly
protected void	copyParamsAndStaticTokensTo(Statement newStm)
protected Connection	getConnection()
protected Map<String,Set<Integer>>	getIndexMap()
protected String	getOriginalQuery()
protected Map<String,Object>	getParams()
protected String	getParsedQuery()
protected StringBuilder	getQueryBuilder()
String	getSql(boolean friendly) Returns the current SQL query.
protected BasicFormatterImpl	getSqlFormmatter()
protected Map<String,String>	getStaticTokens()
protected String	parse()
void	setBoolean(String paramName, Boolean value)
void	setDate(String paramName, LocalDate value)
void	setDouble(String paramName, Double value)
void	setFloat(String paramName, Float value)
void	setInInteger(String paramName, Set<Integer> items) Explodes a collection of Integer and replaces the specified param with them, so it can be used inside a
void	setInLong(String paramName, Set<Long> items) Explodes a collection of Long and replaces the specified param with them, so it can be used inside a
void	setInstant(String paramName, Instant value) This replaces setTimestamp()!
void	setInString(String paramName, Set<String> items) Explodes a collection of String and replaces the specified param with them, so it can be used inside a IN(:ids) section.
void	setInStringFromEnumNames(String paramName, Enum<?>... enumItems) Uses a list of enum names so it can be used inside a IN(:ids) section.
void	setInStringFromEnumNames(String paramName, Set<? extends Enum<?>> enumItems) Explodes a collection of enum names and replaces the specified param with them, so it can be used inside a IN(:ids) section.
void	setInteger(String paramName, Integer value)
void	setLong(String paramName, Long value)
void	setLongList(String paramName, List<Long> items) Explodes a list of Long and replaces the specified param with them, so it can be used to replace a "ids list" inside a (PostgreSQL example): INNER JOIN UNNEST('{:idsList}'::int[]) WITH ORDINALITY o(id, ord) ON o.id = myMainTable.id
protected void	setParams(Map<String,Object> params)
protected void	setStaticTokens(Map<String,String> tokens)
void	setString(String paramName, String value)
void	sql(String sql) Appends some SQL to the query to launch.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementBase

public StatementBase(Connection connection)

Method Detail

getQueryBuilder

protected StringBuilder getQueryBuilder()

getSqlFormmatter

protected BasicFormatterImpl getSqlFormmatter()

sql

public void sql(String sql)

Description copied from interface: Statement

Appends some SQL to the query to launch. If you want to restart the query from scratch, you need to call Statement.clearSql() first!

Specified by:

sql in interface Statement

clearSql

public void clearSql()

Description copied from interface: Statement

Clears the current SQL query being built. Also removes any bound parameters.

Specified by:

clearSql in interface Statement

clearSql

public void clearSql(boolean keepCurrentBoundParams)

Description copied from interface: Statement

Clears the current SQL query being built.

Specified by:

clearSql in interface Statement

Parameters:

keepCurrentBoundParams - if true, the currently bound parameters won't be cleared, only the query.

getSql

public String getSql(boolean friendly)

Description copied from interface: Statement

Returns the current SQL query.

Specified by:

getSql in interface Statement

getOriginalQuery

protected String getOriginalQuery()

getParsedQuery

protected String getParsedQuery()

getParams

protected Map<String,Object> getParams()

setParams

protected void setParams(Map<String,Object> params)

getStaticTokens

protected Map<String,String> getStaticTokens()

setStaticTokens

protected void setStaticTokens(Map<String,String> tokens)

copyParamsAndStaticTokensTo

protected void copyParamsAndStaticTokensTo(Statement newStm)

parse

protected String parse()

clearParams

protected void clearParams()

getIndexMap

protected Map<String,Set<Integer>> getIndexMap()

getConnection

protected Connection getConnection()

addCurrentParamsToStatement

protected void addCurrentParamsToStatement(PreparedStatement statement)

addParamsToStatement

protected void addParamsToStatement(PreparedStatement statement,
                                    Map<String,Object> params)

close

protected void close(PreparedStatement statement)

Closes statement quietly

close

protected void close(ResultSet resultSet)

Closes resultSet quietly

addParam

public void addParam(String paramName,
                     Object value)

setInstant

public void setInstant(String paramName,
                       Instant value)

Description copied from interface: Statement

This replaces setTimestamp()!

Specified by:

setInstant in interface Statement

setDate

public void setDate(String paramName,
                    LocalDate value)

Specified by:

setDate in interface Statement

setString

public void setString(String paramName,
                      String value)

Specified by:

setString in interface Statement

setBoolean

public void setBoolean(String paramName,
                       Boolean value)

Specified by:

setBoolean in interface Statement

setInteger

public void setInteger(String paramName,
                       Integer value)

Specified by:

setInteger in interface Statement

setLong

public void setLong(String paramName,
                    Long value)

Specified by:

setLong in interface Statement

setFloat

public void setFloat(String paramName,
                     Float value)

Specified by:

setFloat in interface Statement

setDouble

public void setDouble(String paramName,
                      Double value)

Specified by:

setDouble in interface Statement

setInLong

public void setInLong(String paramName,
                      Set<Long> items)

Description copied from interface: Statement

Explodes a collection of Long and replaces the specified param with them, so it can be used inside a

Specified by:

setInLong in interface Statement

setInInteger

public void setInInteger(String paramName,
                         Set<Integer> items)

Description copied from interface: Statement

Explodes a collection of Integer and replaces the specified param with them, so it can be used inside a

Specified by:

setInInteger in interface Statement

setInString

public void setInString(String paramName,
                        Set<String> items)

Description copied from interface: Statement

Explodes a collection of String and replaces the specified param with them, so it can be used inside a IN(:ids) section.

Specified by:

setInString in interface Statement

setInStringFromEnumNames

public void setInStringFromEnumNames(String paramName,
                                     Set<? extends Enum<?>> enumItems)

Description copied from interface: Statement

Explodes a collection of enum names and replaces the specified param with them, so it can be used inside a IN(:ids) section.

Specified by:

setInStringFromEnumNames in interface Statement

setInStringFromEnumNames

public void setInStringFromEnumNames(String paramName,
                                     Enum<?>... enumItems)

Description copied from interface: Statement

Uses a list of enum names so it can be used inside a IN(:ids) section.

Specified by:

setInStringFromEnumNames in interface Statement

setLongList

public void setLongList(String paramName,
                        List<Long> items)

Description copied from interface: Statement

Explodes a list of Long and replaces the specified param with them, so it can be used to replace a "ids list" inside a (PostgreSQL example): INNER JOIN UNNEST('{:idsList}'::int[]) WITH ORDINALITY o(id, ord) ON o.id = myMainTable.id

This allows to retrieve a list of rows, using ids, *in the order the ids are specified*.

Specified by:

setLongList in interface Statement

toString

public String toString()

Overrides:

toString in class Object