All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

Panda Core is the core module of Panda Framework, it contains commonly used utility classes similar to apache-commons.

There is a newer version: 1.8.0
Show newest version
package panda.dao.query;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import panda.dao.entity.Entity;
import panda.dao.entity.EntityField;
import panda.dao.entity.EntityJoin;
import panda.dao.query.Filter.ComboFilter;
import panda.dao.query.Filter.ReferFilter;
import panda.dao.query.Filter.SimpleFilter;
import panda.dao.query.Filter.ValueFilter;
import panda.lang.Arrays;
import panda.lang.Asserts;
import panda.lang.Collections;
import panda.lang.Logical;
import panda.lang.Objects;
import panda.lang.Order;
import panda.lang.Strings;

/**
 * 
 *
 * @param  table
 */
public class DataQuery implements Query, Cloneable {
	protected Object target;
	protected boolean distinct;
	protected long start;
	protected long limit;
	protected Map columns;
	protected Map joins;

	protected ComboFilter filters;
	
	/** filter stack */
	protected List stack;

	protected Map orders;
	protected List groups;
	
	protected static final int HAS_INCLUDES = 0x01;
	protected static final int HAS_EXCLUDES = 0x02;
	protected Integer flags;

	/**
	 * constructor
	 * @param type query type
	 */
	public DataQuery(Class type) {
		this.target = type;
	}

	/**
	 * constructor
	 * @param entity query entity
	 */
	public DataQuery(Entity entity) {
		this.target = entity;
	}

	/**
	 * @param target query target
	 */
	public DataQuery(String target) {
		this.target = target;
	}
	
	/**
	 * @param query query to clone
	 */
	public DataQuery(Query query) {
		target = query.getTarget();
		start = query.getStart();
		limit = query.getLimit();
		distinct = query.isDistinct();

		if (query.hasColumns()) {
			columns = new LinkedHashMap();
			columns.putAll(query.getColumns());
		}

		if (query.hasJoins()) {
			joins = new LinkedHashMap();
			joins.putAll(query.getJoins());
		}

		if (query.hasFilters()) {
			// shadow clone
			filters = query.getFilters().clone();
		}
		
		if (query.hasOrders()) {
			orders = new LinkedHashMap();
			orders.putAll(query.getOrders());
		}
		
		if (query.hasGroups()) {
			groups = new ArrayList();
			groups.addAll(query.getGroups());
		}
	}

	/**
	 * @return the target
	 */
	@Override
	public Object getTarget() {
		return target;
	}

	/**
	 * @return the entity
	 */
	@Override
	@SuppressWarnings("unchecked")
	public Entity getEntity() {
		return target instanceof Entity ? (Entity)target : null;
	}

	/**
	 * @param entity the entity to set
	 */
	public void setEntity(Entity entity) {
		this.target = entity;
	}

	/**
	 * @return the type
	 */
	@Override
	@SuppressWarnings("unchecked")
	public Class getType() {
		if (target instanceof Entity) {
			return ((Entity)target).getType();
		}
		if (target instanceof Class) {
			return (Class)target;
		}
		return (Class)Map.class;
	}

	/**
	 * @return the table
	 */
	@Override
	@SuppressWarnings("unchecked")
	public String getTable() {
		if (target instanceof Entity) {
			return ((Entity)target).getView();
		}
		if (target instanceof String) {
			return (String)target;
		}
		return null;
	}

	/**
	 * clear
	 * @return this
	 */
	public DataQuery clear() {
		start = 0;
		limit = 0;
		if (columns != null) {
			columns.clear();
		};
		if (joins != null) {
			joins.clear();
		}
		if (filters != null) {
			filters.setLogical(Logical.AND);
			filters.clear();
		}
		if (orders != null) {
			orders.clear();
		};
		if (groups != null) {
			groups.clear();
		};
		
		return this;
	}

	//---------------------------------------------------------------
	//
	/**
	 * @return the distinct
	 */
	@Override
	public boolean isDistinct() {
		return distinct;
	}

	/**
	 * @param distinct the distinct to set
	 */
	public void setDistinct(boolean distinct) {
		this.distinct = distinct;
	}

	//---------------------------------------------------------------
	// columns
	//
	/**
	 * @return true if the columns is not empty
	 */
	@Override
	public boolean hasColumns() {
		return columns != null && !columns.isEmpty();
	}

