public abstract Class ObjectBuildingQuery

Overrides org.eclipse.persistence.queries.DatabaseQuery.clone.

INTERNAL: Clone the query

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

Overrides org.eclipse.persistence.queries.DatabaseQuery.convertClassNamesToClasses.

INTERNAL: Convert all the class-name-based settings in this query to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

Annotations

@Override

Overrides org.eclipse.persistence.queries.ReadQuery.copyFromQuery.

INTERNAL: Copy all setting from the query. This is used to morph queries from one type to the other. By default this calls prepareFromQuery, but additional properties may be required to be copied as prepareFromQuery only copies properties that affect the SQL.

Annotations

@Override

INTERNAL: Clone the query, including its selection criteria.

Normally selection criteria are not cloned here as they are cloned later on during prepare.

PUBLIC: When unset means perform read normally and dont do refresh.

PUBLIC: When unset means perform read normally and dont do refresh.

INTERNAL: Return all of the rows fetched by the query, used for 1-m joining.

INTERNAL: Returns FetchGroup that will be applied to the query. Note that the returned fetchGroup may be updated during preProcess.

INTERNAL: Returns FetchGroup that will be applied to the query. Note that the returned fetchGroup may be updated during preProcess.

INTERNAL: Return the time this query actually went to the database

Return the load group set in the query.

PUBLIC: Return the current locking mode.

Overrides org.eclipse.persistence.queries.DatabaseQuery.getReferenceClass.

PUBLIC: Return the reference class of the query.

Annotations

@Override

Overrides org.eclipse.persistence.queries.DatabaseQuery.getReferenceClassName.

INTERNAL: Return the reference class of the query.

Annotations

@Override

INTERNAL: Indicates whether a FetchGroup will be applied to the query.

INTERNAL: Return if partial attributes.

INTERNAL: Return if the attribute is specified for joining.

INTERNAL: Returns true if an early return cache check was completed

INTERNAL: Helper method that checks if clone has been locked with uow.

INTERNAL: Helper method to determine the default mode. If true and quey has a pessimistic locking policy, locking will be configured according to the pessimistic locking policy.

PUBLIC: Answers if the query lock mode is known to be LOCK or LOCK_NOWAIT. In the case of DEFAULT_LOCK_MODE and the query reference class being a CMP entity bean, at execution time LOCK, LOCK_NOWAIT, or NO_LOCK will be decided.

If a single joined attribute was configured for pessimistic locking then this will return true (after first execution) as the SQL contained a FOR UPDATE OF clause.

Overrides org.eclipse.persistence.queries.DatabaseQuery.isObjectBuildingQuery.

PUBLIC: Return if this is an object building query.

Annotations

@Override

INTERNAL: Answers if we are executing through a UnitOfWork and registering results. This is only ever false if using the conforming without registering feature.

Post process the object once it is registered in the unit of work.

Overrides org.eclipse.persistence.queries.DatabaseQuery.prepareFromQuery.

INTERNAL: Prepare the query from the prepared query. This allows a dynamic query to prepare itself directly from a prepared query instance. This is used in the EJBQL parse cache to allow preparsed queries to be used to prepare dynamic queries. This only copies over properties that are configured through EJBQL.

Annotations

@Override

INTERNAL: Indicates whether the query will change the way that inner joins are printed in generated SQL for the database. With a value of true, inner joins are printed in the WHERE clause, if false, inner joins are printed in the FROM clause.

INTERNAL: Helper method that records clone with uow if query is pessimistic locking.

PUBLIC: Refresh the attributes of the object(s) resulting from the query. If cascading is used the private parts of the objects will also be refreshed.

PUBLIC: Refresh the attributes of the object(s) resulting from the query. If cascading is used the private parts of the objects will also be refreshed.

INTERNAL: Constructs the final (registered) object for every individual object queried via a UnitOfWork.

Called for every object in a read all, the object in a read object, and every time the next or previous row is retrieved from a cursor.

The (conform) without registering feature is implemented here, and may return an original non UnitOfWork registered result.

Pessimistically locked objects are tracked here.

Returns:Object

a refreshed UnitOfWork queried object, unwrapped.

