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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

Ebean

There is a newer version: 2.8.1

package com.avaje.ebeaninternal.api;

import java.util.ArrayList;

import com.avaje.ebeaninternal.server.core.SpiOrmQueryRequest;
import com.avaje.ebeaninternal.server.deploy.BeanDescriptor;
import com.avaje.ebeaninternal.server.lucene.LIndex;

/**
 * Request object used for gathering expression sql and bind values.
 */
public interface SpiExpressionRequest {

    /**
     * Return the associated Lucene Index.
     */
    public LIndex getLuceneIndex();

    /**
     * Parse the logical property name to the deployment name.
     */
    public String parseDeploy(String logicalProp);
    
	/**
	 * Return the bean descriptor for the root type.
	 */
	public BeanDescriptor getBeanDescriptor();
	
	/**
	 * Return the associated QueryRequest.
	 */
	public SpiOrmQueryRequest getQueryRequest();
	
	/**
	 * Append to the expression sql.
	 */
	public SpiExpressionRequest append(String sql);
	
	/**
	 * Add a bind value to this request.
	 */
	public void addBindValue(Object bindValue);
	
	/**
	 * Return the accumulated expression sql for all expressions in this request.
	 */
	public String getSql();
	
	/**
	 * Return the ordered list of bind values for all expressions in this request.
	 */
	public ArrayList