Package org.apache.ofbiz.entity.datasource

Class GenericDAO

java.lang.Object

org.apache.ofbiz.entity.datasource.GenericDAO

public class GenericDAO
extends Object

Generic Entity Data Access Object - Handles persistence for any defined entity.

Constructor Summary

Constructors

Constructor	Description
GenericDAO(GenericHelperInfo helperInfo)

Method Summary

Modifier and Type	Method	Description
void	checkDb(Map<String,ModelEntity> modelEntities, List<String> messages, boolean addMissing)	Check db.
int	delete(GenericEntity entity)	Delete int.
int	delete(GenericEntity entity, SQLProcessor sqlP)	Delete int.
int	deleteByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition condition)	Delete by condition int.
int	deleteByCondition(ModelEntity modelEntity, EntityCondition condition, SQLProcessor sqlP)	Delete by condition int.
static GenericDAO	getGenericDAO(GenericHelperInfo helperInfo)
List<ModelEntity>	induceModelFromDb(Collection<String> messages)	Creates a list of ModelEntity objects based on meta data from the database
int	insert(GenericEntity entity)	Insert int.
protected StringBuilder	makeConditionHavingString(StringBuilder havingString, String prefix, ModelEntity modelEntity, EntityCondition havingEntityCondition, List<EntityCondition> viewHavingConditions, List<EntityConditionParam> havingEntityConditionParams)	Make condition having string string builder.
protected StringBuilder	makeConditionHavingString(ModelEntity modelEntity, EntityCondition havingEntityCondition, List<EntityCondition> viewHavingConditions, List<EntityConditionParam> havingEntityConditionParams)	Deprecated.
protected StringBuilder	makeConditionWhereString(StringBuilder whereString, String prefix, ModelEntity modelEntity, EntityCondition whereEntityCondition, List<EntityCondition> viewWhereConditions, List<EntityConditionParam> whereEntityConditionParams)	Make condition where string string builder.
protected StringBuilder	makeConditionWhereString(ModelEntity modelEntity, EntityCondition whereEntityCondition, List<EntityCondition> viewWhereConditions, List<EntityConditionParam> whereEntityConditionParams)	Deprecated.
protected StringBuilder	makeOffsetString(StringBuilder offsetString, EntityFindOptions findOptions)	Make offset string string builder.
void	partialSelect(GenericEntity entity, Set<String> keys)	Partial select.
void	select(GenericEntity entity)	Select.
void	select(GenericEntity entity, SQLProcessor sqlP)	Select.
List<GenericValue>	selectByMultiRelation(GenericValue value, ModelRelation modelRelationOne, ModelEntity modelEntityOne, ModelRelation modelRelationTwo, ModelEntity modelEntityTwo, List<String> orderBy)	Select by multi relation list.
long	selectCountByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, List<ModelField> selectFields, EntityFindOptions findOptions)	Select count by condition long.
long	selectCountByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, EntityFindOptions findOptions)	Select count by condition long.
EntityListIterator	selectListIteratorByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, Collection<String> fieldsToSelect, List<String> orderBy, EntityFindOptions findOptions)	Finds GenericValues by the conditions specified in the EntityCondition object, the the EntityCondition javadoc for more details.
int	update(GenericEntity entity)	Update int.
int	updateAll(GenericEntity entity)	Update all int.
int	updateByCondition(Delegator delegator, ModelEntity modelEntity, Map<String,? extends Object> fieldsToSet, EntityCondition condition)	Update by condition int.
int	updateByCondition(ModelEntity modelEntity, Map<String,? extends Object> fieldsToSet, EntityCondition condition, SQLProcessor sqlP)	Update by condition int.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericDAO

public GenericDAO(GenericHelperInfo helperInfo)

Method Details

getGenericDAO

public static GenericDAO getGenericDAO(GenericHelperInfo helperInfo)

insert

public int insert(GenericEntity entity)
           throws GenericEntityException

Insert int.

Parameters:

entity - the entity

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

updateAll

public int updateAll(GenericEntity entity)
              throws GenericEntityException

Update all int.

Parameters:

entity - the entity

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

update

public int update(GenericEntity entity)
           throws GenericEntityException

Update int.

Parameters:

entity - the entity

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

updateByCondition

