Class DefaultOfBizDelegator
- All Implemented Interfaces:
- OfBizDelegator
- 
Field SummaryFields inherited from interface com.atlassian.jira.ofbiz.OfBizDelegatorISSUE_LINK, ISSUE_LINK_TYPE, PROJECT_COMPONENT, VERSION
- 
Constructor SummaryConstructorsConstructorDescriptionDefaultOfBizDelegator(org.ofbiz.core.entity.DelegatorInterface delegatorInterface) 
- 
Method SummaryModifier and TypeMethodDescriptionintbulkCopyColumnValuesByAnd(String entityName, Map updateColumns, Map criteria) This can be used to perform an update on the entityName of all the rows identified by AND criteria of the fields specified by the criteria map.intThis can be used to perform an update on the entityName of all the rows identified by AND criteria of the fields specified by the criteria map.intThis can be used to perform an update on the entityName of all the rows identified by the keys with the values stored in the updateValues.org.ofbiz.core.entity.GenericValuecreateValue(String entityName, Map<String, Object> fields) Creates a new GenericValue, and persists it.voidcreateValueWithoutId(String entityName, Map<String, Object> fields) Creates a new GenericValue, and persists it without trying to automatically populate the ID column.List<org.ofbiz.core.entity.GenericValue> List<org.ofbiz.core.entity.GenericValue> List<org.ofbiz.core.entity.GenericValue> List<org.ofbiz.core.entity.GenericValue> Finds GenericValue records by all of the specified fields (ie: combined using AND).List<org.ofbiz.core.entity.GenericValue> List<org.ofbiz.core.entity.GenericValue> findByCondition(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, Collection<String> fieldsToSelect) Finds GenericValues by the conditions specified in the EntityCondition object with no specified order.List<org.ofbiz.core.entity.GenericValue> findByCondition(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, Collection<String> fieldsToSelect, List<String> orderBy) Finds GenericValues by the conditions specified in the EntityCondition object.List<org.ofbiz.core.entity.GenericValue> findByField(String entityName, String fieldName, Object fieldValue) Finds GenericValue records by the specified field value.List<org.ofbiz.core.entity.GenericValue> findByField(String entityName, String fieldName, Object fieldValue, String orderBy) Finds GenericValue records by the specified field value.org.ofbiz.core.entity.GenericValueFind a Generic Entity by its numeric ID.List<org.ofbiz.core.entity.GenericValue> findByLike(String s, Map<String, ?> map) List<org.ofbiz.core.entity.GenericValue> List<org.ofbiz.core.entity.GenericValue> org.ofbiz.core.entity.GenericValuefindByPrimaryKey(String entityName, Long id) Find a Generic Entity by its single numeric Primary Key.org.ofbiz.core.entity.GenericValuefindByPrimaryKey(String entityName, Map<String, ?> fields) Find a Generic Entity by its Primary Key.findListIteratorByCondition(String entityType, org.ofbiz.core.entity.EntityCondition condition) Returns a new OfBizListIterator.findListIteratorByCondition(String entityName, org.ofbiz.core.entity.EntityCondition whereEntityCondition, org.ofbiz.core.entity.EntityCondition havingEntityCondition, Collection fieldsToSelect, List orderBy, org.ofbiz.core.entity.EntityFindOptions entityFindOptions) Always close the iterator returned from this method when finished.longRuns aCOUNT *query over the given entity.longgetCountByAnd(String entityName, Map<String, ?> fields) Runs aCOUNT *query over the given entity with someWHEREconditions.longgetCountByAnd(String entityName, org.ofbiz.core.entity.EntityCondition condition) Runs aCOUNT *query over the given entity with someWHEREconditions.org.ofbiz.core.entity.DelegatorInterfaceReturns the underlying raw Entity Engine DelegatorInterface.org.ofbiz.core.entity.model.ModelReaderReturns a model reader that can be used to retrieve all the different entitynames configured in the entitymodel.static intList<org.ofbiz.core.entity.GenericValue> getRelated(String relationName, org.ofbiz.core.entity.GenericValue gv) List<org.ofbiz.core.entity.GenericValue> getRelated(String relationName, org.ofbiz.core.entity.GenericValue gv, List<String> orderBy) org.ofbiz.core.entity.GenericValueCreates an Entity in the form of a GenericValue without persisting it.org.ofbiz.core.entity.GenericValueCreates an Entity in the form of a GenericValue without persisting it.voidRefreshes the sequencer that is used to retrieve unique IDs in the database.voidintremoveByAnd(String entityName, Map map) intremoveByCondition(String entityName, org.ofbiz.core.entity.EntityCondition condition) intremoveById(String entityName, Long id) Remove the given entity from the DB.intremoveByOr(String entityName, String entityId, List<Long> ids) This can be used to remove rows for a given entity based onentityNameand whereentityIdinvalid input: '<'/qbooleanremoveRelated(String relationName, org.ofbiz.core.entity.GenericValue schemeGv) Remove all the entities related to the passed generic value via the passed relationship name.intremoveValue(org.ofbiz.core.entity.GenericValue value) voidstore(org.ofbiz.core.entity.GenericValue gv) voidList<org.ofbiz.core.entity.GenericValue> transform(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, List<String> orderBy, String lockField, org.ofbiz.core.entity.Transformation transformation) Applies the given transformation to any entities matching the given condition.org.ofbiz.core.entity.GenericValuetransformOne(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, String lockField, org.ofbiz.core.entity.Transformation transformation) Applies the given transformation to the entity matching the given condition.
- 
Constructor Details- 
DefaultOfBizDelegatorpublic DefaultOfBizDelegator(org.ofbiz.core.entity.DelegatorInterface delegatorInterface) 
 
