package io.ebean.typequery;


JSON document type.

Type that is JSON content mapped to database types such as Postgres JSON/JSONB and otherwise Varchar,Clob and Blob.


The expressions on this type are valid of Postgres and Oracle.


The path can reference a nested property in the JSON document using dot notation -
for example "documentMeta.score" where "score" is an embedded attribute of "documentMeta"

Type parameters:
<R> – the root query bean type/**
 * JSON document type.
 * <p>
 * Type that is JSON content mapped to database types such as Postgres JSON/JSONB and otherwise Varchar,Clob and Blob.
 * </p>
 * <p>
 * The expressions on this type are valid of Postgres and Oracle.
 * </p>
 *
 * <p>
 * The path can reference a nested property in the JSON document using dot notation -
 * for example "documentMeta.score" where "score" is an embedded attribute of "documentMeta"
 * </p>
 *
 * @param <R> the root query bean type
 */
public class PJson<R> extends TQPropertyBase<R> {

  
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 PJson(String name, R root) {
    super(name, root);
  }

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

  
Path exists - for the given path in a JSON document.

  new QSimpleDoc()
   .content.jsonExists("meta.title")
   .findList();

Params:
path – the nested path in the JSON document in dot notation/**
   * Path exists - for the given path in a JSON document.
   *
   * <pre>{@code
   *
   *   new QSimpleDoc()
   *    .content.jsonExists("meta.title")
   *    .findList();
   *
   * }</pre>
   *
   * @param path the nested path in the JSON document in dot notation
   */
  public R jsonExists(String path) {
    expr().jsonExists(_name, path);
    return _root;
  }

  
Path does not exist - for the given path in a JSON document.

  new QSimpleDoc()
   .content.jsonNotExists("meta.title")
   .findList();

Params:
path – the nested path in the JSON document in dot notation/**
   * Path does not exist - for the given path in a JSON document.
   *
   * <pre>{@code
   *
   *   new QSimpleDoc()
   *    .content.jsonNotExists("meta.title")
   *    .findList();
   *
   * }</pre>
   *
   * @param path the nested path in the JSON document in dot notation
   */
  public R jsonNotExists(String path) {
    expr().jsonNotExists(_name, path);
    return _root;
  }

  
Value at the given JSON path is equal to the given value.

  new QSimpleDoc()
   .content.jsonEqualTo("title", "Rob JSON in the DB")
   .findList();


  new QSimpleDoc()
   .content.jsonEqualTo("path.other", 34)
   .findList();

Params:
path – the dot notation path in the JSON document
value – the equal to bind value/**
   * Value at the given JSON path is equal to the given value.
   *
   *
   * <pre>{@code
   *
   *   new QSimpleDoc()
   *    .content.jsonEqualTo("title", "Rob JSON in the DB")
   *    .findList();
   *
   * }</pre>
   *
   * <pre>{@code
   *
   *   new QSimpleDoc()
   *    .content.jsonEqualTo("path.other", 34)
   *    .findList();
   *
   * }</pre>
   *
   * @param path the dot notation path in the JSON document
   * @param value the equal to bind value
   */
  public R jsonEqualTo(String path, Object value) {
    expr().jsonEqualTo(_name, path, value);
    return _root;
  }

  
Not Equal to - for the given path in a JSON document.
Params:
path – the nested path in the JSON document in dot notation
value – the value used to test equality against the document path's value/**
   * Not Equal to - for the given path in a JSON document.
   *
   * @param path the nested path in the JSON document in dot notation
   * @param value the value used to test equality against the document path's value
   */
  public R jsonNotEqualTo(String path, Object value) {
    expr().jsonNotEqualTo(_name, path, value);
    return _root;
  }

  
Greater than - for the given path in a JSON document.
Params:
path – the nested path in the JSON document in dot notation
value – the value used to test against the document path's value/**
   * Greater than - for the given path in a JSON document.
   *
   * @param path the nested path in the JSON document in dot notation
   * @param value the value used to test against the document path's value
   */
  public R jsonGreaterThan(String path, Object value) {
    expr().jsonGreaterThan(_name, path, value);
    return _root;
  }

  
Greater than or equal to - for the given path in a JSON document.
Params:
path – the nested path in the JSON document in dot notation
value – the value used to test against the document path's value/**
   * Greater than or equal to - for the given path in a JSON document.
   *
   * @param path the nested path in the JSON document in dot notation
   * @param value the value used to test against the document path's value
   */
  public R jsonGreaterOrEqual(String path, Object value) {
    expr().jsonGreaterOrEqual(_name, path, value);
    return _root;
  }

  
Less than - for the given path in a JSON document.
Params:
path – the nested path in the JSON document in dot notation
value – the value used to test against the document path's value/**
   * Less than - for the given path in a JSON document.
   *
   * @param path the nested path in the JSON document in dot notation
   * @param value the value used to test against the document path's value
   */
  public R jsonLessThan(String path, Object value) {
    expr().jsonLessThan(_name, path, value);
    return _root;
  }

  
Less than or equal to - for the given path in a JSON document.
Params:
path – the nested path in the JSON document in dot notation
value – the value used to test against the document path's value/**
   * Less than or equal to - for the given path in a JSON document.
   *
   * @param path the nested path in the JSON document in dot notation
   * @param value the value used to test against the document path's value
   */
  public R jsonLessOrEqualTo(String path, Object value) {
    expr().jsonLessOrEqualTo(_name, path, value);
    return _root;
  }
}