public int updateByCondition(Delegator delegator,
 ModelEntity modelEntity,
 Map<String,? extends Object> fieldsToSet,
 EntityCondition condition)
                      throws GenericEntityException

Update by condition int.

Parameters:

delegator - the delegator

modelEntity - the model entity

fieldsToSet - the fields to set

condition - the condition

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

updateByCondition

public int updateByCondition(ModelEntity modelEntity,
 Map<String,? extends Object> fieldsToSet,
 EntityCondition condition,
 SQLProcessor sqlP)
                      throws GenericEntityException

Update by condition int.

Parameters:

modelEntity - the model entity

fieldsToSet - the fields to set

condition - the condition

sqlP - the sql p

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

select

public void select(GenericEntity entity)
            throws GenericEntityException

Select.

Parameters:

entity - the entity

Throws:

GenericEntityException - the generic entity exception

select

public void select(GenericEntity entity,
 SQLProcessor sqlP)
            throws GenericEntityException

Select.

Parameters:

entity - the entity

sqlP - the sql p

Throws:

GenericEntityException - the generic entity exception

partialSelect

public void partialSelect(GenericEntity entity,
 Set<String> keys)
                   throws GenericEntityException

Partial select.

Parameters:

entity - the entity

keys - the keys

Throws:

GenericEntityException - the generic entity exception

selectListIteratorByCondition

public EntityListIterator selectListIteratorByCondition(Delegator delegator,
 ModelEntity modelEntity,
 EntityCondition whereEntityCondition,
 EntityCondition havingEntityCondition,
 Collection<String> fieldsToSelect,
 List<String> orderBy,
 EntityFindOptions findOptions)
                                                 throws GenericEntityException

Finds GenericValues by the conditions specified in the EntityCondition object, the the EntityCondition javadoc for more details.

Parameters:

modelEntity - The ModelEntity of the Entity as defined in the entity XML file

whereEntityCondition - The EntityCondition object that specifies how to constrain this query before any groupings are done (if this is a view entity with group-by aliases)

havingEntityCondition - The EntityCondition object that specifies how to constrain this query after any groupings are done (if this is a view entity with group-by aliases)

fieldsToSelect - The fields of the named entity to get from the database; if empty or null all fields will be retreived

orderBy - The fields of the named entity to order the query by; optionally add a " ASC" for ascending or " DESC" for descending

findOptions - An instance of EntityFindOptions that specifies advanced query options. See the EntityFindOptions JavaDoc for more details.

Returns:

EntityListIterator representing the result of the query: NOTE THAT THIS MUST BE CLOSED WHEN YOU ARE DONE WITH IT (preferably in a finally block), AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A DATABASE CONNECTION.

Throws:

GenericEntityException

makeConditionWhereString

@Deprecated
protected StringBuilder makeConditionWhereString(ModelEntity modelEntity,
 EntityCondition whereEntityCondition,
 List<EntityCondition> viewWhereConditions,
 List<EntityConditionParam> whereEntityConditionParams)
                                          throws GenericEntityException

Deprecated.

Make condition where string string builder.

Parameters:

modelEntity - the model entity

whereEntityCondition - the where entity condition

viewWhereConditions - the view where conditions

whereEntityConditionParams - the where entity condition params

Returns:

the string builder

Throws:

GenericEntityException - the generic entity exception

makeConditionWhereString

protected StringBuilder makeConditionWhereString(StringBuilder whereString,
 String prefix,
 ModelEntity modelEntity,
 EntityCondition whereEntityCondition,
 List<EntityCondition> viewWhereConditions,
 List<EntityConditionParam> whereEntityConditionParams)
                                          throws GenericEntityException

Make condition where string string builder.

Parameters:

whereString - the where string

prefix - the prefix

modelEntity - the model entity

whereEntityCondition - the where entity condition

viewWhereConditions - the view where conditions

whereEntityConditionParams - the where entity condition params

Returns:

the string builder

Throws:

GenericEntityException - the generic entity exception

makeConditionHavingString

@Deprecated
protected StringBuilder makeConditionHavingString(ModelEntity modelEntity,
 EntityCondition havingEntityCondition,
 List<EntityCondition> viewHavingConditions,
 List<EntityConditionParam> havingEntityConditionParams)
                                           throws GenericEntityException

