EclipseLink Core 4.0.2 · org.eclipse.persistence.queries.UpdateAllQuery

PUBLIC: A Query Class used to perform a bulk update using TopLink's expression framework. This class is provided to help optimize performance. It can be used in place of reading in all the objects to be changed and issuing single updates per instance. With this approach a single SQL UPDATE statement can be issued and then, based on the Expression provided, any objects in the cache that are effected by the update can be invalidated.

Notes:

By default, if a UOW is being used, this query will be deferred until the UOW commits.
UpdateAllQuery does not support foreign key updates unless the relationship is 1-1 (without back pointers.)

Example of Usage: Adding an area code.
UpdateAllQuery updateQuery = new UpdateAllQuery(Employee.class); updateQuery.setSelectionCriteria(eb.get("areaCode").isNull()); updateQuery.addUpdate(eb.get("areaCode"), "613");

Field Summary

Modifier and Type	Field and Description
protected HashMap<K, V>	m_updateClauses

Inherited from org.eclipse.persistence.queries.ModifyAllQuery:: defaultBuilder INVALIDATE_CACHE isPreparedUsingTempStorage NO_CACHE referenceClass referenceClassName result

Constructor Summary

Access	Constructor and Description
public	UpdateAllQuery() PUBLIC: Constructs a default update all query.
public	UpdateAllQuery(Class<?> Class referenceClass) PUBLIC: Constructs an update all query for the Class type specified.
public	UpdateAllQuery(Class<?> Class type to be considered referenceClass, Expression Expression selectionCriteria) PUBLIC: Constructs an update all query for the specified Class type and selection criteria.
public	UpdateAllQuery(Class<?> Class type to be considered referenceClass, ExpressionBuilder ExpressionBuilder expressionBuilder) PUBLIC: Constructs an update all query for the Class type specified and the given ExpressionBuilder.

Method Summary

Modifier and Type	Method and Description
public void	addUpdate(Expression Expression Object level representation of a database query 'where' clause field, Object Object, the new value value) PUBLIC: Adds the update (SET) clause to the query.
public void	addUpdate(String String, the name of the attribute attributeName, Object Object, the new value value) PUBLIC: Adds the update (SET) clause to the query.
public void	addUpdate(Expression Expression, representation of a database query 'where' clause that describes the field field, Expression Expression, representation of a database query 'where' clause that describes the new value value) PUBLIC: Adds the update (SET) clause to the query.
public void	addUpdate(String String, the name of the attribute attributeName, Expression Expression, the new value value) PUBLIC: Adds the update (SET) clause to the query.
protected void	addUpdateInternal(Object fieldObject, Object valueObject) INTERNAL:
public Object	executeDatabaseQuery() Implements abstract org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery. INTERNAL: Issue the SQL to the database and then merge into the cache.
protected QueryRedirector	getDefaultRedirector() Overrides org.eclipse.persistence.queries.DatabaseQuery.getDefaultRedirector. INTERNAL: Returns the specific default redirector for this query type.
public HashMap<K, V>	getUpdateClauses() INTERNAL: Return the updates stored for an update all query
protected void	initializeQuerySpecificDefaultBuilder() Overrides org.eclipse.persistence.queries.ModifyAllQuery.initializeQuerySpecificDefaultBuilder. INTERNAL: Initialize the expression builder which should be used for this query.
public boolean	isUpdateAllQuery() Overrides org.eclipse.persistence.queries.DatabaseQuery.isUpdateAllQuery. INTERNAL: Return true if this is an update all query.
protected void	prepare() Overrides org.eclipse.persistence.queries.DatabaseQuery.prepare. INTERNAL:

Field Detail

m_updateClauses	back to summary
protected HashMap<K, V> m_updateClauses

Constructor Detail

UpdateAllQuery	back to summary
public UpdateAllQuery() PUBLIC: Constructs a default update all query.

UpdateAllQuery	back to summary
public UpdateAllQuery(Class<?> referenceClass) PUBLIC: Constructs an update all query for the Class type specified. Parameters referenceClass:Class<?> Class

UpdateAllQuery

back to summary

public UpdateAllQuery(Class<?> referenceClass)

PUBLIC: Constructs an update all query for the Class type specified.

Parameters

referenceClass:Class<?>: Class

UpdateAllQuery	back to summary
public UpdateAllQuery(Class<?> referenceClass, Expression selectionCriteria) PUBLIC: Constructs an update all query for the specified Class type and selection criteria. Parameters referenceClass:Class<?> Class type to be considered selectionCriteria:Expression Expression

UpdateAllQuery

back to summary

public UpdateAllQuery(Class<?> referenceClass, Expression selectionCriteria)

PUBLIC: Constructs an update all query for the specified Class type and selection criteria.

Parameters

referenceClass:Class<?>: Class type to be considered
selectionCriteria:Expression: Expression

UpdateAllQuery	back to summary
public UpdateAllQuery(Class<?> referenceClass, ExpressionBuilder expressionBuilder) PUBLIC: Constructs an update all query for the Class type specified and the given ExpressionBuilder. This sets the default builder which is used for all associated expressions in the query. Parameters referenceClass:Class<?> Class type to be considered expressionBuilder:ExpressionBuilder ExpressionBuilder

UpdateAllQuery

back to summary

public UpdateAllQuery(Class<?> referenceClass, ExpressionBuilder expressionBuilder)

PUBLIC: Constructs an update all query for the Class type specified and the given ExpressionBuilder. This sets the default builder which is used for all associated expressions in the query.

Parameters

referenceClass:Class<?>: Class type to be considered
expressionBuilder:ExpressionBuilder: ExpressionBuilder

Method Detail