	/**
	 * @return the columns
	 */
	@Override
	public Map getColumns() {
		return columns;
	}

	/**
	 * @param name column name
	 * @return column value
	 */
	@Override
	public String getColumn(String name) {
		if (columns == null) {
			return null;
		}
		return columns.get(name);
	}

	protected int flags() {
		if (flags == null) {
			flags = 0;
			if (columns != null && !columns.isEmpty()) {
				Collection vs = columns.values();
				for (String v : vs) {
					if ("".equals(v)) {
						flags |= HAS_INCLUDES;
					}
					if (v == null) {
						flags |= HAS_EXCLUDES;
					}
				}
			}
		}
		return flags;
	}
	
	/**
	 * @return true if has included columns
	 */
	protected boolean hasIncludes() {
		return (flags() & HAS_INCLUDES) != 0;
	}
	
	/**
	 * @return true if has excluded columns
	 */
	protected boolean hasExcludes() {
		return (flags() & HAS_EXCLUDES) != 0;
	}

	/**
	 * set column value, the value will be auto modified to ( value )
	 * @param name column name
	 * @param value column value
	 * @return this
	 */
	public DataQuery column(String name, String value) {
		return rawColumn(name, '(' + value + ')');
	}

	/**
	 * @param name column name
	 * @param value column value
	 * @return this
	 */
	private DataQuery rawColumn(String name, String value) {
		setColumn(name, value);
		flags = null;
		return this;
	}

	/**
	 * @param name the field name to include
	 * @param value the column value
	 * @return this
	 */
	private DataQuery setColumn(String name, String value) {
		Asserts.notEmpty(name);
		if (columns == null) {
			columns = new LinkedHashMap();
		}
		columns.put(name, value);
		return this;
	}

	/**
	 * include column
	 * @param name column name
	 */
	private void incColumn(String name) {
		String c = getColumn(name);
		setColumn(name, Strings.defaultString(c, ""));
	}

	/**
	 * exclude column
	 * @param name column name
	 */
	private void excColumn(String name) {
		setColumn(name, null);
	}
	
