com.avaje.ebeaninternal.api.SpiExpression Maven / Gradle / Ivy

Go to download
package com.avaje.ebeaninternal.api;

import com.avaje.ebean.Expression;
import com.avaje.ebean.event.BeanQueryRequest;
import com.avaje.ebeaninternal.server.deploy.BeanDescriptor;


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

  /**
   * Process "Many" properties populating ManyWhereJoins.
   * 
   * Predicates on Many properties require an extra independent join clause.
   * 
   */
	void containsMany(BeanDescriptor desc, ManyWhereJoins whereManyJoins);
	
	/**
	 * 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.
	 * 
	 */
	void queryAutoTuneHash(HashQueryPlanBuilder builder);
	
	/**
	 * Calculate a hash value for the expression.
	 * This includes the expression type and property but should exclude
	 * the bind values.
	 * 
	 * This is used where queries are the same except for the bind values, in which
	 * case the query execution plan can be reused.
	 * 
	 */
	void queryPlanHash(BeanQueryRequest request, HashQueryPlanBuilder builder);
	
	/**
	 * Return the hash value for the values that will be bound.
	 */
	int queryBindHash();
	
	/**
	 * 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.
	 * 
	 * @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.
	 * 
	 * @param request
	 *            the associated request.
	 */
	void addBindValues(SpiExpressionRequest request);

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