package io.ebean.typequery;


Base property for all comparable types.
Type parameters:
<R> – the root query bean type
<T> – the type of the scalar property/**
 * Base property for all comparable types.
 *
 * @param <R> the root query bean type
 * @param <T> the type of the scalar property
 */
@SuppressWarnings("rawtypes")
public class PBaseCompareable<R, T> extends PBaseValueEqual<R, T> {

  
Construct with a property name and root instance.
Params:
name – property name
root – the root query bean instance/**
   * Construct with a property name and root instance.
   *
   * @param name property name
   * @param root the root query bean instance
   */
  public PBaseCompareable(String name, R root) {
    super(name, root);
  }

  
Construct with additional path prefix.
/**
   * Construct with additional path prefix.
   */
  public PBaseCompareable(String name, R root, String prefix) {
    super(name, root, prefix);
  }

  // ---- range comparisons -------

  
Greater than.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R gt(T value) {
    expr().gt(_name, value);
    return _root;
  }

  
Greater than OR Null.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than OR Null.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R gtOrNull(T value) {
    expr().gtOrNull(_name, value);
    return _root;
  }

  
Greater than or Equal to.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than or Equal to.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R ge(T value) {
    expr().ge(_name, value);
    return _root;
  }

  
Greater than or Equal to OR Null.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than or Equal to OR Null.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R geOrNull(T value) {
    expr().geOrNull(_name, value);
    return _root;
  }

  
Less than.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R lt(T value) {
    expr().lt(_name, value);
    return _root;
  }

  
Less than OR Null.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than OR Null.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R ltOrNull(T value) {
    expr().ltOrNull(_name, value);
    return _root;
  }

  
Less than or Equal to.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than or Equal to.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R le(T value) {
    expr().le(_name, value);
    return _root;
  }

  
Less than or Equal to.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than or Equal to.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R leOrNull(T value) {
    expr().leOrNull(_name, value);
    return _root;
  }

  
Greater or equal to lower value and strictly less than upper value.

This is generally preferable over Between for date and datetime types
as SQL Between is inclusive on the upper bound (<=) and generally we
need the upper bound to be exclusive (<).

Params:
lower – the lower bind value (>=)
upper – the upper bind value (<)
Returns:
the root query bean instance/**
   * Greater or equal to lower value and strictly less than upper value.
   * <p>
   * This is generally preferable over Between for date and datetime types
   * as SQL Between is inclusive on the upper bound (<=) and generally we
   * need the upper bound to be exclusive (<).
   * </p>
   *
   * @param lower the lower bind value (>=)
   * @param upper the upper bind value (<)
   * @return the root query bean instance
   */
  public final R inRange(T lower, T upper) {
    expr().inRange(_name, lower, upper);
    return _root;
  }

  
Value in Range between 2 properties.

   .startDate.inRangeWith(endDate, now)
   // which equates to
   startDate <= now and (endDate > now or endDate is null)


This is a convenience expression combining a number of simple expressions.
The most common use of this could be called "effective dating" where 2 date or
timestamp columns represent the date range in which
/**
   * Value in Range between 2 properties.
   *
   * <pre>{@code
   *
   *    .startDate.inRangeWith(endDate, now)
   *
   *    // which equates to
   *    startDate <= now and (endDate > now or endDate is null)
   *
   * }</pre>
   *
   * <p>
   * This is a convenience expression combining a number of simple expressions.
   * The most common use of this could be called "effective dating" where 2 date or
   * timestamp columns represent the date range in which
   */
  public final R inRangeWith(TQProperty<R> highProperty, T value) {
    expr().inRangeWith(_name, highProperty._name, value);
    return _root;
  }

  
Between lower and upper values.
Params:
lower – the lower bind value
upper – the upper bind value
Returns:
the root query bean instance/**
   * Between lower and upper values.
   *
   * @param lower the lower bind value
   * @param upper the upper bind value
   * @return the root query bean instance
   */
  public final R between(T lower, T upper) {
    expr().between(_name, lower, upper);
    return _root;
  }

  
Greater than.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R greaterThan(T value) {
    expr().gt(_name, value);
    return _root;
  }

  
Greater than or Null.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than or Null.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R greaterThanOrNull(T value) {
    expr().gtOrNull(_name, value);
    return _root;
  }

  
Greater than or Equal to.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Greater than or Equal to.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R greaterOrEqualTo(T value) {
    expr().ge(_name, value);
    return _root;
  }

  
Less than.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R lessThan(T value) {
    expr().lt(_name, value);
    return _root;
  }

  
Less than or Null.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than or Null.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R lessThanOrNull(T value) {
    expr().ltOrNull(_name, value);
    return _root;
  }

  
Less than or Equal to.
Params:
value – the bind value
Returns:
the root query bean instance/**
   * Less than or Equal to.
   *
   * @param value the bind value
   * @return the root query bean instance
   */
  public final R lessOrEqualTo(T value) {
    expr().le(_name, value);
    return _root;
  }

}