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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	module

Constructor Summary

Constructors

Constructor and Description
GenericDAO(GenericHelperInfo helperInfo)

Method Summary

Modifier and Type	Method and Description
void	checkDb(Map<String,ModelEntity> modelEntities, List<String> messages, boolean addMissing)
int	delete(GenericEntity entity)
int	delete(GenericEntity entity, SQLProcessor sqlP)
int	deleteByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition condition)
int	deleteByCondition(ModelEntity modelEntity, EntityCondition condition, SQLProcessor sqlP)
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)
protected StringBuilder	makeConditionHavingString(ModelEntity modelEntity, EntityCondition havingEntityCondition, List<EntityCondition> viewHavingConditions, List<EntityConditionParam> havingEntityConditionParams) Deprecated.
protected StringBuilder	makeConditionHavingString(StringBuilder havingString, String prefix, ModelEntity modelEntity, EntityCondition havingEntityCondition, List<EntityCondition> viewHavingConditions, List<EntityConditionParam> havingEntityConditionParams)
protected StringBuilder	makeConditionWhereString(ModelEntity modelEntity, EntityCondition whereEntityCondition, List<EntityCondition> viewWhereConditions, List<EntityConditionParam> whereEntityConditionParams) Deprecated.
protected StringBuilder	makeConditionWhereString(StringBuilder whereString, String prefix, ModelEntity modelEntity, EntityCondition whereEntityCondition, List<EntityCondition> viewWhereConditions, List<EntityConditionParam> whereEntityConditionParams)
protected StringBuilder	makeOffsetString(StringBuilder offsetString, EntityFindOptions findOptions)
void	partialSelect(GenericEntity entity, Set<String> keys)
void	select(GenericEntity entity)
void	select(GenericEntity entity, SQLProcessor sqlP)
List<GenericValue>	selectByMultiRelation(GenericValue value, ModelRelation modelRelationOne, ModelEntity modelEntityOne, ModelRelation modelRelationTwo, ModelEntity modelEntityTwo, List<String> orderBy)
long	selectCountByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, EntityFindOptions findOptions)
long	selectCountByCondition(Delegator delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition, EntityCondition havingEntityCondition, List<ModelField> selectFields, EntityFindOptions findOptions)
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)
int	updateAll(GenericEntity entity)
int	updateByCondition(Delegator delegator, ModelEntity modelEntity, Map<String,? extends Object> fieldsToSet, EntityCondition condition)
int	updateByCondition(ModelEntity modelEntity, Map<String,? extends Object> fieldsToSet, EntityCondition condition, SQLProcessor sqlP)

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final String module

Constructor Detail

GenericDAO

public GenericDAO(GenericHelperInfo helperInfo)

Method Detail

getGenericDAO

public static GenericDAO getGenericDAO(GenericHelperInfo helperInfo)

insert

public int insert(GenericEntity entity)
           throws GenericEntityException

Throws:

GenericEntityException

updateAll

public int updateAll(GenericEntity entity)
              throws GenericEntityException

Throws:

GenericEntityException

update

public int update(GenericEntity entity)
           throws GenericEntityException

Throws:

GenericEntityException

updateByCondition

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

Throws:

GenericEntityException

updateByCondition

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

Throws:

GenericEntityException

select

public void select(GenericEntity entity)
            throws GenericEntityException

Throws:

GenericEntityException

select

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

Throws:

GenericEntityException

partialSelect

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

Throws:

GenericEntityException

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.

Throws:

GenericEntityException

makeConditionWhereString

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

Throws:

GenericEntityException

makeConditionHavingString

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

Deprecated.

Throws:

GenericEntityException

makeConditionHavingString

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

Throws:

GenericEntityException

makeOffsetString

protected StringBuilder makeOffsetString(StringBuilder offsetString,
                                         EntityFindOptions findOptions)

selectByMultiRelation

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

Throws:

GenericEntityException

selectCountByCondition

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

Throws:

GenericEntityException

selectCountByCondition

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

Throws:

GenericEntityException

delete

public int delete(GenericEntity entity)
           throws GenericEntityException

Throws:

GenericEntityException

delete

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

Throws:

GenericEntityException

deleteByCondition

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

Throws:

GenericEntityException

deleteByCondition

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

Throws:

GenericEntityException

checkDb

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

induceModelFromDb

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

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