package io.ebeaninternal.api;

import io.ebean.Expression;
import io.ebean.event.BeanQueryRequest;
import io.ebeaninternal.server.deploy.BeanDescriptor;
import io.ebeaninternal.server.expression.DocQueryContext;

import java.io.IOException;


An expression that becomes part of a Where clause or Having clause.
/**
 * An expression that becomes part of a Where clause or Having clause.
 */
public interface SpiExpression extends Expression {

  static final String SQL_TRUE = "1=1";
  static final String SQL_FALSE = "1=0";

  
Simplify nested expressions if possible.
/**
   * Simplify nested expressions if possible.
   */
  void simplify();

  
Write the expression as an elastic search expression.
/**
   * Write the expression as an elastic search expression.
   */
  void writeDocQuery(DocQueryContext context) throws IOException;

  
Return the nested path for this expression.
/**
   * Return the nested path for this expression.
   */
  String nestedPath(BeanDescriptor<?> desc);

  
Process "Many" properties populating ManyWhereJoins.

Predicates on Many properties require an extra independent join clause.

/**
   * Process "Many" properties populating ManyWhereJoins.
   * <p>
   * Predicates on Many properties require an extra independent join clause.
   * </p>
   */
  void containsMany(BeanDescriptor<?> desc, ManyWhereJoins whereManyJoins);

  
Prepare the expression. For example, compile sub-query expressions etc.
/**
   * Prepare the expression. For example, compile sub-query expressions etc.
   */
  void prepareExpression(BeanQueryRequest<?> request);

  
Calculate a hash value used to identify a query for AutoTune tuning.

That is, if the hash changes then the query will be considered different
from an AutoTune perspective and get different tuning.

/**
   * Calculate a hash value used to identify a query for AutoTune tuning.
   * <p>
   * That is, if the hash changes then the query will be considered different
   * from an AutoTune perspective and get different tuning.
   * </p>
   */
  void queryPlanHash(StringBuilder builder);

  
Return the hash value for the values that will be bound.
/**
   * Return the hash value for the values that will be bound.
   */
  int queryBindHash();

  
Return true if the expression is the same with respect to bind values.
/**
   * Return true if the expression is the same with respect to bind values.
   */
  boolean isSameByBind(SpiExpression other);

  
Add some sql to the query.

This will contain ? as a place holder for each associated bind values.


The 'sql' added to the query can contain object property names rather
than db tables and columns. This 'sql' is later parsed converting the
logical property names to their full database column names.

Params:
request – the associated request./**
   * Add some sql to the query.
   * <p>
   * This will contain ? as a place holder for each associated bind values.
   * </p>
   * <p>
   * The 'sql' added to the query can contain object property names rather
   * than db tables and columns. This 'sql' is later parsed converting the
   * logical property names to their full database column names.
   * </p>
   *
   * @param request the associated request.
   */
  void addSql(SpiExpressionRequest request);

  
Add the parameter values to be set against query. For each ? place holder
there should be a corresponding value that is added to the bindList.
Params:
request – the associated request./**
   * Add the parameter values to be set against query. For each ? place holder
   * there should be a corresponding value that is added to the bindList.
   *
   * @param request the associated request.
   */
  void addBindValues(SpiExpressionRequest request);

  
Validate all the properties/paths associated with this expression.
/**
   * Validate all the properties/paths associated with this expression.
   */
  void validate(SpiExpressionValidation validation);

  
Return a copy of the expression for use in the query plan key.
/**
   * Return a copy of the expression for use in the query plan key.
   */
  SpiExpression copyForPlanKey();

  
Return the bind Id value if this is a "equal to" expression for the id property.
/**
   * Return the bind Id value if this is a "equal to" expression for the id property.
   */
  Object getIdEqualTo(String idName);

  
Check for match to a natural key query returning false if it doesn't match.
/**
   * Check for match to a natural key query returning false if it doesn't match.
   */
  boolean naturalKey(NaturalKeyQueryData<?> data);
}