Where (hrorm 0.10.0 API)

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.

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(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

All Methods Static Methods Instance Methods Concrete Methods
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.
`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`	`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.
`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.
`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.
`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 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
- Method Detail
  - where
```
public static Where where()
```
    Factory method equivalent to new Where()
    
    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
  - 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
  - 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
  - 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
  - render
```
public String render()
```
    The SQL that makes up the where clause this object represents.
    
    Returns:
    
    the SQL
  - populate
```
public void populate(PreparedStatement preparedStatement)
              throws SQLException
```
    Specified by:
    
    populate in interface StatementPopulator
    
    Throws:
    
    SQLException

Class Where

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Where

Where

Where

Where

Where

Where

Where

Method Detail

where

where

where

where

where

where

where

isNull

isNotNull

and

and

and

and

and

and

or

or

or

or

or

or

render

populate