- 
- 
Method Details- 
getQueryBatchSizepublic static int getQueryBatchSize()
- 
findByFieldpublic List<org.ofbiz.core.entity.GenericValue> findByField(String entityName, String fieldName, Object fieldValue) Description copied from interface:OfBizDelegatorFinds GenericValue records by the specified field value.- Specified by:
- findByFieldin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- fieldName- The field to do filtering by.
- fieldValue- The desired value for the filtering field.
- Returns:
- List of GenericValue instances that match the query
 
- 
findByFieldpublic List<org.ofbiz.core.entity.GenericValue> findByField(String entityName, String fieldName, Object fieldValue, String orderBy) Description copied from interface:OfBizDelegatorFinds GenericValue records by the specified field value.- Specified by:
- findByFieldin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- fieldName- The field to do filtering by.
- fieldValue- The desired value for the filtering field.
- orderBy- Single field to order by.
- Returns:
- List of GenericValue instances that match the query
 
- 
findByAndpublic List<org.ofbiz.core.entity.GenericValue> findByAnd(String entityName, Map<String, ?> fields) throws DataAccessExceptionDescription copied from interface:OfBizDelegatorFinds GenericValue records by all of the specified fields (ie: combined using AND).- Specified by:
- findByAndin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- fields- The fields of the named entity to query by with their corresponding values
- Returns:
- List of GenericValue instances that match the query
- Throws:
- DataAccessException- If an error occurs in the persistence layer.
 
- 
findByAndpublic List<org.ofbiz.core.entity.GenericValue> findByAnd(String entityName, Map<String, ?> fields, List<String> orderBy) throws DataAccessException- Specified by:
- findByAndin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findByAndpublic List<org.ofbiz.core.entity.GenericValue> findByAnd(String entityName, List<org.ofbiz.core.entity.EntityCondition> expressions) throws DataAccessException - Specified by:
- findByAndin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findByOrpublic List<org.ofbiz.core.entity.GenericValue> findByOr(String entityName, List expressions, List orderBy) throws DataAccessException - Specified by:
- findByOrin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findByLikepublic List<org.ofbiz.core.entity.GenericValue> findByLike(String s, Map<String, ?> map) throws DataAccessException- Specified by:
- findByLikein interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findByLikepublic List<org.ofbiz.core.entity.GenericValue> findByLike(String s, Map<String, ?> map, List<String> orderBy) throws DataAccessException- Specified by:
- findByLikein interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
removeAllpublic void removeAll(List<org.ofbiz.core.entity.GenericValue> genericValues) throws DataAccessException - Specified by:
- removeAllin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
removeByConditionpublic int removeByCondition(String entityName, org.ofbiz.core.entity.EntityCondition condition) throws DataAccessException - Specified by:
- removeByConditionin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findByConditionpublic List<org.ofbiz.core.entity.GenericValue> findByCondition(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, Collection<String> fieldsToSelect) Description copied from interface:OfBizDelegatorFinds GenericValues by the conditions specified in the EntityCondition object with no specified order.Convenience method for calling OfBizDelegator.findByCondition(String, EntityCondition, Collection, List)with an empty orderBy list.- Specified by:
- findByConditionin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity model XML file
- entityCondition- The EntityCondition object that specifies how to constrain this query
- fieldsToSelect- The fields of the named entity to get from the database; if empty or null all fields will be retreived
- Returns:
- List of GenericValue objects representing the search results
 
