org.ofbiz.entity.condition
Class EntityFunction<T extends java.lang.Comparable>

java.lang.Object
  extended by org.ofbiz.entity.condition.EntityConditionBase
      extended by org.ofbiz.entity.condition.EntityConditionValue
          extended by org.ofbiz.entity.condition.EntityFunction<T>
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EntityFunction.LENGTH, EntityFunction.LOWER, EntityFunction.TRIM, EntityFunction.UPPER

public abstract class EntityFunction<T extends java.lang.Comparable>
extends EntityConditionValue

Encapsulates operations between entities and entity fields. This is a immutable class.

See Also:
Serialized Form

Nested Class Summary
static interface EntityFunction.Fetcher<T>
           
static class EntityFunction.LENGTH
           
static class EntityFunction.LOWER
           
static class EntityFunction.SQLFunction
           
static class EntityFunction.TRIM
           
static class EntityFunction.UPPER
           
 
Field Summary
protected  EntityFunction.Fetcher<T> fetcher
           
protected  EntityFunction.SQLFunction function
           
static int ID_LENGTH
           
static int ID_LOWER
           
static int ID_TRIM
           
static int ID_UPPER
           
protected  EntityConditionValue nested
           
protected  java.lang.Object value
           
 
Fields inherited from class org.ofbiz.entity.condition.EntityConditionBase
_emptyMap, emptyAliases, emptyList
 
Constructor Summary
protected EntityFunction()
           
protected EntityFunction(EntityFunction.Fetcher<T> fetcher, EntityFunction.SQLFunction function, EntityConditionValue nested)
           
protected EntityFunction(EntityFunction.Fetcher<T> fetcher, EntityFunction.SQLFunction function, java.lang.Object value)
           
 
Method Summary
 void accept(EntityConditionVisitor visitor)
           
 void addSqlValue(java.lang.StringBuilder sql, java.util.Map<java.lang.String,java.lang.String> tableAliases, ModelEntity modelEntity, java.util.List<EntityConditionParam> entityConditionParams, boolean includeTableNamePrefix, DatasourceInfo datasourceinfo)
           
 boolean equals(java.lang.Object obj)
           
 EntityConditionValue freeze()
           
 java.lang.String getCode()
           
 int getId()
           
 ModelField getModelField(ModelEntity modelEntity)
           
 java.lang.Object getOriginalValue()
           
 java.lang.Object getValue(GenericDelegator delegator, java.util.Map<java.lang.String,? extends java.lang.Object> map)
           
 int hashCode()
           
 void init(EntityFunction.Fetcher<T> fetcher, EntityFunction.SQLFunction function, java.lang.Object value)
           
static EntityFunction<java.lang.Integer> LENGTH(EntityConditionValue nested)
           
static EntityFunction<java.lang.Integer> LENGTH(java.lang.Object value)
           
static EntityFunction<java.lang.String> LOWER(EntityConditionValue nested)
           
static EntityFunction<java.lang.String> LOWER(java.lang.Object value)
           
 void reset()
           
static EntityFunction<java.lang.String> TRIM(EntityConditionValue nested)
           
static EntityFunction<java.lang.String> TRIM(java.lang.Object value)
           
static EntityFunction<java.lang.String> UPPER_FIELD(java.lang.String fieldName)
           
static EntityFunction<java.lang.String> UPPER(EntityConditionValue nested)
           
static EntityFunction<java.lang.String> UPPER(java.lang.Object value)
           
 void validateSql(ModelEntity modelEntity)
           
 void visit(EntityConditionVisitor visitor)
           
 
Methods inherited from class org.ofbiz.entity.condition.EntityConditionValue
addSqlValue, getValue, toString, toString
 
Methods inherited from class org.ofbiz.entity.condition.EntityConditionBase
addValue, castBoolean, equals, getColName, getColName, getColName, getField, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID_LENGTH

public static final int ID_LENGTH

ID_TRIM

public static final int ID_TRIM

ID_UPPER

public static final int ID_UPPER

ID_LOWER

public static final int ID_LOWER

function

protected EntityFunction.SQLFunction function

nested

protected EntityConditionValue nested

value

protected java.lang.Object value

fetcher

protected EntityFunction.Fetcher<T extends java.lang.Comparable> fetcher
Constructor Detail

EntityFunction

protected EntityFunction()

EntityFunction

protected EntityFunction(EntityFunction.Fetcher<T> fetcher,
                         EntityFunction.SQLFunction function,
                         EntityConditionValue nested)

EntityFunction

protected EntityFunction(EntityFunction.Fetcher<T> fetcher,
                         EntityFunction.SQLFunction function,
                         java.lang.Object value)
Method Detail

LENGTH

public static EntityFunction<java.lang.Integer> LENGTH(EntityConditionValue nested)

LENGTH

public static EntityFunction<java.lang.Integer> LENGTH(java.lang.Object value)

TRIM

public static EntityFunction<java.lang.String> TRIM(EntityConditionValue nested)

TRIM

public static EntityFunction<java.lang.String> TRIM(java.lang.Object value)

UPPER

public static EntityFunction<java.lang.String> UPPER(EntityConditionValue nested)

UPPER

public static EntityFunction<java.lang.String> UPPER(java.lang.Object value)

UPPER_FIELD

public static EntityFunction<java.lang.String> UPPER_FIELD(java.lang.String fieldName)

LOWER

public static EntityFunction<java.lang.String> LOWER(EntityConditionValue nested)

LOWER

public static EntityFunction<java.lang.String> LOWER(java.lang.Object value)

init

public void init(EntityFunction.Fetcher<T> fetcher,
                 EntityFunction.SQLFunction function,
                 java.lang.Object value)

reset

public void reset()

freeze

public EntityConditionValue freeze()
Specified by:
freeze in class EntityConditionValue

getCode

public java.lang.String getCode()

getOriginalValue

public java.lang.Object getOriginalValue()

getId

public int getId()

hashCode

public int hashCode()
Overrides:
hashCode in class EntityConditionBase

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class EntityConditionBase

addSqlValue

public void addSqlValue(java.lang.StringBuilder sql,
                        java.util.Map<java.lang.String,java.lang.String> tableAliases,
                        ModelEntity modelEntity,
                        java.util.List<EntityConditionParam> entityConditionParams,
                        boolean includeTableNamePrefix,
                        DatasourceInfo datasourceinfo)
Specified by:
addSqlValue in class EntityConditionValue

visit

public void visit(EntityConditionVisitor visitor)
Specified by:
visit in class EntityConditionValue

accept

public void accept(EntityConditionVisitor visitor)
Overrides:
accept in class EntityConditionValue

getModelField

public ModelField getModelField(ModelEntity modelEntity)
Specified by:
getModelField in class EntityConditionValue

validateSql

public void validateSql(ModelEntity modelEntity)
                 throws GenericModelException
Specified by:
validateSql in class EntityConditionValue
Throws:
GenericModelException

getValue

public java.lang.Object getValue(GenericDelegator delegator,
                                 java.util.Map<java.lang.String,? extends java.lang.Object> map)
Specified by:
getValue in class EntityConditionValue