com.netflix.conductor.dao.mysql

Class Query

java.lang.Object

com.netflix.conductor.dao.mysql.Query

All Implemented Interfaces:

java.lang.AutoCloseable

public class Query
extends java.lang.Object
implements java.lang.AutoCloseable

Represents a PreparedStatement that is wrapped with convenience methods and utilities.

This class simulates a parameter building pattern and all addParameter(*) methods must be called in the proper order of their expected binding sequence.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.ObjectMapper	om The ObjectMapper instance to use for serializing/deserializing JSON.

Constructor Summary

Constructors

Constructor and Description
Query(com.fasterxml.jackson.databind.ObjectMapper objectMapper, java.sql.Connection connection, java.lang.String query)

Method Summary

Modifier and Type	Method and Description
Query	addDateParameter(java.util.Date date) Bind the given Date to the PreparedStatement as a Date.
Query	addJsonParameter(java.lang.Object value) Serializes value to a JSON string for persistence.
Query	addParameter(boolean value)
Query	addParameter(java.sql.Date date)
Query	addParameter(double value)
Query	addParameter(int value)
Query	addParameter(long value)
Query	addParameter(java.lang.String value)
Query	addParameter(java.sql.Timestamp timestamp)
protected Query	addParameterInternal(com.netflix.conductor.dao.mysql.Query.InternalParameterSetter setter)
Query	addParameters(java.util.Collection values) Add a collection of primitive values at once, in the order of the collection.
Query	addParameters(java.lang.Object... values) Add many primitive values at once.
Query	addTimestampParameter(java.util.Date date) Bind the given Date to the PreparedStatement as a Timestamp.
Query	addTimestampParameter(long epochMillis) Bind the given epoch millis to the PreparedStatement as a Timestamp.
void	close()
protected <V> V	convert(java.lang.Object value, java.lang.Class<V> returnType)
protected java.lang.Boolean	convertBoolean(java.lang.Object value)
protected java.lang.Double	convertDouble(java.lang.Object value)
protected java.lang.Integer	convertInt(java.lang.Object value)
protected java.lang.Long	convertLong(java.lang.Object value)
protected java.lang.String	convertString(java.lang.Object value)
<V> java.util.List<V>	executeAndFetch(java.lang.Class<V> returnType) Execute the PreparedStatement and return a List of returnType values from the ResultSet.
<V> V	executeAndFetch(ResultSetHandler<V> handler) Execute the query and pass the ResultSet to the given handler.
<V> V	executeAndFetchFirst(java.lang.Class<V> returnType) Execute the statement and return only the first record from the result set.
long	executeCount() Convenience method for executing statements that return a single numeric value, typically SELECT COUNT... style queries.
boolean	executeDelete() Convenience method for executing delete statements.
java.sql.ResultSet	executeQuery() Execute a query from the PreparedStatement and return the ResultSet.
java.lang.Object	executeScalar()
<V> V	executeScalar(java.lang.Class<V> returnType) Execute the PreparedStatement and return a single 'primitive' value from the ResultSet.
<V> java.util.List<V>	executeScalarList(java.lang.Class<V> returnType) Execute the PreparedStatement and return a List of 'primitive' values from the ResultSet.
int	executeUpdate()
boolean	exists() Utility method for evaluating the prepared statement as a query to check the existence of a record using a numeric count or boolean return value.
protected <V> V	fromJson(java.lang.String value, java.lang.Class<V> returnType)
static java.lang.String	generateInBindings(int count) Generate a String with count number of '?' placeholders for PreparedStatement queries.
protected int	getAndIncrementIndex()
protected int	getIndex()
protected <V> V	getScalarFromResultSet(java.sql.ResultSet rs, java.lang.Class<V> returnType)
protected java.lang.String	toJson(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

om

protected final com.fasterxml.jackson.databind.ObjectMapper om

The ObjectMapper instance to use for serializing/deserializing JSON.

Constructor Detail

Query

public Query(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
             java.sql.Connection connection,
             java.lang.String query)

Method Detail

generateInBindings

public static java.lang.String generateInBindings(int count)

Generate a String with count number of '?' placeholders for PreparedStatement queries.

Parameters:

count - The number of '?' chars to generate.

Returns:

a comma delimited string of count '?' binding placeholders.

addParameter

public Query addParameter(java.lang.String value)

addParameter

public Query addParameter(int value)

addParameter

public Query addParameter(boolean value)

addParameter

public Query addParameter(long value)

addParameter

public Query addParameter(double value)

addParameter

public Query addParameter(java.sql.Date date)

addParameter

public Query addParameter(java.sql.Timestamp timestamp)

addJsonParameter

public Query addJsonParameter(java.lang.Object value)

Serializes value to a JSON string for persistence.

Parameters:

value - The value to serialize.

Returns:

this

addDateParameter

public Query addDateParameter(java.util.Date date)

Bind the given Date to the PreparedStatement as a Date.

Parameters:

date - The java.util.Date to bind.

Returns:

this

addTimestampParameter

public Query addTimestampParameter(java.util.Date date)

Bind the given Date to the PreparedStatement as a Timestamp.

Parameters:

date - The java.util.Date to bind.

Returns:

this

addTimestampParameter

public Query addTimestampParameter(long epochMillis)

Bind the given epoch millis to the PreparedStatement as a Timestamp.

Parameters:

epochMillis - The epoch ms to create a new Timestamp from.

Returns:

this

addParameters

public Query addParameters(java.util.Collection values)

Add a collection of primitive values at once, in the order of the collection.

Parameters:

values - The values to bind to the prepared statement.

Returns:

this

Throws:

java.lang.IllegalArgumentException - If a non-primitive/unsupported type is encountered in the collection.

See Also:

addParameters(Object...)

addParameters

public Query addParameters(java.lang.Object... values)

Add many primitive values at once.

Parameters:

values - The values to bind to the prepared statement.

Returns:

this

Throws:

java.lang.IllegalArgumentException - If a non-primitive/unsupported type is encountered.

exists

public boolean exists()

Utility method for evaluating the prepared statement as a query to check the existence of a record using a numeric count or boolean return value.

The rawQuery provided must result in a Number or Boolean result.

Returns:

true If a count query returned more than 0 or an exists query returns true.

Throws:

com.netflix.conductor.core.execution.ApplicationException - If an unexpected return type cannot be evaluated to a Boolean result.

executeDelete

public boolean executeDelete()

Convenience method for executing delete statements.

Returns:

true if the statement affected 1 or more rows.

See Also:

executeUpdate()

executeCount

public long executeCount()

Convenience method for executing statements that return a single numeric value, typically SELECT COUNT... style queries.

Returns:

The result of the query as a long.

executeUpdate

public int executeUpdate()

Returns:

The result of PreparedStatement.executeUpdate()

executeQuery

public java.sql.ResultSet executeQuery()

Execute a query from the PreparedStatement and return the ResultSet.

NOTE: The returned ResultSet must be closed/managed by the calling methods.

Returns:

PreparedStatement.executeQuery()

Throws:

com.netflix.conductor.core.execution.ApplicationException - If any SQL errors occur.

executeScalar

public java.lang.Object executeScalar()

Returns:

The single result of the query as an Object.

executeScalar

public <V> V executeScalar(java.lang.Class<V> returnType)

Execute the PreparedStatement and return a single 'primitive' value from the ResultSet.

Type Parameters:

V - The type parameter to return a List of.

Parameters:

returnType - The type to return.

Returns:

A single result from the execution of the statement, as a type of returnType.

Throws:

com.netflix.conductor.core.execution.ApplicationException - returnType is unsupported, cannot be cast to from the result, or any SQL errors occur.

executeScalarList

public <V> java.util.List<V> executeScalarList(java.lang.Class<V> returnType)

Execute the PreparedStatement and return a List of 'primitive' values from the ResultSet.

Type Parameters:

V - The type parameter to return a List of.

Parameters:

returnType - The type Class return a List of.

Returns:

A List<returnType>.

Throws:

com.netflix.conductor.core.execution.ApplicationException - returnType is unsupported, cannot be cast to from the result, or any SQL errors occur.

executeAndFetchFirst

public <V> V executeAndFetchFirst(java.lang.Class<V> returnType)

Execute the statement and return only the first record from the result set.

Type Parameters:

V - The type parameter.

Parameters:

returnType - The Class to return.

Returns:

An instance of <V> from the result set.

executeAndFetch

public <V> java.util.List<V> executeAndFetch(java.lang.Class<V> returnType)

Execute the PreparedStatement and return a List of returnType values from the ResultSet.

Type Parameters:

V - The type parameter to return a List of.

Parameters:

returnType - The type Class return a List of.

Returns:

A List<returnType>.

Throws:

com.netflix.conductor.core.execution.ApplicationException - returnType is unsupported, cannot be cast to from the result, or any SQL errors occur.

executeAndFetch

public <V> V executeAndFetch(ResultSetHandler<V> handler)

Execute the query and pass the ResultSet to the given handler.

Type Parameters:

V - The return type of this method.

Parameters:

handler - The ResultSetHandler to execute.

Returns:

The results of ResultSetHandler.apply(ResultSet).

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

addParameterInternal

protected final Query addParameterInternal(com.netflix.conductor.dao.mysql.Query.InternalParameterSetter setter)

getScalarFromResultSet

protected <V> V getScalarFromResultSet(java.sql.ResultSet rs,
                                       java.lang.Class<V> returnType)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

convert

protected <V> V convert(java.lang.Object value,
                        java.lang.Class<V> returnType)

convertInt

protected java.lang.Integer convertInt(java.lang.Object value)

convertDouble

protected java.lang.Double convertDouble(java.lang.Object value)

convertLong

protected java.lang.Long convertLong(java.lang.Object value)

convertString

protected java.lang.String convertString(java.lang.Object value)

convertBoolean

protected java.lang.Boolean convertBoolean(java.lang.Object value)

toJson

protected java.lang.String toJson(java.lang.Object value)

fromJson

protected <V> V fromJson(java.lang.String value,
                         java.lang.Class<V> returnType)

getIndex

protected final int getIndex()

getAndIncrementIndex

protected final int getAndIncrementIndex()