addUpdate	back to summary
public void addUpdate(Expression field, Object value) PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder. Parameters field:Expression Expression Object level representation of a database query 'where' clause value:Object Object, the new value

addUpdate

back to summary

public void addUpdate(Expression field, Object value)

PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder.

Parameters

field:Expression: Expression Object level representation of a database query 'where' clause
value:Object: Object, the new value

addUpdate	back to summary
public void addUpdate(String attributeName, Object value) PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder. Parameters attributeName:String String, the name of the attribute value:Object Object, the new value

addUpdate

back to summary

public void addUpdate(String attributeName, Object value)

PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder.

Parameters

attributeName:String: String, the name of the attribute
value:Object: Object, the new value

addUpdate	back to summary
public void addUpdate(Expression field, Expression value) PUBLIC: Adds the update (SET) clause to the query. This method ensures that the builder has the session and reference class set for both given Expressions. Uses default ExpressionBuilder. Parameters field:Expression Expression, representation of a database query 'where' clause that describes the field value:Expression Expression, representation of a database query 'where' clause that describes the new value

addUpdate

back to summary

public void addUpdate(Expression field, Expression value)

PUBLIC: Adds the update (SET) clause to the query. This method ensures that the builder has the session and reference class set for both given Expressions. Uses default ExpressionBuilder.

Parameters

field:Expression: Expression, representation of a database query 'where' clause that describes the field
value:Expression: Expression, representation of a database query 'where' clause that describes the new value

addUpdate	back to summary
public void addUpdate(String attributeName, Expression value) PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder. Parameters attributeName:String String, the name of the attribute value:Expression Expression, the new value

addUpdate

back to summary

public void addUpdate(String attributeName, Expression value)

PUBLIC: Adds the update (SET) clause to the query. Uses default ExpressionBuilder.

Parameters

attributeName:String: String, the name of the attribute
value:Expression: Expression, the new value

addUpdateInternal	back to summary
protected void addUpdateInternal(Object fieldObject, Object valueObject) INTERNAL:

executeDatabaseQuery	back to summary
public Object executeDatabaseQuery() throws DatabaseException Implements abstract org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery. INTERNAL: Issue the SQL to the database and then merge into the cache. If we are within a UoW, the merge to the cache must not be done until the UoW merges into the parent. The UoW will trigger the merge to occur at the correct time and will ensure the cache setting is set to none at that time. Returns:Object Doc from org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery. - the result of executing the query. Annotations @Override Exceptions DatabaseException: Doc from org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery. - an error has occurred on the database.

executeDatabaseQuery

back to summary

public Object executeDatabaseQuery() throws DatabaseException

Implements abstract org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery.

INTERNAL: Issue the SQL to the database and then merge into the cache. If we are within a UoW, the merge to the cache must not be done until the UoW merges into the parent. The UoW will trigger the merge to occur at the correct time and will ensure the cache setting is set to none at that time.

Returns:Object

Doc from org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery.

- the result of executing the query.

Annotations

@Override

Exceptions

DatabaseException:

Doc from org.eclipse.persistence.queries.DatabaseQuery.executeDatabaseQuery.

- an error has occurred on the database.

getDefaultRedirector	back to summary
protected QueryRedirector getDefaultRedirector() Overrides org.eclipse.persistence.queries.DatabaseQuery.getDefaultRedirector. INTERNAL: Returns the specific default redirector for this query type. There are numerous default query redirectors. See ClassDescriptor for their types. Annotations @Override

getDefaultRedirector

back to summary

protected QueryRedirector getDefaultRedirector()

Overrides org.eclipse.persistence.queries.DatabaseQuery.getDefaultRedirector.

INTERNAL: Returns the specific default redirector for this query type. There are numerous default query redirectors. See ClassDescriptor for their types.

Annotations

@Override

getUpdateClauses	back to summary
public HashMap<K, V> getUpdateClauses() INTERNAL: Return the updates stored for an update all query

initializeQuerySpecificDefaultBuilder	back to summary
protected void initializeQuerySpecificDefaultBuilder() Overrides org.eclipse.persistence.queries.ModifyAllQuery.initializeQuerySpecificDefaultBuilder. INTERNAL: Initialize the expression builder which should be used for this query. If there is a where clause, use its expression builder. If after this method defaultBuilder is still null, then initializeDefaultBuilder method will generate and cache it. Annotations @Override

initializeQuerySpecificDefaultBuilder

back to summary

protected void initializeQuerySpecificDefaultBuilder()

Overrides org.eclipse.persistence.queries.ModifyAllQuery.initializeQuerySpecificDefaultBuilder.

INTERNAL: Initialize the expression builder which should be used for this query. If there is a where clause, use its expression builder. If after this method defaultBuilder is still null, then initializeDefaultBuilder method will generate and cache it.

Annotations

@Override

isUpdateAllQuery	back to summary
public boolean isUpdateAllQuery() Overrides org.eclipse.persistence.queries.DatabaseQuery.isUpdateAllQuery. INTERNAL: Return true if this is an update all query. Annotations @Override

isUpdateAllQuery

back to summary

public boolean isUpdateAllQuery()

Overrides org.eclipse.persistence.queries.DatabaseQuery.isUpdateAllQuery.

INTERNAL: Return true if this is an update all query.

Annotations

@Override

prepare	back to summary
protected void prepare() throws QueryException Overrides org.eclipse.persistence.queries.DatabaseQuery.prepare. INTERNAL: Annotations @Override

prepare

back to summary

protected void prepare() throws QueryException

Overrides org.eclipse.persistence.queries.DatabaseQuery.prepare.

INTERNAL:

Annotations

@Override

public Class UpdateAllQuery

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail