io.ebeaninternal.server.expression.JsonPathExpression Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean-core Show documentation
ebean core module
There is a newer version: 15.8.1
package io.ebeaninternal.server.expression;

import io.ebeaninternal.api.BindValuesKey;
import io.ebeaninternal.api.SpiExpression;
import io.ebeaninternal.api.SpiExpressionBind;
import io.ebeaninternal.api.SpiExpressionRequest;

import java.util.Objects;

/**
 * Generally speaking tests the value at a given path in the JSON document.
 * 
 * Supports the usual operators (equal to, greater than etc).
 * 
 * 
 * The value passed in is expected to be a valid JSON type so string, number, boolean.
 * 
 */
final class JsonPathExpression extends AbstractExpression {

  /**
   * The path in the JSON document in dot notation form.
   */
  private final String path;

  /**
   * The expression operator.
   */
  private final Op operator;

  /**
   * The bind value used to compare against the document path value.
   */
  private final Object value;

  /**
   * For Between this is the upper bind value.
   */
  private final Object upperValue;

  /**
   * Construct for Operator (not BETWEEN though).
   */
  JsonPathExpression(String propertyName, String path, Op operator, Object value) {
    super(propertyName);
    this.path = path;
    this.operator = operator;
    this.value = value;
    this.upperValue = null;
  }

  /**
   * Construct for BETWEEN expression.
   */
  JsonPathExpression(String propertyName, String path, Object value, Object upperValue) {
    super(propertyName);
    this.path = path;
    this.operator = Op.BETWEEN;
    this.value = value;
    this.upperValue = upperValue;
  }

  @Override
  public void queryPlanHash(StringBuilder builder) {
    builder.append("JsonPath[");
    builder.append(propName).append(" path:").append(path).append(" op:").append(operator);
    if (value != null) {
      builder.append(" ?1");
    }
    if (upperValue != null) {
      builder.append(" ?2");
    }
    builder.append(']');
  }

  @Override
  public void queryBindKey(BindValuesKey key) {
    key.add(value).add(upperValue);
  }

  @Override
  public boolean isSameByBind(SpiExpression other) {
    JsonPathExpression that = (JsonPathExpression) other;
    if (!Objects.equals(value, that.value)) return false;
    return Objects.equals(upperValue, that.upperValue);
  }

  @Override
  public void addSql(SpiExpressionRequest request) {
    // Use DB specific expression handling (Postgres and Oracle supported)
    request.platformHandler().json(request, propName, path, operator, value);
  }

  @Override
  public void addBindValues(SpiExpressionBind request) {
    if (value != null) {
      // value is null for EXISTS/NOT EXISTS
      request.addBindValue(value);
    }
    if (upperValue != null) {
      // upperValue only for BETWEEN operator
      request.addBindValue(upperValue);
    }
  }
}