org.ofbiz.core.entity

Class EntityWhereString

java.lang.Object

org.ofbiz.core.entity.EntityCondition

org.ofbiz.core.entity.EntityWhereString

All Implemented Interfaces:

Serializable

public class EntityWhereString
extends EntityCondition

Encapsulates SQL expressions used for where clause snippets. NOTE: This is UNSAFE and BREAKS the idea behind the Entity Engine where you avoid directly specifying SQL. So, KEEP IT MINIMAL and preferrably replace it when the feature you are getting at is implemented in a more automatic way for you.

By minimal I mean use this in conjunction with other EntityConditions like the EntityExpr, EntityExprList and EntityFieldMap objects which more cleanly encapsulate where conditions and don't require you to directly write SQL.

Since:

2.0

Version:

$Revision: 1.1 $

Author:

David E. Jones

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	sqlString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityWhereString()
	EntityWhereString(String sqlString)

Method Summary

Modifier and Type	Method and Description
void	checkCondition(ModelEntity modelEntity) Checks this condition against the given entity.
int	getParameterCount(ModelEntity modelEntity) Returns the number of SQL parameters that would be generated for this condition.
String	makeWhereString(ModelEntity modelEntity, List<? super EntityConditionParam> entityConditionParams) Creates a string for use in a WHERE clause, based on this condition.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sqlString

protected String sqlString

Constructor Detail

EntityWhereString

protected EntityWhereString()

EntityWhereString

public EntityWhereString(String sqlString)

Method Detail

makeWhereString

public String makeWhereString(ModelEntity modelEntity,
                              List<? super EntityConditionParam> entityConditionParams)

Description copied from class: EntityCondition

Creates a string for use in a WHERE clause, based on this condition.

Specified by:

makeWhereString in class EntityCondition

Parameters:

modelEntity - the entity being queried for (required)

entityConditionParams - a non-null list to which this method will add any required bind values

Returns:

a non-null string

getParameterCount

public int getParameterCount(ModelEntity modelEntity)

Description copied from class: EntityCondition

Returns the number of SQL parameters that would be generated for this condition.

Overrides:

getParameterCount in class EntityCondition

Parameters:

modelEntity - the entity being queried for (required)

Returns:

the number of SQL parameters.

checkCondition

public void checkCondition(ModelEntity modelEntity)
                    throws GenericModelException

Description copied from class: EntityCondition

Checks this condition against the given entity.

Specified by:

checkCondition in class EntityCondition

Parameters:

modelEntity - the entity being queried for (required)

Throws:

GenericModelException - if the condition is not met

toString

public String toString()

Overrides:

toString in class Object