INTERNAL: When reading across relationships, queries may be set to acquire deferred locks This is used to ensure any Eagerly fetched object that is the target of a relationship with an object the acquires deferred locks behaves the same as its owner

INTERNAL: Set the the time this query went to the database.

PUBLIC: Sets whether this is a pessimistically locking query.

• ObjectBuildingQuery.LOCK: SELECT .... FOR UPDATE issued.
• ObjectBuildingQuery.LOCK_NOWAIT: SELECT .... FOR UPDATE NO WAIT issued.
• ObjectBuildingQuery.NO_LOCK: no pessimistic locking.
• ObjectBuildingQuery.DEFAULT_LOCK_MODE (default) and you have a CMP descriptor: fine grained locking will occur.

Fine Grained Locking: On execution the reference class and those of all joined attributes will be checked. If any of these have a PessimisticLockingPolicy set on their descriptor, they will be locked in a SELECT ... FOR UPDATE OF ... {NO WAIT}. Issues fewer locks and avoids setting the lock mode on each query.

Example:readAllQuery.setSelectionCriteria(employee.get("address").equal("Ottawa"));

• LOCK: all employees in Ottawa and all referenced Ottawa addresses will be locked.
• DEFAULT_LOCK_MODE: if address is a joined attribute, and only address has a pessimistic locking policy, only referenced Ottawa addresses will be locked.

See Also

org.eclipse.persistence.descriptors.PessimisticLockingPolicy

INTERNAL: Set a flag that indicates whether the query will change the way that inner joins are printed in generated SQL for the database. With a value of true, inner joins are printed in the WHERE clause, if false, inner joins are printed in the FROM clause.

REQUIRED: Set the reference class for the query.

INTERNAL: Set the reference class for the query.

INTERNAL: When reading across relationships, queries may be set to acquire deferred locks This is used to ensure any Eagerly fetched object that is the target of a relationship with an object the acquires deferred locks behaves the same as its owner

INTERNAL: If primary key is null ObjectBuilder.buildObject returns null in case this flag is set to true (instead of throwing exception).

PUBLIC: Set if the attributes of the object(s) resulting from the query should be refreshed. If cascading is used the private parts of the objects will also be refreshed.

PUBLIC: Set if the attributes of the object(s) resulting from the query should be refreshed. If cascading is used the private parts of the objects will also be refreshed.

INTERNAL: Set to false to have queries conform to a UnitOfWork without registering any additional objects not already in that UnitOfWork.

See Also

shouldRegisterResultsInUnitOfWork

ADVANCED: If the user has isolated data and specified that the client session should use an exclusive connection then by setting this condition to true EclipseLink will ensure that the query is executed through the exclusive connection. This may be required in certain cases. An example being where database security will prevent a query joining to a secure table from returning the correct results when executed through the shared connection.

INTERNAL: If primary key is null ObjectBuilder.buildObject returns null in case this flag is set to true (instead of throwing exception).

INTERNAL: Return if this is a full object query, not partial nor fetch group.

INTERNAL: Check if the mapping is part of the partial attributes.

PUBLIC: Set to a boolean. When set means refresh the instance variables of referenceObject from the database.

PUBLIC: Set to a boolean. When set means refresh the instance variables of referenceObject from the database.

INTERNAL: Allows one to do conforming in a UnitOfWork without registering. Queries executed on a UnitOfWork will only return working copies for objects that have already been registered.

Extreme care should be taken in using this feature, for a user will get back a mix of registered and original (unregistered) objects.

Best used with a WrapperPolicy where invoking on an object will trigger its registration (CMP). Without a WrapperPolicy registerExistingObject should be called on any object that you intend to change.

Returns:boolean

true by default.

See Also

setShouldRegisterResultsInUnitOfWork

ADVANCED: If the user has isolated data and specified that the client session should use an exclusive connection then by setting this condition to true EclipseLink will ensure that the query is executed through the exclusive connection. This may be required in certain cases. An example being where database security will prevent a query joining to a secure table from returning the correct results when executed through the shared connection.

INTERNAL: Indicates whether the query should use SerializedObjectPolicy if descriptor has it.

INTERNAL: Return if the query uses ResultSet optimization.