me.saharnooby.lib.query.query

Class AbstractQuery

java.lang.Object

me.saharnooby.lib.query.query.AbstractQuery

Direct Known Subclasses:

ConditionalQuery, CreateTable, Insert, Raw

public abstract class AbstractQuery
extends Object

Represents an SQL query with some parameters to be filled in placeholders.

Since:

13:08 14.11.2019

Author:

saharNooby

Constructor Summary

Constructors

Constructor and Description
AbstractQuery()

Method Summary

Modifier and Type	Method and Description
abstract List<Object>	getParams()
abstract String	getSQL()
PreparedStatement	prepareStatement(@NonNull Connection con) Creates a prepared statement and sets parameter values.
PreparedStatement	prepareStatement(@NonNull Connection con, int autoGeneratedKeys) Creates a prepared statement and sets parameter values.
ResultSetWrapper	query(@NonNull Connection con) Creates a prepared statement and executes a query.
<T> Optional<T>	queryAndMap(@NonNull DataSource source, @NonNull ResultSetMapper<T> mapper) Obtains a connection from the source, performs a query, calls ResultSetWrapper.map(ResultSetMapper) with the specified mapper and returns the result.
<T> List<T>	queryAndMapAll(@NonNull DataSource source, @NonNull ResultSetMapper<T> mapper) Obtains a connection from the source, performs a query, calls ResultSetWrapper.mapAll(ResultSetMapper) with the specified mapper and returns the result.
int	update(@NonNull Connection con) Creates a prepared statement and executes an update.
int	update(@NonNull DataSource source) Creates a prepared statement and executes an update.
ResultSetWrapper	updateWithKeys(@NonNull Connection con) Executes an update, returning generated keys.
<T> Optional<T>	updateWithKeysAndMap(@NonNull DataSource source, @NonNull ResultSetMapper<T> mapper) Obtains a connection from the source, executes an update, returns generated keys mapped using specified mapper.
<T> List<T>	updateWithKeysAndMapAll(@NonNull DataSource source, @NonNull ResultSetMapper<T> mapper) Obtains a connection from the source, executes an update, returns generated keys mapped using specified mapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQuery

public AbstractQuery()

Method Detail

getSQL

public abstract String getSQL()

Returns:

The SQL query.

getParams

public abstract List<Object> getParams()

Returns:

Values of the query parameters, in order of occurence (denoted by ? in the SQL query).

prepareStatement

public PreparedStatement prepareStatement(@NonNull
                                          @NonNull Connection con)
                                   throws SQLException

Creates a prepared statement and sets parameter values.

Parameters:

con - Connection to the database.

Returns:

Prepared statement. Must be closed by the caller.

Throws:

SQLException - On SQL error.

prepareStatement

public PreparedStatement prepareStatement(@NonNull
                                          @NonNull Connection con,
                                          int autoGeneratedKeys)
                                   throws SQLException

Creates a prepared statement and sets parameter values.

Parameters:

con - Connection to the database.

autoGeneratedKeys - A value to be passed to autoGeneratedKeys parameter of prepareStatement.

Returns:

Prepared statement. Must be closed by the caller.

Throws:

SQLException - On SQL error.

update

public int update(@NonNull
                  @NonNull Connection con)
           throws SQLException

Creates a prepared statement and executes an update.

Parameters:

con - Connection to the database.

Returns:

Result of executeUpdate.

Throws:

SQLException - On SQL error.

update

public int update(@NonNull
                  @NonNull DataSource source)
           throws SQLException

Creates a prepared statement and executes an update. A connection will be retrieved from the source and closed after the update.

Parameters:

source - Source of connections.

Returns:

Result of executeUpdate.

Throws:

SQLException - On SQL error.

updateWithKeys

public ResultSetWrapper updateWithKeys(@NonNull
                                       @NonNull Connection con)
                                throws SQLException

Executes an update, returning generated keys.

Parameters:

con - Connection to the database.

Returns:

Generated keys result set.

Throws:

SQLException - On SQL error.

updateWithKeysAndMap

public <T> Optional<T> updateWithKeysAndMap(@NonNull
                                            @NonNull DataSource source,
                                            @NonNull
                                            @NonNull ResultSetMapper<T> mapper)
                                     throws SQLException

Obtains a connection from the source, executes an update, returns generated keys mapped using specified mapper.

Type Parameters:

T - Type of the result.

Parameters:

source - Source of connections.

mapper - Mapper.

Returns:

Generated keys result set.

Throws:

SQLException - On SQL error.

updateWithKeysAndMapAll

public <T> List<T> updateWithKeysAndMapAll(@NonNull
                                           @NonNull DataSource source,
                                           @NonNull
                                           @NonNull ResultSetMapper<T> mapper)
                                    throws SQLException

Obtains a connection from the source, executes an update, returns generated keys mapped using specified mapper.

Type Parameters:

T - Type of list elements.

Parameters:

source - Source of connections.

mapper - Mapper.

Returns:

Generated keys result set.

Throws:

SQLException - On SQL error.

query

public ResultSetWrapper query(@NonNull
                              @NonNull Connection con)
                       throws SQLException

Creates a prepared statement and executes a query.

Parameters:

con - Connection to database.

Returns:

Wrapped result set. Must be closed by the caller.

Throws:

SQLException - On SQL error.

queryAndMap

public <T> Optional<T> queryAndMap(@NonNull
                                   @NonNull DataSource source,
                                   @NonNull
                                   @NonNull ResultSetMapper<T> mapper)
                            throws SQLException

Obtains a connection from the source, performs a query, calls ResultSetWrapper.map(ResultSetMapper) with the specified mapper and returns the result.

Type Parameters:

T - Result type.

Parameters:

source - Source of connections.

mapper - Mapper.

Returns:

Result.

Throws:

SQLException - On SQL error.

queryAndMapAll

public <T> List<T> queryAndMapAll(@NonNull
                                  @NonNull DataSource source,
                                  @NonNull
                                  @NonNull ResultSetMapper<T> mapper)
                           throws SQLException

Obtains a connection from the source, performs a query, calls ResultSetWrapper.mapAll(ResultSetMapper) with the specified mapper and returns the result.

Type Parameters:

T - Result type.

Parameters:

source - Source of connections.

mapper - Mapper.

Returns:

Result.

Throws:

SQLException - On SQL error.