- 
findByConditionpublic List<org.ofbiz.core.entity.GenericValue> findByCondition(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, Collection<String> fieldsToSelect, List<String> orderBy) Description copied from interface:OfBizDelegatorFinds GenericValues by the conditions specified in the EntityCondition object.- Specified by:
- findByConditionin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity model XML file
- entityCondition- The EntityCondition object that specifies how to constrain this query
- 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
- Returns:
- List of GenericValue objects representing the search results
 
- 
removeByOrpublic int removeByOr(String entityName, String entityId, List<Long> ids) throws DataAccessException, org.ofbiz.core.entity.GenericModelException Description copied from interface:OfBizDelegatorThis can be used to remove rows for a given entity based onentityNameand whereentityIdinvalid input: '<'/q- Specified by:
- removeByOrin interface- OfBizDelegator
- Parameters:
- entityName- identifies the table to perform the remove on.
- entityId- the Ofbiz fieldName to be used for the identifier, eg WHERE fieldName IN (...). Must be the same case as that found in entitymodel.xml.
- ids- a list of entity IDs of the rows to be removed
- Returns:
- number of rows removed
- Throws:
- DataAccessException- if there are problems executing/accessing the data store
- org.ofbiz.core.entity.GenericModelException- if the given entityId is not valid for the given entity
 
- 
removeByAnd- Specified by:
- removeByAndin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
removeByIdDescription copied from interface:OfBizDelegatorRemove the given entity from the DB.- Specified by:
- removeByIdin interface- OfBizDelegator
- Parameters:
- entityName- the entity type (ie TABLE)
- id- the id of the row to delete.
- Returns:
- number of rows effected by this operation
 
- 
removeValue- Specified by:
- removeValuein interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
storeAll- Specified by:
- storeAllin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
findAll- Specified by:
- findAllin interface- OfBizDelegator
 
- 
findAllpublic List<org.ofbiz.core.entity.GenericValue> findAll(String s, List sortOrder) throws DataAccessException - Specified by:
- findAllin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
store- Specified by:
- storein interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
createValueDescription copied from interface:OfBizDelegatorCreates a new GenericValue, and persists it.If there is no "id" in the field values, one is created using the entity sequence. - Specified by:
- createValuein interface- OfBizDelegator
- Parameters:
- entityName- the entity name.
- fields- field values
- Returns:
- The new GenericValue.
- See Also:
 
- 
createValueWithoutIdpublic void createValueWithoutId(String entityName, Map<String, Object> fields) throws DataAccessExceptionDescription copied from interface:OfBizDelegatorCreates a new GenericValue, and persists it without trying to automatically populate the ID column.Use this for entities that don't have a numeric ID column. - Specified by:
- createValueWithoutIdin interface- OfBizDelegator
- Parameters:
- entityName- the entity name.
- fields- field values
- Throws:
- DataAccessException- if an error occurs in the Database layer
- See Also:
 
- 
makeValueDescription copied from interface:OfBizDelegatorCreates an Entity in the form of a GenericValue without persisting it.- Specified by:
- makeValuein interface- OfBizDelegator
- Parameters:
- entityName- the entity name.
- Returns:
- The new GenericValue.
- See Also:
 
- 
makeValueDescription copied from interface:OfBizDelegatorCreates an Entity in the form of a GenericValue without persisting it.- Specified by:
- makeValuein interface- OfBizDelegator
- Parameters:
- entityName- the entity name.
- fields- initial field values
- Returns:
- The new GenericValue.
- See Also:
 
- 
findByIdpublic org.ofbiz.core.entity.GenericValue findById(String entityName, Long id) throws DataAccessException Description copied from interface:OfBizDelegatorFind a Generic Entity by its numeric ID.This method is a synonym for OfBizDelegator.findByPrimaryKey(String, Long)- Specified by:
- findByIdin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- id- The numeric "id" field value that is the primary key of this entity.
- Returns:
- The GenericValue corresponding to the ID
- Throws:
- DataAccessException- DataAccessException
 