	/**
	 * include primary keys
	 * @return this
	 */
	public DataQuery includePrimayKeys() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getPrimaryKeys()) {
			incColumn(ef.getName());
		}
		flags = null;
		return this;
	}

	/**
	 * include not primary keys
	 * @return this
	 */
	public DataQuery includeNotPrimaryKeys() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getFields()) {
			if (!ef.isPrimaryKey()) {
				incColumn(ef.getName());
			}
		}
		flags = null;
		return this;
	}

	/**
	 * @return this
	 */
	public DataQuery includeAll() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getFields()) {
			incColumn(ef.getName());
		}
		flags = null;
		return this;
	}

	/**
	 * @param names include name
	 * @return this
	 */
	public DataQuery include(String... names) {
		return include(Arrays.asList(names));
	}

	/**
	 * @param names include name
	 * @return this
	 */
	public DataQuery include(Collection names) {
		if (Collections.isNotEmpty(names)) {
			for (String name : names) {
				incColumn(name);
			}
			flags = null;
		}
		return this;
	}

	/**
	 * @param names include name
	 * @return this
	 */
	public DataQuery includeOnly(String... names) {
		return includeOnly(Arrays.asList(names));
	}

	/**
	 * @param names include name
	 * @return this
	 */
	public DataQuery includeOnly(Collection names) {
		if (Collections.isEmpty(names)) {
			clearColumns();
			return this;
		}
		
		for (String name : names) {
			incColumn(name);
		}

		Iterator> it = columns.entrySet().iterator();
		while (it.hasNext()) {
			Entry en = it.next();
			if (!names.contains(en.getKey())) {
				it.remove();
			}
		}
		flags = null;
		return this;
	}
	
	/**
	 * exclude primary keys
	 * @return this
	 */
	public DataQuery excludePrimaryKeys() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getFields()) {
			if (ef.isPrimaryKey()) {
				excColumn(ef.getName());
			}
		}
		flags = null;
		return this;
	}

	/**
	 * exclude not primary keys
	 * @return this
	 */
	public DataQuery excludeNotPrimaryKeys() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getFields()) {
			if (!ef.isPrimaryKey()) {
				excColumn(ef.getName());
			}
		}
		flags = null;
		return this;
	}

	/**
	 * @return this
	 */
	public DataQuery excludeAll() {
		Entity entity = getEntity();
		for (EntityField ef : entity.getFields()) {
			excColumn(ef.getName());
		}
		flags = null;
		return this;
	}

	/**
	 * @param names the field names to exclude
	 * @return this
	 */
	public DataQuery exclude(String... names) {
		return exclude(Arrays.asList(names));
	}

	/**
	 * @param names the field names to exclude
	 * @return this
	 */
	public DataQuery exclude(Collection names) {
		if (Collections.isNotEmpty(names)) {
			for (String name : names) {
				excColumn(name);
			}
			flags = null;
		}
		return this;
	}

	/**
	 * @param name field name
	 * @return true if the name should include
	 */
	@Override
	public boolean shouldInclude(String name) {
		return !hasIncludes() || columns.get(name) != null;
	}

	/**
	 * @param name field name
	 * @return true if the name should exclude
	 */
	@Override
	public boolean shouldExclude(String name) {
		if (hasIncludes()) {
			return columns.get(name) == null;
		}
		if (hasExcludes()) {
			return columns.containsKey(name) && columns.get(name) == null;
		}
		return false;
	}

	/**
	 * clearColumns
	 * 
	 * @return this
	 */
	public DataQuery clearColumns() {
		if (columns != null) {
			columns.clear();
			flags = null;
		}
		return this;
	}

	//---------------------------------------------------------------
	// join
	//
	/**
	 * @return true if has orders
	 */
	@Override
	public boolean hasJoins() {
		return joins != null && !joins.isEmpty();
	}

	/**
	 * @return joins
	 */
	@Override
	public Map getJoins() {
		return joins;
	}

	/**
	 * @return join
	 */
	@Override
	public Join getJoin(String join) {
		if (Collections.isEmpty(joins)) {
			return null;
		}
		return joins.get(join);
	}

	/**
	 * add left join
	 * @param query join query
	 * @param alias join alias
	 * @param conditions join conditions
	 * @return this
	 */
	public DataQuery leftJoin(Query query, String alias, String ... conditions) {
		return join(Join.LEFT, query, alias, conditions);
	}

	/**
	 * add right join
	 * @param query join query
	 * @param alias join alias
	 * @param conditions join conditions
	 * @return this
	 */
	public DataQuery rightJoin(Query query, String alias, String ... conditions) {
		return join(Join.RIGHT, query, alias, conditions);
	}

	/**
	 * add inner join
	 * @param query join query
	 * @param alias join alias
	 * @param conditions join conditions
	 * @return this
	 */
	public DataQuery innerJoin(Query query, String alias, String ... conditions) {
		return join(Join.INNER, query, alias, conditions);
	}

	/**
	 * add join
	 * @param query join query
	 * @param alias join alias
	 * @param conditions join conditions
	 * @return this
	 */
	public DataQuery join(Query query, String alias, String ... conditions) {
		return join(null, query, alias, conditions);
	}

	/**
	 * add join
	 * @param type join type
	 * @param query join query
	 * @param alias join alias
	 * @param conditions join conditions
	 * @return this
	 */
	public DataQuery join(String type, Query query, String alias, String ... conditions) {
		Asserts.notEmpty(alias, "The parameter alias is empty");
		if (joins == null) {
			joins = new LinkedHashMap();
		}
		joins.put(alias, new Join(type, query, conditions));
		return this;
	}

	//---------------------------------------------------------------
	// auto joins
	//
	/**
	 * auto add left join from @Join
	 * @param join join name
	 * @return this
	 */
	public DataQuery autoLeftJoin(String join) {
		return autoJoin(Join.LEFT, join);
	}

	/**
	 * auto add left join from @Join
	 * @param join join name
	 * @param query join table query
	 * @return this
	 */
	public DataQuery autoLeftJoin(String join, Query query) {
		return autoJoin(Join.LEFT, join, query);
	}

	/**
	 * auto add right join from @Join
	 * @param join join name
	 * @return this
	 */
	public DataQuery autoRightJoin(String join) {
		return autoJoin(Join.RIGHT, join);
	}

	/**
	 * auto add right join from @Join
	 * @param join join name
	 * @param query join table query
	 * @return this
	 */
	public DataQuery autoRightJoin(String join, Query query) {
		return autoJoin(Join.RIGHT, join, query);
	}

	/**
	 * auto add inner join from @Join
	 * @param join join name
	 * @return this
	 */
	public DataQuery autoInnerJoin(String join) {
		return autoJoin(Join.INNER, join);
	}

	/**
	 * auto add inner join from @Join
	 * @param join join name
	 * @param query join table query
	 * @return this
	 */
	public DataQuery autoInnerJoin(String join, Query query) {
		return autoJoin(Join.INNER, join, query);
	}

	/**
	 * auto add join from @Join
	 * @param join join name
	 * @return this
	 */
	public DataQuery autoJoin(String join) {
		return autoJoin(null, join);
	}

	/**
	 * auto add join from @Join
	 * @param join join name
	 * @param query join table query
	 * @return this
	 */
	public DataQuery autoJoin(String join, Query query) {
		return autoJoin(null, join, query);
	}

	/**
	 * auto add join from @Join
	 * @param type join type
	 * @param join join name
	 * @return this
	 */
	public DataQuery autoJoin(String type, String join) {
		return autoJoin(type, join, null);
	}
	
	/**
	 * auto add join from @Join
	 * @param type join type
	 * @param join join name
	 * @param query join table query
	 * @return this
	 */
	@SuppressWarnings({ "unchecked", "rawtypes" })
	public DataQuery autoJoin(String type, String join, Query query) {
		Asserts.notEmpty(join, "The parameter join is empty");
		Entity entity = getEntity();

		Asserts.notNull(entity, "The entity is null");
		Asserts.notEmpty(entity.getJoins(), "The entity joins is null");

		EntityJoin ej = entity.getJoin(join);
		if (ej == null) {
			throw new IllegalArgumentException("The entity join [" + join + "] is not found");
		}

		if (query == null) {
			query = new DataQuery(ej.getTarget());
		}
		else {
			if (query.getEntity() != ej.getTarget()) {
				throw new IllegalArgumentException("The join query [" + query.getEntity().getType() + "] is compatible to " + ej.getTarget().getType());
			}
		}
		
		String[] cs = new String[ej.getKeys().size()];
		for (int i = 0; i < cs.length; i++) {
			cs[i] = ej.getKeys().get(i).getName() + '=' + ej.getRefs().get(i).getName();
		}
		
		join(type, query, join, cs);
		for (EntityField ef : entity.getFields()) {
			if (join.equals(ef.getJoinName())) {
				rawColumn(ef.getName(), join + '.' + ef.getJoinField());
			}
		}
		return this;
	}

	//---------------------------------------------------------------
	// orders
	//
	/**
	 * @param name property/field/column name
	 * @return true if the property has some order
	 */
	@Override
	public boolean hasOrder(String name) {
		if (hasOrders()) {
			return orders.containsKey(name);
		}
		return false;
	}
	
	/**
	 * @return true if has orders
	 */
	@Override
	public boolean hasOrders() {
		return orders != null && !orders.isEmpty();
	}

	/**
	 * @return orders
	 */
	@Override
	public Map getOrders() {
		return orders;
	}

	/**
	 * add ascend order
	 * @param column column
	 * @return this
	 */
	public DataQuery orderBy(String column) {
		return orderBy(column, true);
	}

	/**
	 * add order
	 * @param name name
	 * @param order order direction
	 * @return this
	 */
	public DataQuery orderBy(String name, Order order) {
		Asserts.notEmpty(name, "The parameter name is empty");
		if (orders == null) {
			orders = new LinkedHashMap();
		}
		orders.put(name, order);
		return this;
	}

	/**
	 * add order
	 * @param name name
	 * @param order order direction
	 * @return this
	 */
	public DataQuery orderBy(String name, String order) {
		return orderBy(name, Order.parse(order));
	}

	/**
	 * add order
	 * @param name name
	 * @param ascend direction
	 * @return this
	 */
	public DataQuery orderBy(String name, boolean ascend) {
		return orderBy(name, ascend ? Order.ASC : Order.DESC);
	}

	/**
	 * add ascend order
	 * @param name name
	 * @return this
	 */
	public DataQuery orderByAsc(String name) {
		return orderBy(name, true);
	}

	/**
	 * add descend order
	 * @param name name
	 * @return this
	 */
	public DataQuery orderByDesc(String name) {
		return orderBy(name, false);
	}

	//---------------------------------------------------------------
	// groups
	//
	/**
	 * @return true if has groups
	 */
	@Override
	public boolean hasGroups() {
		return groups != null && !groups.isEmpty();
	}

	/**
	 * @return groups
	 */
	@Override
	public List getGroups() {
		return groups;
	}

	/**
	 * add group
	 * @param column column
	 * @return this
	 */
	public DataQuery groupBy(String ... column) {
		if (groups == null) {
			groups = new ArrayList();
		}
		for (String s : column) {
			groups.add(s);
		}
		return this;
	}

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

	/**
	 * @param start the start to set
	 */
	public void setStart(long start) {
		Asserts.isTrue(start >= 0, "The start must >= 0");
		this.start = start;
	}

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

	/**
	 * @param limit the limit to set
	 */
	public void setLimit(long limit) {
		Asserts.isTrue(limit >= 0, "The limit must >= 0");
		this.limit = limit;
	}

	/**
	 * @param start the start to set
	 * @return this
	 */
	public DataQuery start(long start) {
		setStart(start);
		return this;
	}

	/**
	 * @param limit the limit to set
	 * @return this
	 */
	public DataQuery limit(long limit) {
		setLimit(limit);
		return this;
	}

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

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

	/**
	 * @return true if has conditions
	 */
	@Override
	public boolean hasFilters() {
		return filters != null && !filters.isEmpty();
	}
	
	/**
	 * @param name property/field/column name
	 * @return true if the property has some filter
	 */
	@Override
	public boolean hasFilter(String name) {
		if (hasFilters()) {
			return filters.hasFilter(name);
		}
		return false;
	}
	
	private DataQuery addSimpleExpression(String field, Operator operator) {
		getCurrent().add(new SimpleFilter(field, operator));
		return this;
	}

	private DataQuery addCompareValueExpression(String field, Operator operator, Object compareValue) {
		getCurrent().add(new ValueFilter(field, operator, compareValue));
		return this;
	}

	private DataQuery addCompareFieldExpression(String field, Operator operator, String compareField) {
		getCurrent().add(new ReferFilter(field, operator, compareField));
		return this;
	}

	private DataQuery addCompareCollectionExpression(String field, Operator operator, Object[] values) {
		getCurrent().add(new ValueFilter(field, operator, values));
		return this;
	}

	private DataQuery addCompareCollectionExpression(String field, Operator operator, Collection values) {
		getCurrent().add(new ValueFilter(field, operator, values));
		return this;
	}

	private DataQuery addCompareRanageExpression(String field, Operator operator, Object minValue, Object maxValue) {
		getCurrent().add(new ValueFilter(field, operator, new Object[] { minValue, maxValue }));
		return this;
	}

	private ComboFilter getCurrent() {
		if (Collections.isNotEmpty(stack)) {
			return stack.get(stack.size() - 1);
		}
		
		if (filters != null) {
			return filters;
		}
		
		filters = new ComboFilter(Logical.AND);
		return filters;
	}
	
	private void setCurrent(ComboFilter cf) {
		if (stack == null) {
			stack = new ArrayList();
		}
		stack.add(cf);
	}
	
	/**
	 * starts with AND
	 * @return this
	 */
	public DataQuery and() {
		ComboFilter cf = new ComboFilter(Logical.AND);
		getCurrent().add(cf);
		setCurrent(cf);
		return this;
	}
	
	/**
	 * starts with OR
	 * @return this
	 */
	public DataQuery or() {
		ComboFilter cf = new ComboFilter(Logical.OR);
		getCurrent().add(cf);
		setCurrent(cf);
		return this;
	}
	
	/**
	 * end with AND/OR
	 * @return this
	 */
	public DataQuery end() {
		ComboFilter cf = getCurrent();

		// remove current from stack
		if (Collections.isNotEmpty(stack)) {
			stack.remove(stack.size() - 1);
		}
		
		if (cf.isEmpty()) {
			// remove empty ComboFilter for and().end()
			ComboFilter pf = getCurrent();
			pf.getFilters().remove(cf);
		}

		return this;
	}
	
	/**
	 * add "field IS NULL" expression
	 * @param field field 
	 * @return this
	 */
	public DataQuery isNull(String field) {
		return addSimpleExpression(field, Operator.IS_NULL);
	}

	/**
	 * add "field IS NOT NULL" expression 
	 * @param field field 
	 * @return this
	 */
	public DataQuery isNotNull(String field) {
		return addSimpleExpression(field, Operator.IS_NOT_NULL);
	}

	/**
	 * add "field = value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery eq(String field, Object value) {
		return addCompareValueExpression(field, Operator.EQUAL, value);
	}

	/**
	 * add "field <> value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery ne(String field, Object value) {
		return addCompareValueExpression(field, Operator.NOT_EQUAL, value);
	}

	/**
	 * add "field > value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery gt(String field, Object value) {
		return addCompareValueExpression(field, Operator.GREATER_THAN, value);
	}

	/**
	 * add "field %gt;= value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery ge(String field, Object value) {
		return addCompareValueExpression(field, Operator.GREATER_EQUAL, value);
	}

	/**
	 * add "field < value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery lt(String field, Object value) {
		return addCompareValueExpression(field, Operator.LESS_THAN, value);
	}

	/**
	 * add "field <= value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery le(String field, Object value) {
		return addCompareValueExpression(field, Operator.LESS_EQUAL, value);
	}

	/**
	 * add "field LIKE value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery like(String field, String value) {
		return addCompareValueExpression(field, Operator.LIKE, value);
	}

	/**
	 * add "field LIKE value" expression
	 * @param field field 
	 * @param value value
	 * @param esc escape char
	 * @return this
	 */
	public DataQuery like(String field, String value, char esc) {
		return addCompareValueExpression(field, Operator.LIKE, new Object[] { value, esc });
	}

	/**
	 * add "field NOT LIKE value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery nlike(String field, String value) {
		return addCompareValueExpression(field, Operator.NOT_LIKE, value);
	}

	/**
	 * add "field NOT LIKE value" expression
	 * @param field field 
	 * @param value value
	 * @param esc escape char
	 * @return this
	 */
	public DataQuery nlike(String field, String value, char esc) {
		return addCompareValueExpression(field, Operator.NOT_LIKE, new Object[] { value, esc });
	}

	/**
	 * contains the value, add "field LIKE %value%" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery contains(String field, String value) {
		return addCompareValueExpression(field, Operator.CONTAINS, value);
	}

	/**
	 * not contains the value, add "field NOT LIKE %value%" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery ncontains(String field, String value) {
		return addCompareValueExpression(field, Operator.NOT_CONTAINS, value);
	}

	/**
	 * startsWith the value, add "field LIKE value%" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery startsWith(String field, String value) {
		return addCompareValueExpression(field, Operator.STARTS_WITH, value);
	}

	/**
	 * not startsWith the value, add "field NOT LIKE value%" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery nstartsWith(String field, String value) {
		return addCompareValueExpression(field, Operator.NOT_STARTS_WITH, value);
	}

	/**
	 * endsWith the value, add "field LIKE %value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery endsWith(String field, String value) {
		return addCompareValueExpression(field, Operator.ENDS_WITH, value);
	}

	/**
	 * not endsWith the value, add "field NOT LIKE %value" expression
	 * @param field field 
	 * @param value value
	 * @return this
	 */
	public DataQuery nendsWith(String field, String value) {
		return addCompareValueExpression(field, Operator.NOT_ENDS_WITH, value);
	}

	/**
	 * equals to the compareField, add "field = compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery eq2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.EQUAL, compareField);
	}

	/**
	 * not equals to the compareField, add "field <> compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery ne2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.NOT_EQUAL, compareField);
	}

	/**
	 * greater than to the compareField, add "field %gt; compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery gt2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.GREATER_THAN, compareField);
	}

	/**
	 * greater equals to the compareField, add "field >= compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery ge2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.GREATER_EQUAL, compareField);
	}

	/**
	 * add "field < compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery lt2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.LESS_THAN, compareField);
	}

	/**
	 * add "field %lt;= compareField" expression
	 * @param field field 
	 * @param compareField field to compare
	 * @return this
	 */
	public DataQuery le2(String field, String compareField) {
		return addCompareFieldExpression(field, Operator.LESS_EQUAL, compareField);
	}

	/**
	 * add "field IN (value1, value2 ...)" expression
	 * @param field field 
	 * @param values values
	 * @return this
	 */
	public DataQuery in(String field, Object... values) {
		return addCompareCollectionExpression(field, Operator.IN, values);
	}

	/**
	 * add "field IN (value1, value2 ...)" expression
	 * @param field field 
	 * @param values values
	 * @return this
	 */
	public DataQuery in(String field, Collection values) {
		return addCompareCollectionExpression(field, Operator.IN, values);
	}

	/**
	 * add "field NOT IN (value1, value2 ...)" expression
	 * @param field field 
	 * @param values values
	 * @return this
	 */
	public DataQuery nin(String field, Object[] values) {
		return addCompareCollectionExpression(field, Operator.NOT_IN, values);
	}

	/**
	 * add "field NOT IN (value1, value2 ...)" expression
	 * @param field field 
	 * @param values values
	 * @return this
	 */
	public DataQuery nin(String field, Collection values) {
		return addCompareCollectionExpression(field, Operator.NOT_IN, values);
	}

	/**
	 * add "field BETWEEN (value1, value2)" expression
	 * @param field field 
	 * @param value1 value from
	 * @param value2 value to
	 * @return this
	 */
	public DataQuery between(String field, Object value1, Object value2) {
		return addCompareRanageExpression(field, Operator.BETWEEN, value1, value2);
	}

	/**
	 * add "field NOT BETWEEN (value1, value2)" expression
	 * @param field field 
	 * @param value1 value from
	 * @param value2 value to
	 * @return this
	 */
	public DataQuery nbetween(String field, Object value1, Object value2) {
		return addCompareRanageExpression(field, Operator.NOT_BETWEEN, value1, value2);
	}

	/**
	 * equal to primary keys, Entity must be set
	 * @param keys primary keys
	 * @return this
	 */
	public DataQuery equalToPrimaryKeys(Object ... keys) {
		Entity entity = getEntity();
		
		if (keys == null || keys.length == 0) {
			throw new IllegalArgumentException("Illegal primary keys for Entity [" + entity.getType() + "]: " + Objects.toString(keys));
		}
		
		if (keys.length == 1 && entity.getType().isInstance(keys[0])) {
			for (EntityField ef : entity.getPrimaryKeys()) {
				Object k = ef.getValue(keys[0]);
				if (k == null) {
					throw new IllegalArgumentException("Null primary keys for Entity [" + entity.getType() + "]: " + Objects.toString(keys));
				}
				eq(ef.getName(), k);
			}
		}
		else {
			if (keys.length != entity.getPrimaryKeys().size()) {
				throw new IllegalArgumentException("Illegal primary keys for Entity [" + entity.getType() + "]: " + Objects.toString(keys));
			}
			
			int i = 0;
			for (EntityField ef : entity.getFields()) {
				if (ef.isPrimaryKey()) {
					eq(ef.getName(), keys[i++]);
				}
			}
		}
		
		return this;
	}

	/**
	 * @see java.lang.Object#clone()
	 */
	@Override
	public DataQuery clone() {
		return new DataQuery(this);
	}

	/**
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		return Objects.hashCodes(target, distinct, start, limit, columns, joins, filters, orders, groups);
	}

	/**
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@SuppressWarnings("rawtypes")
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		
		DataQuery rhs = (DataQuery)obj;
		return Objects.equalsBuilder()
				.append(target, rhs.target)
				.append(distinct, rhs.distinct)
				.append(start, rhs.start)
				.append(limit, rhs.limit)
				.append(columns, rhs.columns)
				.append(joins, rhs.joins)
				.append(filters, rhs.filters)
				.append(orders, rhs.orders)
				.append(groups, rhs.groups)
				.isEquals();
	}

	/**
	 * @return a string representation of the object.
	 */
	@Override
	public String toString() {
		return Objects.toStringBuilder()
				.append("target", target)
				.append("distinct", distinct)
				.append("start", start)
				.append("limit", limit)
				.append("columns", columns)
				.append("joins", joins)
				.append("filters", filters)
				.append("orders", orders)
				.append("groups", groups)
				.toString();
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy