org.ofbiz.entity.condition
Class EntityCondition

java.lang.Object
  org.ofbiz.entity.condition.EntityConditionBase
      org.ofbiz.entity.condition.EntityCondition

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EntityConditionFunction, EntityConditionListBase, EntityDateFilterCondition, EntityExpr, EntityWhereString

public abstract class EntityCondition
extends EntityConditionBase

Represents the conditions to be used to constrain a query
An EntityCondition can represent various type of constraints, including:

• EntityConditionList: a list of EntityConditions, combined with the operator specified
• EntityExpr: for simple expressions or expressions that combine EntityConditions
• EntityFieldMap: a map of fields where the field (key) equals the value, combined with the operator specified

These can be used in various combinations using the EntityConditionList and EntityExpr objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.ofbiz.entity.condition.EntityConditionBase

_emptyMap, emptyAliases, emptyList

Constructor Summary

EntityCondition()

Method Summary

void	accept(EntityConditionVisitor visitor)
abstract void	checkCondition(ModelEntity modelEntity)
abstract void	encryptConditionFields(ModelEntity modelEntity, GenericDelegator delegator)
boolean	entityMatches(GenericEntity entity)
java.lang.Boolean	eval(GenericDelegator delegator, java.util.Map<java.lang.String,? extends java.lang.Object> map)
java.lang.Boolean	eval(GenericEntity entity)
abstract EntityCondition	freeze()
static EntityFieldMap	makeCondition(EntityComparisonOperator compOp, EntityJoinOperator joinOp, java.lang.Object... keysValues)
static EntityExpr	makeCondition(EntityCondition lhs, EntityJoinOperator operator, EntityCondition rhs)
static EntityFieldMap	makeCondition(EntityJoinOperator joinOp, java.lang.Object... keysValues)
static <T extends EntityCondition> EntityConditionList<T>	makeCondition(EntityJoinOperator operator, T... conditionList)
static <T extends EntityCondition> EntityConditionList<T>	makeCondition(java.util.List<T> conditionList)
static <T extends EntityCondition> EntityConditionList<T>	makeCondition(java.util.List<T> conditionList, EntityJoinOperator operator)
static EntityFieldMap	makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap)
static EntityFieldMap	makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap, EntityComparisonOperator compOp, EntityJoinOperator joinOp)
static EntityFieldMap	makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap, EntityJoinOperator joinOp)
static EntityExpr	makeCondition(java.lang.Object lhs, EntityComparisonOperator operator, java.lang.Object rhs)
static EntityExpr	makeCondition(java.lang.String fieldName, java.lang.Object value)
static <T extends EntityCondition> EntityConditionList<T>	makeCondition(T... conditionList)
static EntityDateFilterCondition	makeConditionDate(java.lang.String fromDateName, java.lang.String thruDateName)
static EntityFieldMap	makeConditionMap(java.lang.Object... keysValues)
static EntityWhereString	makeConditionWhere(java.lang.String sqlString)
abstract java.lang.String	makeWhereString(ModelEntity modelEntity, java.util.List<EntityConditionParam> entityConditionParams, DatasourceInfo datasourceInfo)
abstract boolean	mapMatches(GenericDelegator delegator, java.util.Map<java.lang.String,? extends java.lang.Object> map)
java.lang.String	toString()
void	visit(EntityConditionVisitor visitor)

Methods inherited from class org.ofbiz.entity.condition.EntityConditionBase

addValue, castBoolean, equals, equals, getColName, getColName, getColName, getField, hashCode, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityCondition

public EntityCondition()

Method Detail

makeCondition

public static EntityExpr makeCondition(java.lang.Object lhs,
                                       EntityComparisonOperator operator,
                                       java.lang.Object rhs)

makeCondition

public static EntityExpr makeCondition(java.lang.String fieldName,
                                       java.lang.Object value)

makeCondition

public static EntityExpr makeCondition(EntityCondition lhs,
                                       EntityJoinOperator operator,
                                       EntityCondition rhs)

makeCondition

public static <T extends EntityCondition> EntityConditionList<T> makeCondition(EntityJoinOperator operator,
                                                                               T... conditionList)

makeCondition

public static <T extends EntityCondition> EntityConditionList<T> makeCondition(T... conditionList)

makeCondition

public static <T extends EntityCondition> EntityConditionList<T> makeCondition(java.util.List<T> conditionList,
                                                                               EntityJoinOperator operator)

makeCondition

public static <T extends EntityCondition> EntityConditionList<T> makeCondition(java.util.List<T> conditionList)

makeCondition

public static EntityFieldMap makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap,
                                           EntityComparisonOperator compOp,
                                           EntityJoinOperator joinOp)

makeCondition

public static EntityFieldMap makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap,
                                           EntityJoinOperator joinOp)

makeCondition

public static EntityFieldMap makeCondition(java.util.Map<java.lang.String,? extends java.lang.Object> fieldMap)

makeCondition

public static EntityFieldMap makeCondition(EntityComparisonOperator compOp,
                                           EntityJoinOperator joinOp,
                                           java.lang.Object... keysValues)

makeCondition

public static EntityFieldMap makeCondition(EntityJoinOperator joinOp,
                                           java.lang.Object... keysValues)

makeConditionMap

public static EntityFieldMap makeConditionMap(java.lang.Object... keysValues)

makeConditionDate

public static EntityDateFilterCondition makeConditionDate(java.lang.String fromDateName,
                                                          java.lang.String thruDateName)

makeConditionWhere

public static EntityWhereString makeConditionWhere(java.lang.String sqlString)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

accept

public void accept(EntityConditionVisitor visitor)

makeWhereString

public abstract java.lang.String makeWhereString(ModelEntity modelEntity,
                                                 java.util.List<EntityConditionParam> entityConditionParams,
                                                 DatasourceInfo datasourceInfo)

checkCondition

public abstract void checkCondition(ModelEntity modelEntity)
                             throws GenericModelException

Throws:

GenericModelException

entityMatches

public boolean entityMatches(GenericEntity entity)

eval

public java.lang.Boolean eval(GenericEntity entity)

eval

public java.lang.Boolean eval(GenericDelegator delegator,
                              java.util.Map<java.lang.String,? extends java.lang.Object> map)

mapMatches

public abstract boolean mapMatches(GenericDelegator delegator,
                                   java.util.Map<java.lang.String,? extends java.lang.Object> map)

freeze

public abstract EntityCondition freeze()

encryptConditionFields

public abstract void encryptConditionFields(ModelEntity modelEntity,
                                            GenericDelegator delegator)

visit

public void visit(EntityConditionVisitor visitor)