Package org.ofbiz.core.entity

Class EntityFieldMap

java.lang.Object

org.ofbiz.core.entity.EntityCondition

org.ofbiz.core.entity.EntityFieldMap

All Implemented Interfaces:

Serializable

public class EntityFieldMap
extends EntityCondition

Encapsulates simple expressions used for specifying queries

Since:

2.0

Version:

$Revision: 1.1 $

Author:

David E. Jones

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,?>	fieldMap
protected EntityOperator	operator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityFieldMap()
	EntityFieldMap(Map<String,?> fieldMap, EntityOperator operator)

Method Summary

Modifier and Type	Method	Description
void	checkCondition(ModelEntity modelEntity)	Checks this condition against the given entity.
boolean	containsField(String name)
Object	getField(String name)
Iterator<? extends Map.Entry<String,?>>	getFieldEntryIterator()
Iterator<String>	getFieldKeyIterator()
EntityOperator	getOperator()
int	getParameterCount(ModelEntity modelEntity, SqlEscapeHelper sqlEscapeHelper)	Returns the number of SQL parameters that would be generated for this condition.
String	makeWhereString(ModelEntity modelEntity, List<? super EntityConditionParam> entityConditionParams, SqlEscapeHelper sqlEscapeHelper)	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 Details

fieldMap

protected Map<String,?> fieldMap

operator

protected EntityOperator operator

Constructor Details

EntityFieldMap

protected EntityFieldMap()

EntityFieldMap

public EntityFieldMap(Map<String,?> fieldMap,
 EntityOperator operator)

Method Details

getOperator

public EntityOperator getOperator()

getField

public Object getField(String name)

containsField

public boolean containsField(String name)

getFieldKeyIterator

public Iterator<String> getFieldKeyIterator()

getFieldEntryIterator

public Iterator<? extends Map.Entry<String,?>> getFieldEntryIterator()

makeWhereString

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

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

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

getParameterCount

public int getParameterCount(ModelEntity modelEntity,
 SqlEscapeHelper sqlEscapeHelper)

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.

toString

public String toString()

Overrides:

toString in class Object