panda.dao.query.Query Maven / Gradle / Ivy

Go to download
package panda.dao.query;

import java.util.List;
import java.util.Map;

import panda.dao.entity.Entity;
import panda.dao.query.Filter.ComboFilter;
import panda.lang.Order;

/**
 * 
 *
 * @param  query target type
 */
public interface Query {
	/**
	 * @return the target
	 */
	public Object getTarget();

	/**
	 * @return the entity
	 */
	public Entity getEntity();

	/**
	 * @return the type
	 */
	public Class getType();

	/**
	 * @return the table
	 */
	public String getTable();

	//---------------------------------------------------------------
	// distinct
	//
	public boolean isDistinct();
	
	//---------------------------------------------------------------
	// columns
	//
	/**
	 * @return true if has columns
	 */
	public boolean hasColumns();

	/**
	 * @return columns
	 */
	public Map getColumns();

	/**
	 * @param name column name
	 * @return column value
	 */
	public String getColumn(String name);

	/**
	 * @param name field name
	 * @return true if the name should include
	 */
	public boolean shouldInclude(String name);

	/**
	 * @param name field name
	 * @return true if the name should exclude
	 */
	public boolean shouldExclude(String name);

	//---------------------------------------------------------------
	// join
	//
	/**
	 * @return true if has joins
	 */
	public boolean hasJoins();

	/**
	 * @return joins
	 */
	public Map getJoins();

	/**
	 * @param join the join name
	 * @return join
	 */
	public Join getJoin(String join);

	//---------------------------------------------------------------
	// orders
	//
	/**
	 * @param name property/field/column name
	 * @return true if the property has some order
	 */
	public boolean hasOrder(String name);
	
	/**
	 * @return true if has orders
	 */
	public boolean hasOrders();

	/**
	 * @return orders
	 */
	public Map getOrders();

	//---------------------------------------------------------------
	// groups
	//
	/**
	 * @return true if has groups
	 */
	public boolean hasGroups();

	/**
	 * @return groups
	 */
	public List getGroups();

	//---------------------------------------------------------------
	// start & limit
	//
	/**
	 * @return the start
	 */
	public long getStart();

	/**
	 * @return the limit
	 */
	public long getLimit();

	/**
	 * is this query needs paginate
	 * @return true if start or limit > 0
	 */
	public boolean needsPaginate();

	//---------------------------------------------------------------
	// conditions
	//
	/**
	 * @return filters
	 */
	public ComboFilter getFilters();

	/**
	 * @return true if has filters
	 */
	public boolean hasFilters();
	
	/**
	 * @param name property/field/column name
	 * @return true if the property has some filter
	 */
	public boolean hasFilter(String name);
}