org.hrorm

Class Where

java.lang.Object

org.hrorm.Where

All Implemented Interfaces:

StatementPopulator

public class Where
extends Object
implements StatementPopulator

Representation of a SQL where clause: a possibly nested list of predicates that describes which records in the database to match.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hrorm.StatementPopulator

StatementPopulator.Empty

Constructor Summary

Constructors

Constructor and Description
Where() Creates an object with no filters.
Where(String columnName, Operator operator, BigDecimal value) Create a new instance of a Where object containing one predicate.
Where(String columnName, Operator operator, Boolean value) Create a new instance of a Where object containing one predicate.
Where(String columnName, Operator operator, Instant value) Create a new instance of a Where object containing one predicate.
Where(String columnName, Operator operator, Long value) Create a new instance of a Where object containing one predicate.
Where(String columnName, Operator operator, String value) Create a new instance of a Where object containing one predicate.
Where(String columnName, Operator operator, T value, GenericColumn<T> column) Create a new instance of a Where object containing one predicate.
Where(Where subWhere) Creates a new Where instance that is grouped, that is, when the SQL where clause is generated, whatever is inside the passed where instance will be wrapped inside parentheses.

Method Summary

Modifier and Type	Method and Description
Where	and(String columnName, Operator operator, BigDecimal value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
Where	and(String columnName, Operator operator, Boolean value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
Where	and(String columnName, Operator operator, Instant value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
Where	and(String columnName, Operator operator, Long value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
Where	and(String columnName, Operator operator, String value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
<T> Where	and(String columnName, Operator operator, T value, GenericColumn<T> column) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.
Where	and(Where subWhere) Add a new predicate to the existing object by connecting the existing predicates to the passed argument with a logical and operation.
static Where	inBigDecimal(String columnName, List<BigDecimal> elements) Generates an IN clause applying to the specified column and including the passed list of numbers.
static <T> Where	inColumn(String columnName, GenericColumn<T> column, List<T> elements) Generates an IN clause applying to the specified column and including the passed list of elements.
static Where	inInstant(String columnName, List<Instant> elements) Generates an IN clause applying to the specified column and including the passed list of dates.
static Where	inLong(String columnName, List<Long> elements) Generates an IN clause applying to the specified column and including the passed list of numbers.
static Where	inString(String columnName, List<String> elements) Generates an IN clause applying to the specified column and including the passed list of strings.
static Where	isNotNull(String columnName) Creates a new object with a single predicate testing whether a column is not null.
static Where	isNull(String columnName) Creates a new object with a single predicate testing whether a column is null.
static Where	notInBigDecimal(String columnName, List<BigDecimal> elements) Generates a NOT IN clause applying to the specified column and excluding the passed list of numbers.
static <T> Where	notInColumn(String columnName, GenericColumn<T> column, List<T> elements) Generates a NOT IN clause applying to the specified column and excluding the passed list of elements.
static Where	notInInstant(String columnName, List<Instant> elements) Generates a NOT IN clause applying to the specified column and excluding the passed list of dates.
static Where	notInLong(String columnName, List<Long> elements) Generates a NOT IN clause applying to the specified column and excluding the passed list of numbers.
static Where	notInString(String columnName, List<String> elements) Generates a NOT IN clause applying to the specified column and excluding the passed list of strings.
Where	or(String columnName, Operator operator, BigDecimal value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
Where	or(String columnName, Operator operator, Boolean value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
Where	or(String columnName, Operator operator, Instant value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
Where	or(String columnName, Operator operator, Long value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
Where	or(String columnName, Operator operator, String value) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
<T> Where	or(String columnName, Operator operator, T value, GenericColumn<T> column) Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.
Where	or(Where subWhere) Add a new predicate to the existing object by connecting the existing predicates to the passed argument with a logical or operation.
void	populate(PreparedStatement preparedStatement)
String	render() The SQL that makes up the where clause this object represents.
String	renderNoPrefix()
static Where	where() Factory method equivalent to new Where().
static Where	where(String columnName, Operator operator, BigDecimal value) Factory method equivalent to new Where(columnName, operator, value).
static Where	where(String columnName, Operator operator, Boolean value) Factory method equivalent to new Where(columnName, operator, value).
static Where	where(String columnName, Operator operator, Instant value) Factory method equivalent to new Where(columnName, operator, value).
static Where	where(String columnName, Operator operator, Long value) Factory method equivalent to new Where(columnName, operator, value).
static Where	where(String columnName, Operator operator, String value) Factory method equivalent to new Where(columnName, operator, value).
static <T> Where	where(String columnName, Operator operator, T value, GenericColumn<T> column) Factory method equivalent to new Where(columnName, operator, value, column).
static Where	where(Where subWhere) Factory method equivalent to new Where(subWhere).

Methods inherited from class java.lang.Object

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

Constructor Detail

Where

public Where()

Creates an object with no filters.

Where

public Where(Where subWhere)

Creates a new Where instance that is grouped, that is, when the SQL where clause is generated, whatever is inside the passed where instance will be wrapped inside parentheses.

Parameters:

subWhere - The predicates to be wrapped

Where

public Where(String columnName,
             Operator operator,
             Boolean value)

Create a new instance of a Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Where

public Where(String columnName,
             Operator operator,
             Long value)

Create a new instance of a Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Where

public Where(String columnName,
             Operator operator,
             String value)

Create a new instance of a Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Where

public Where(String columnName,
             Operator operator,
             BigDecimal value)

Create a new instance of a Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Where

public Where(String columnName,
             Operator operator,
             Instant value)

Create a new instance of a Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Where

public Where(String columnName,
             Operator operator,
             T value,
             GenericColumn<T> column)

Create a new instance of a Where object containing one predicate.

Type Parameters:

T - The type supported by the column

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

column - The descriptor of the column type

Method Detail

where

public static Where where()

Factory method equivalent to new Where(). This will create an empty clause that will match anything.

Returns:

the new object

where

public static Where where(Where subWhere)

Factory method equivalent to new Where(subWhere).

Parameters:

subWhere - an existing predicate that will be grouped parenthetically within the new object

Returns:

the new object

where

public static Where where(String columnName,
                          Operator operator,
                          Boolean value)

Factory method equivalent to new Where(columnName, operator, value). Creates a new Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

the new object

where

public static Where where(String columnName,
                          Operator operator,
                          Long value)

Factory method equivalent to new Where(columnName, operator, value). Creates a new Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

the new object

where

public static Where where(String columnName,
                          Operator operator,
                          String value)

Factory method equivalent to new Where(columnName, operator, value). Creates a new Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

the new object

where

public static Where where(String columnName,
                          Operator operator,
                          BigDecimal value)

Factory method equivalent to new Where(columnName, operator, value). Creates a new Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

the new object

where

public static Where where(String columnName,
                          Operator operator,
                          Instant value)

Factory method equivalent to new Where(columnName, operator, value). Creates a new Where object containing one predicate.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

the new object

where

public static <T> Where where(String columnName,
                              Operator operator,
                              T value,
                              GenericColumn<T> column)

Factory method equivalent to new Where(columnName, operator, value, column). Creates a new Where object containing one predicate.

Type Parameters:

T - The type supported by the column

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

column - The descriptor of the column type

Returns:

the new object

isNull

public static Where isNull(String columnName)

Creates a new object with a single predicate testing whether a column is null.

Parameters:

columnName - The column to test for a null value.

Returns:

the new object

isNotNull

public static Where isNotNull(String columnName)

Creates a new object with a single predicate testing whether a column is not null.

Parameters:

columnName - The column to test for a not null value.

Returns:

the new object

inLong

public static Where inLong(String columnName,
                           List<Long> elements)

Generates an IN clause applying to the specified column and including the passed list of numbers.

Parameters:

columnName - The column name the IN clause applies to

elements - The numbers that should be matched

Returns:

the new object

inString

public static Where inString(String columnName,
                             List<String> elements)

Generates an IN clause applying to the specified column and including the passed list of strings.

Parameters:

columnName - The column name the IN clause applies to

elements - The strings that should be matched

Returns:

the new object

inBigDecimal

public static Where inBigDecimal(String columnName,
                                 List<BigDecimal> elements)

Generates an IN clause applying to the specified column and including the passed list of numbers.

Parameters:

columnName - The column name the IN clause applies to

elements - The numbers that should be matched

Returns:

the new object

inInstant

public static Where inInstant(String columnName,
                              List<Instant> elements)

Generates an IN clause applying to the specified column and including the passed list of dates.

Parameters:

columnName - The column name the IN clause applies to

elements - The dates that should be matched

Returns:

the new object

inColumn

public static <T> Where inColumn(String columnName,
                                 GenericColumn<T> column,
                                 List<T> elements)

Generates an IN clause applying to the specified column and including the passed list of elements.

Type Parameters:

T - The type of element

Parameters:

columnName - The column name the IN clause applies to

column - A column supporting the T type

elements - The elements that should be matched

Returns:

the new object

notInLong

public static Where notInLong(String columnName,
                              List<Long> elements)

Generates a NOT IN clause applying to the specified column and excluding the passed list of numbers.

Parameters:

columnName - The column name the NOT IN clause applies to

elements - The numbers that should be excluded

Returns:

the new object

notInString

public static Where notInString(String columnName,
                                List<String> elements)

Generates a NOT IN clause applying to the specified column and excluding the passed list of strings.

Parameters:

columnName - The column name the NOT IN clause applies to

elements - The strings that should be excluded

Returns:

the new object

notInBigDecimal

public static Where notInBigDecimal(String columnName,
                                    List<BigDecimal> elements)

Generates a NOT IN clause applying to the specified column and excluding the passed list of numbers.

Parameters:

columnName - The column name the NOT IN clause applies to

elements - The numbers that should be excluded

Returns:

the new object

notInInstant

public static Where notInInstant(String columnName,
                                 List<Instant> elements)

Generates a NOT IN clause applying to the specified column and excluding the passed list of dates.

Parameters:

columnName - The column name the NOT IN clause applies to

elements - The dates that should be excluded

Returns:

the new object

notInColumn

public static <T> Where notInColumn(String columnName,
                                    GenericColumn<T> column,
                                    List<T> elements)

Generates a NOT IN clause applying to the specified column and excluding the passed list of elements.

Type Parameters:

T - The type of element

Parameters:

columnName - The column name the NOT IN clause applies to

column - A column supporting the T type

elements - The elements that should be excluded

Returns:

the new object

and

public Where and(Where subWhere)

Add a new predicate to the existing object by connecting the existing predicates to the passed argument with a logical and operation. The passed object will be grouped parenthetically.

Parameters:

subWhere - the new predicate to add

Returns:

this object

and

public Where and(String columnName,
                 Operator operator,
                 Long value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

and

public Where and(String columnName,
                 Operator operator,
                 BigDecimal value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

and

public Where and(String columnName,
                 Operator operator,
                 String value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

and

public Where and(String columnName,
                 Operator operator,
                 Instant value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

and

public Where and(String columnName,
                 Operator operator,
                 Boolean value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

and

public <T> Where and(String columnName,
                     Operator operator,
                     T value,
                     GenericColumn<T> column)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical and.

Type Parameters:

T - The type supported by the column

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

column - The descriptor of this column type

Returns:

this object

or

public Where or(Where subWhere)

Add a new predicate to the existing object by connecting the existing predicates to the passed argument with a logical or operation. The passed object will be grouped parenthetically.

Parameters:

subWhere - the new predicate to add

Returns:

this object

or

public Where or(String columnName,
                Operator operator,
                Long value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

or

public Where or(String columnName,
                Operator operator,
                BigDecimal value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

or

public Where or(String columnName,
                Operator operator,
                String value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

or

public Where or(String columnName,
                Operator operator,
                Boolean value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

or

public Where or(String columnName,
                Operator operator,
                Instant value)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

Returns:

this object

or

public <T> Where or(String columnName,
                    Operator operator,
                    T value,
                    GenericColumn<T> column)

Add a new predicate to the existing object by connecting the existing predicates to the new one with a logical or.

Type Parameters:

T - The type supported by the column

Parameters:

columnName - The column name the predicate applies to

operator - The operation used to evaluate the predicate

value - The value to compare the column values against

column - The descriptor of this column type

Returns:

this object

render

public String render()

The SQL that makes up the where clause this object represents.

Specified by:

render in interface StatementPopulator

Returns:

the SQL

renderNoPrefix

public String renderNoPrefix()

populate

public void populate(PreparedStatement preparedStatement)
              throws SQLException

Specified by:

populate in interface StatementPopulator

Throws:

SQLException