- 
findByPrimaryKeyDescription copied from interface:OfBizDelegatorFind a Generic Entity by its single numeric Primary Key.This method is a convenience for entities with a numeric primary key on single field called "id". This is the case for most JIRA entities. - Specified by:
- findByPrimaryKeyin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- id- The numeric "id" field value that is the primary key of this entity.
- Returns:
- The GenericValue corresponding to the primary key
- See Also:
 
- 
findByPrimaryKeyDescription copied from interface:OfBizDelegatorFind a Generic Entity by its Primary Key.- Specified by:
- findByPrimaryKeyin interface- OfBizDelegator
- Parameters:
- entityName- The Name of the Entity as defined in the entity XML file
- fields- The field/value pairs of the primary key (in JIRA, mostly just a single field "id")
- Returns:
- The GenericValue corresponding to the primary key
- See Also:
 
- 
getRelatedpublic List<org.ofbiz.core.entity.GenericValue> getRelated(String relationName, org.ofbiz.core.entity.GenericValue gv) - Specified by:
- getRelatedin interface- OfBizDelegator
 
- 
getRelatedpublic List<org.ofbiz.core.entity.GenericValue> getRelated(String relationName, org.ofbiz.core.entity.GenericValue gv, List<String> orderBy) throws DataAccessException - Specified by:
- getRelatedin interface- OfBizDelegator
- Throws:
- DataAccessException
 
- 
getCountDescription copied from interface:OfBizDelegatorRuns aCOUNT *query over the given entity.Ensure that there is a view-entity defined in entitymodel.xmlandentitygroup.xmlfor the entity you are calling this method with, and that the view-entity is named correctly! The view-entity must be named the name of the normal entity with"Count"appended. For example, for the"Issue"entity, the view-entity must be called"IssueCount". Otherwise an exception will be thrown.For JIRA core developers, see EntityEngine'sSelectfactory for a more flexible alternative, including the ability to terminate queries with.count()instead of.asList()to accomplish a count without creating a special view entity for that purpose. For app developers, this can only be done directly through the lower levelDelegatorInterfaceat this time.- Specified by:
- getCountin interface- OfBizDelegator
- Parameters:
- entityName- entity name
- Returns:
- count
 
- 
getCountByAndDescription copied from interface:OfBizDelegatorRuns aCOUNT *query over the given entity with someWHEREconditions.In addition to the restrictions given for OfBizDelegator.getCount(String), the view-entity will need to define any columns that you wish to use in the where clause.- Specified by:
- getCountByAndin interface- OfBizDelegator
- Parameters:
- entityName- entity name
- fields- The fields of the named entity to query by with their corresponding values
- Returns:
- count
- See Also:
 
- 
getCountByAndDescription copied from interface:OfBizDelegatorRuns aCOUNT *query over the given entity with someWHEREconditions.In addition to the restrictions given for OfBizDelegator.getCount(String), the view-entity will need to define any columns that you wish to use in the where clause.- Specified by:
- getCountByAndin interface- OfBizDelegator
- Parameters:
- entityName- entity name
- condition- The EntityCondition object that specifies how to constrain this query
- Returns:
- count
- See Also:
 
- 
findListIteratorByConditionpublic OfBizListIterator findListIteratorByCondition(String entityType, org.ofbiz.core.entity.EntityCondition condition) Description copied from interface:OfBizDelegatorReturns a new OfBizListIterator.IMPORTANT: the returned iterator needs to be properly closed in a finallyblock to avoid connection leaks.- Specified by:
- findListIteratorByConditionin interface- OfBizDelegator
 
- 
findListIteratorByConditionpublic OfBizListIterator findListIteratorByCondition(String entityName, org.ofbiz.core.entity.EntityCondition whereEntityCondition, org.ofbiz.core.entity.EntityCondition havingEntityCondition, Collection fieldsToSelect, List orderBy, org.ofbiz.core.entity.EntityFindOptions entityFindOptions) Always close the iterator returned from this method when finished.- Specified by:
- findListIteratorByConditionin interface- OfBizDelegator
- Returns:
- OfBizListIterator
 
