org.objectstyle.cayenne.exp.ExpressionFactory Maven / Gradle / Ivy
/* ====================================================================
*
* The ObjectStyle Group Software License, version 1.1
* ObjectStyle Group - http://objectstyle.org/
*
* Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
* of the software. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if any,
* must include the following acknowlegement:
* "This product includes software developed by independent contributors
* and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
* or promote products derived from this software without prior written
* permission. For written permission, email
* "andrus at objectstyle dot org".
*
* 5. Products derived from this software may not be called "ObjectStyle"
* or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
* names without prior written permission.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals and hosted on ObjectStyle Group web site. For more
* information on the ObjectStyle Group, please see
* map.
*
* For each pair pairType operator is used to build a binary
* expression. Key is considered to be a DB_PATH expression. Therefore all keys must
* be java.lang.String objects, or ClassCastException is thrown. OR is used to join
* pair binary expressions.
*/
public static Expression matchAnyDbExp(Map map, int pairType) {
List pairs = new ArrayList();
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
Map.Entry entry = (Map.Entry) it.next();
Expression exp = expressionOfType(pairType);
exp.setOperand(0, new ASTDbPath(entry.getKey()));
exp.setOperand(1, wrapPathOperand(entry.getValue()));
pairs.add(exp);
}
return joinExp(Expression.OR, pairs);
}
/**
* Creates an expression that matches all key-values pairs in map.
*
* For each pair pairType operator is used to build a binary
* expression. Key is considered to be a DB_PATH expression. Therefore all keys must
* be java.lang.String objects, or ClassCastException is thrown. AND is used to join
* pair binary expressions.
*/
public static Expression matchAllDbExp(Map map, int pairType) {
List pairs = new ArrayList();
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
Map.Entry entry = (Map.Entry) it.next();
Expression exp = expressionOfType(pairType);
exp.setOperand(0, new ASTDbPath(entry.getKey()));
exp.setOperand(1, wrapPathOperand(entry.getValue()));
pairs.add(exp);
}
return joinExp(Expression.AND, pairs);
}
/**
* Creates an expression that matches any of the key-values pairs in the
* map.
*
* For each pair pairType operator is used to build a binary
* expression. Key is considered to be a OBJ_PATH expression. Therefore all keys must
* be java.lang.String objects, or ClassCastException is thrown. OR is used to join
* pair binary expressions.
*/
public static Expression matchAnyExp(Map map, int pairType) {
List pairs = new ArrayList();
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
Map.Entry entry = (Map.Entry) it.next();
Expression exp = expressionOfType(pairType);
exp.setOperand(0, new ASTObjPath(entry.getKey()));
exp.setOperand(1, wrapPathOperand(entry.getValue()));
pairs.add(exp);
}
return joinExp(Expression.OR, pairs);
}
/**
* Creates an expression that matches all key-values pairs in map.
*
* For each pair pairType operator is used to build a binary
* expression. Key is considered to be a OBJ_PATH expression. Therefore all keys must
* be java.lang.String objects, or ClassCastException is thrown. AND is used to join
* pair binary expressions.
*/
public static Expression matchAllExp(Map map, int pairType) {
List pairs = new ArrayList();
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
Map.Entry entry = (Map.Entry) it.next();
Expression exp = expressionOfType(pairType);
exp.setOperand(0, new ASTObjPath(entry.getKey()));
exp.setOperand(1, wrapPathOperand(entry.getValue()));
pairs.add(exp);
}
return joinExp(Expression.AND, pairs);
}
/**
* A convenience method to create an DB_PATH "equal to" expression.
*/
public static Expression matchDbExp(String pathSpec, Object value) {
return new ASTEqual(new ASTDbPath(pathSpec), value);
}
/**
* A convenience method to create an DB_PATH "not equal to" expression.
*/
public static Expression noMatchDbExp(String pathSpec, Object value) {
return new ASTNotEqual(new ASTDbPath(pathSpec), value);
}
/**
* A convenience shortcut for building IN DB expression.
*/
public static Expression inDbExp(String pathSpec, Object[] values) {
return new ASTIn(new ASTDbPath(pathSpec), new ASTList(values));
}
/**
* A convenience shortcut for building IN DB expression.
*/
public static Expression inDbExp(String pathSpec, Collection values) {
return new ASTIn(new ASTDbPath(pathSpec), new ASTList(values));
}
/**
* A convenience method to create an OBJ_PATH "equal to" expression.
*/
public static Expression matchExp(String pathSpec, Object value) {
return new ASTEqual(new ASTObjPath(pathSpec), value);
}
/**
* A convenience method to create an OBJ_PATH "not equal to" expression.
*/
public static Expression noMatchExp(String pathSpec, Object value) {
return new ASTNotEqual(new ASTObjPath(pathSpec), value);
}
/**
* A convenience method to create an OBJ_PATH "less than" expression.
*/
public static Expression lessExp(String pathSpec, Object value) {
return new ASTLess(new ASTObjPath(pathSpec), value);
}
/**
* A convenience method to create an OBJ_PATH "less than or equal to" expression.
*/
public static Expression lessOrEqualExp(String pathSpec, Object value) {
return new ASTLessOrEqual(new ASTObjPath(pathSpec), value);
}
/**
* A convenience method to create an OBJ_PATH "greater than" expression.
*/
public static Expression greaterExp(String pathSpec, Object value) {
return new ASTGreater(new ASTObjPath(pathSpec), value);
}
/**
* A convenience method to create an OBJ_PATH "greater than or equal to" expression.
*/
public static Expression greaterOrEqualExp(String pathSpec, Object value) {
return new ASTGreaterOrEqual(new ASTObjPath(pathSpec), value);
}
/**
* A convenience shortcut for building IN expression.
*/
public static Expression inExp(String pathSpec, Object[] values) {
return new ASTIn(new ASTObjPath(pathSpec), new ASTList(values));
}
/**
* A convenience shortcut for building IN expression.
*/
public static Expression inExp(String pathSpec, Collection values) {
return new ASTIn(new ASTObjPath(pathSpec), new ASTList(values));
}
/**
* A convenience shortcut for building NOT_IN expression.
*/
public static Expression notInExp(String pathSpec, Collection values) {
return new ASTNotIn(new ASTObjPath(pathSpec), new ASTList(values));
}
/**
* A convenience shortcut for building NOT_IN expression.
*
* @since 1.0.6
*/
public static Expression notInExp(String pathSpec, Object[] values) {
return new ASTNotIn(new ASTObjPath(pathSpec), new ASTList(values));
}
/**
* A convenience shortcut for building BETWEEN expressions.
*/
public static Expression betweenExp(String pathSpec, Object value1, Object value2) {
return new ASTBetween(new ASTObjPath(pathSpec), value1, value2);
}
/**
* A convenience shortcut for building NOT_BETWEEN expressions.
*/
public static Expression notBetweenExp(String pathSpec, Object value1, Object value2) {
return new ASTNotBetween(new ASTObjPath(pathSpec), value1, value2);
}
/**
* A convenience shortcut for building LIKE expression.
*/
public static Expression likeExp(String pathSpec, Object value) {
return new ASTLike(new ASTObjPath(pathSpec), value);
}
/**
* A convenience shortcut for building NOT_LIKE expression.
*/
public static Expression notLikeExp(String pathSpec, Object value) {
return new ASTNotLike(new ASTObjPath(pathSpec), value);
}
/**
* A convenience shortcut for building LIKE_IGNORE_CASE expression.
*/
public static Expression likeIgnoreCaseExp(String pathSpec, Object value) {
return new ASTLikeIgnoreCase(new ASTObjPath(pathSpec), value);
}
/**
* A convenience shortcut for building NOT_LIKE_IGNORE_CASE expression.
*/
public static Expression notLikeIgnoreCaseExp(String pathSpec, Object value) {
return new ASTNotLikeIgnoreCase(new ASTObjPath(pathSpec), value);
}
/**
* Joins all expressions in a single expression. type is
* used as an expression type for expressions joining each one of the items on the
* list. type must be binary expression type.
*
* For example, if type is Expression.AND, resulting expression would match all
* expressions in the list. If type is Expression.OR, resulting expression would match
* any of the expressions.
*
*/
public static Expression joinExp(int type, List expressions) {
int len = expressions.size();
if (len == 0)
return null;
Expression currentExp = (Expression) expressions.get(0);
if (len == 1) {
return currentExp;
}
Expression exp = expressionOfType(type);
for (int i = 0; i < len; i++) {
exp.setOperand(i, expressions.get(i));
}
return exp;
}
}