org.hrorm

Class WherePredicate<T>

java.lang.Object

org.hrorm.WherePredicate<T>

Type Parameters:

T - the type held by the column being compared

public class WherePredicate<T>
extends Object

Represents a particular predicate for filtering results. For example whether the values in a particular numeric column are less than some value.

Most users of hrorm will have no need to directly use this.

Constructor Summary

Constructors

Constructor and Description
WherePredicate(String columnName, boolean nullityCheck)
WherePredicate(String columnName, Operator operator, T value, org.hrorm.PreparedStatementSetter<T> setter)
WherePredicate(String columnName, org.hrorm.PreparedStatementSetter<T> setter, List<T> elements, boolean in)

Method Summary

Modifier and Type	Method and Description
static WherePredicate<BigDecimal>	forBigDecimal(String columnName, Operator operator, BigDecimal value)
static WherePredicate<Boolean>	forBoolean(String columnName, Operator operator, Boolean value)
static <V> WherePredicate<V>	forGeneric(String name, Operator operator, V value, GenericColumn<V> column)
static WherePredicate<Instant>	forInstant(String columnName, Operator operator, Instant value)
static WherePredicate<Long>	forLong(String columnName, Operator operator, Long value)
static WherePredicate<String>	forString(String columnName, Operator operator, String value)
String	render(String prefix) Creates a string representing a SQL snippet that can be used to build a prepared statement.
int	setValue(int index, PreparedStatement statement) Applies the value held by this object to the passed statement.

Methods inherited from class java.lang.Object

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

Constructor Detail

WherePredicate

public WherePredicate(String columnName,
                      boolean nullityCheck)

WherePredicate

public WherePredicate(String columnName,
                      Operator operator,
                      T value,
                      org.hrorm.PreparedStatementSetter<T> setter)

WherePredicate

public WherePredicate(String columnName,
                      org.hrorm.PreparedStatementSetter<T> setter,
                      List<T> elements,
                      boolean in)

Method Detail

forBoolean

public static WherePredicate<Boolean> forBoolean(String columnName,
                                                 Operator operator,
                                                 Boolean value)

forLong

public static WherePredicate<Long> forLong(String columnName,
                                           Operator operator,
                                           Long value)

forString

public static WherePredicate<String> forString(String columnName,
                                               Operator operator,
                                               String value)

forBigDecimal

public static WherePredicate<BigDecimal> forBigDecimal(String columnName,
                                                       Operator operator,
                                                       BigDecimal value)

forInstant

public static WherePredicate<Instant> forInstant(String columnName,
                                                 Operator operator,
                                                 Instant value)

forGeneric

public static <V> WherePredicate<V> forGeneric(String name,
                                               Operator operator,
                                               V value,
                                               GenericColumn<V> column)

render

public String render(String prefix)

Creates a string representing a SQL snippet that can be used to build a prepared statement.

Parameters:

prefix - The prefix to give to the column name to specify its table.

Returns:

the SQL snippet.

setValue

public int setValue(int index,
                    PreparedStatement statement)
             throws SQLException

Applies the value held by this object to the passed statement.

Parameters:

index - the index of the variable to be set

statement - the statement being populated

Returns:

the number of values set onto the PreparedStatement, which is how far the index must be advanced

Throws:

SQLException - on an error