Deprecated.

Make condition having string string builder.

Parameters:

modelEntity - the model entity

havingEntityCondition - the having entity condition

viewHavingConditions - the view having conditions

havingEntityConditionParams - the having entity condition params

Returns:

the string builder

Throws:

GenericEntityException - the generic entity exception

makeConditionHavingString

protected StringBuilder makeConditionHavingString(StringBuilder havingString,
 String prefix,
 ModelEntity modelEntity,
 EntityCondition havingEntityCondition,
 List<EntityCondition> viewHavingConditions,
 List<EntityConditionParam> havingEntityConditionParams)
                                           throws GenericEntityException

Make condition having string string builder.

Parameters:

havingString - the having string

prefix - the prefix

modelEntity - the model entity

havingEntityCondition - the having entity condition

viewHavingConditions - the view having conditions

havingEntityConditionParams - the having entity condition params

Returns:

the string builder

Throws:

GenericEntityException - the generic entity exception

makeOffsetString

protected StringBuilder makeOffsetString(StringBuilder offsetString,
 EntityFindOptions findOptions)

Make offset string string builder.

Parameters:

offsetString - the offset string

findOptions - the find options

Returns:

the string builder

selectByMultiRelation

public List<GenericValue> selectByMultiRelation(GenericValue value,
 ModelRelation modelRelationOne,
 ModelEntity modelEntityOne,
 ModelRelation modelRelationTwo,
 ModelEntity modelEntityTwo,
 List<String> orderBy)
                                         throws GenericEntityException

Select by multi relation list.

Parameters:

value - the value

modelRelationOne - the model relation one

modelEntityOne - the model entity one

modelRelationTwo - the model relation two

modelEntityTwo - the model entity two

orderBy - the order by

Returns:

the list

Throws:

GenericEntityException - the generic entity exception

selectCountByCondition

public long selectCountByCondition(Delegator delegator,
 ModelEntity modelEntity,
 EntityCondition whereEntityCondition,
 EntityCondition havingEntityCondition,
 EntityFindOptions findOptions)
                            throws GenericEntityException

Select count by condition long.

Parameters:

delegator - the delegator

modelEntity - the model entity

whereEntityCondition - the where entity condition

havingEntityCondition - the having entity condition

findOptions - the find options

Returns:

the long

Throws:

GenericEntityException - the generic entity exception

selectCountByCondition

public long selectCountByCondition(Delegator delegator,
 ModelEntity modelEntity,
 EntityCondition whereEntityCondition,
 EntityCondition havingEntityCondition,
 List<ModelField> selectFields,
 EntityFindOptions findOptions)
                            throws GenericEntityException

Select count by condition long.

Parameters:

delegator - the delegator

modelEntity - the model entity

whereEntityCondition - the where entity condition

havingEntityCondition - the having entity condition

selectFields - the select fields

findOptions - the find options

Returns:

the long

Throws:

GenericEntityException - the generic entity exception

delete

public int delete(GenericEntity entity)
           throws GenericEntityException

Delete int.

Parameters:

entity - the entity

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

delete

public int delete(GenericEntity entity,
 SQLProcessor sqlP)
           throws GenericEntityException

Delete int.

Parameters:

entity - the entity

sqlP - the sql p

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

deleteByCondition

public int deleteByCondition(Delegator delegator,
 ModelEntity modelEntity,
 EntityCondition condition)
                      throws GenericEntityException

Delete by condition int.

Parameters:

delegator - the delegator

modelEntity - the model entity

condition - the condition

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

deleteByCondition

public int deleteByCondition(ModelEntity modelEntity,
 EntityCondition condition,
 SQLProcessor sqlP)
                      throws GenericEntityException

Delete by condition int.

Parameters:

modelEntity - the model entity

condition - the condition

sqlP - the sql p

Returns:

the int

Throws:

GenericEntityException - the generic entity exception

checkDb

public void checkDb(Map<String,ModelEntity> modelEntities,
 List<String> messages,
 boolean addMissing)

Check db.

Parameters:

modelEntities - the model entities

messages - the messages

addMissing - the add missing

induceModelFromDb

public List<ModelEntity> induceModelFromDb(Collection<String> messages)

Creates a list of ModelEntity objects based on meta data from the database