- 
bulkUpdateByPrimaryKeyDescription copied from interface:OfBizDelegatorThis can be used to perform an update on the entityName of all the rows identified by the keys with the values stored in the updateValues.- Specified by:
- bulkUpdateByPrimaryKeyin interface- OfBizDelegator
- Parameters:
- entityName- identifies the table to perform the update on.
- updateValues- is a map where the key is the fieldName and the value is the value to update the column to.
- keys- is a list of Long values that represent the primary keys of the the where clause.
- Returns:
- the number of rows updated
 
- 
bulkUpdateByAndDescription copied from interface:OfBizDelegatorThis can be used to perform an update on the entityName of all the rows identified by AND criteria of the fields specified by the criteria map.- Specified by:
- bulkUpdateByAndin interface- OfBizDelegator
- Parameters:
- entityName- identifies the table to perform the update on.
- updateValues- is a map where the key is the fieldName and the value is the value to update the column to.
- criteria- map of field to value mapping that will be used to generate the where clause of the update SQL statement. Multiple entries in the map are joined using the AND operator.
- Returns:
- the number of rows updated
 
- 
bulkCopyColumnValuesByAndDescription copied from interface:OfBizDelegatorThis can be used to perform an update on the entityName of all the rows identified by AND criteria of the fields specified by the criteria map.- Specified by:
- bulkCopyColumnValuesByAndin interface- OfBizDelegator
- Parameters:
- entityName- table na,e
- updateColumns- map of update to - update from columns
- criteria- map of column names and their values that will create WHERE clause
- Returns:
- the number of rows updated
 
- 
getModelReaderpublic org.ofbiz.core.entity.model.ModelReader getModelReader()Description copied from interface:OfBizDelegatorReturns a model reader that can be used to retrieve all the different entitynames configured in the entitymodel.- Specified by:
- getModelReaderin interface- OfBizDelegator
- Returns:
- a ModelReader
 
- 
refreshSequencerpublic void refreshSequencer()Description copied from interface:OfBizDelegatorRefreshes the sequencer that is used to retrieve unique IDs in the database.- Specified by:
- refreshSequencerin interface- OfBizDelegator
 
- 
removeRelatedDescription copied from interface:OfBizDelegatorRemove all the entities related to the passed generic value via the passed relationship name.- Specified by:
- removeRelatedin interface- OfBizDelegator
- Parameters:
- relationName- the name of the relationship.
- schemeGv- the gv at the start of the relationship.
- Returns:
- true the database was changed, false otherwise.
 
- 
getDelegatorInterfacepublic org.ofbiz.core.entity.DelegatorInterface getDelegatorInterface()Description copied from interface:OfBizDelegatorReturns the underlying raw Entity Engine DelegatorInterface.- Specified by:
- getDelegatorInterfacein interface- OfBizDelegator
- Returns:
- the underlying raw Entity Engine DelegatorInterface.
 
- 
transformpublic List<org.ofbiz.core.entity.GenericValue> transform(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, List<String> orderBy, String lockField, org.ofbiz.core.entity.Transformation transformation) Description copied from interface:OfBizDelegatorApplies the given transformation to any entities matching the given condition.- Specified by:
- transformin interface- OfBizDelegator
- Parameters:
- entityName- the type of entity to transform (required)
- entityCondition- the condition that selects the entities to transform (null means transform all)
- orderBy- the order in which the entities should be selected for updating (null means no ordering)
- lockField- the entity field to use for optimistic locking; the value of this field will be read between the SELECT and the UPDATE to determine whether another process has updated one of the target records in the meantime; if so, the transformation will be reapplied and another UPDATE attempted
- transformation- the transformation to apply (required)
- Returns:
- the transformed entities in the order they were selected (never null)
 
- 
transformOnepublic org.ofbiz.core.entity.GenericValue transformOne(String entityName, org.ofbiz.core.entity.EntityCondition entityCondition, String lockField, org.ofbiz.core.entity.Transformation transformation) Description copied from interface:OfBizDelegatorApplies the given transformation to the entity matching the given condition.- Specified by:
- transformOnein interface- OfBizDelegator
- Parameters:
- entityName- the type of entity to transform (required)
- entityCondition- the condition that selects the entity to transform (must select one entity)
- lockField- the entity field to use for optimistic locking; the value of this field will be read between the SELECT and the UPDATE to determine whether another process has updated one of the target records in the meantime; if so, the transformation will be reapplied and another UPDATE attempted
- transformation- the transformation to apply (required)
- Returns:
- the transformed entity (never null)
 
 
-