public class

JdoTemplate

extends JdoAccessor
implements JdoOperations
java.lang.Object
   ↳ org.springframework.orm.jdo.JdoAccessor
     ↳ org.springframework.orm.jdo.JdoTemplate

Class Overview

Helper class that simplifies JDO data access code, and converts JDOExceptions into Spring DataAccessExceptions, following the org.springframework.dao exception hierarchy.

The central method is execute, supporting JDO access code implementing the JdoCallback interface. It provides JDO PersistenceManager handling such that neither the JdoCallback implementation nor the calling code needs to explicitly care about retrieving/closing PersistenceManagers, or handling JDO lifecycle exceptions.

Typically used to implement data access or business logic services that use JDO within their implementation but are JDO-agnostic in their interface. The latter or code calling the latter only have to deal with business objects, query objects, and org.springframework.dao exceptions.

Can be used within a service implementation via direct instantiation with a PersistenceManagerFactory reference, or get prepared in an application context and given to services as bean reference. Note: The PersistenceManagerFactory should always be configured as bean in the application context, in the first case given to the service directly, in the second case to the prepared template.

This class can be considered as direct alternative to working with the raw JDO PersistenceManager API (through PersistenceManagerFactoryUtils.getPersistenceManager()). The major advantage is its automatic conversion to DataAccessExceptions, the major disadvantage that no checked application exceptions can get thrown from within data access code. Corresponding checks and the actual throwing of such exceptions can often be deferred to after callback execution, though.

LocalPersistenceManagerFactoryBean is the preferred way of obtaining a reference to a specific PersistenceManagerFactory, at least in a non-EJB environment. The Spring application context will manage its lifecycle, initializing and shutting down the factory as part of the application.

Note that lazy loading will just work with an open JDO PersistenceManager, either within a Spring-driven transaction (with JdoTransactionManager or JtaTransactionManager) or within OpenPersistenceManagerInViewFilter/Interceptor. Furthermore, some operations just make sense within transactions, for example: evict, evictAll, flush.

NOTE: This class requires JDO 2.0 or higher, as of Spring 2.5. As of Spring 3.0, it follows JDO 2.1 conventions in terms of generic parameter and return types, which still remaining compatible with JDO 2.0.

See Also

Summary

[Expand]
Inherited Fields
From class org.springframework.orm.jdo.JdoAccessor
Public Constructors
JdoTemplate()
Create a new JdoTemplate instance.
JdoTemplate(PersistenceManagerFactory pmf)
Create a new JdoTemplate instance.
JdoTemplate(PersistenceManagerFactory pmf, boolean allowCreate)
Create a new JdoTemplate instance.
Public Methods
void deletePersistent(Object entity)
Delete the given persistent instance.
void deletePersistentAll(Collection entities)
Delete all given persistent instances.
<T> T detachCopy(T entity)
Detach a copy of the given persistent instance from the current JDO transaction, for use outside a JDO transaction (for example, as web form object).
<T> Collection<T> detachCopyAll(Collection<T> entities)
Detach copies of the given persistent instances from the current JDO transaction, for use outside a JDO transaction (for example, as web form objects).
void evict(Object entity)
Remove the given object from the PersistenceManager cache.
void evictAll(Collection entities)
Remove all given objects from the PersistenceManager cache.
void evictAll()
Remove all objects from the PersistenceManager cache.
<T> T execute(JdoCallback<T> action)
Execute the action specified by the given action object within a PersistenceManager.
<T> T execute(JdoCallback<T> action, boolean exposeNativePersistenceManager)
Execute the action specified by the given action object within a PersistenceManager.
Collection executeFind(JdoCallback<?> action)
Execute the specified action assuming that the result object is a Collection.
<T> Collection<T> find(Class<T> entityClass, String filter, String parameters, Object... values)
Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values.
<T> Collection<T> find(Class<T> entityClass, String filter, String parameters, Map<String, ?> values, String ordering)
Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values, with the given result ordering.
Collection find(String queryString)
Find persistent instances through the given single-string JDOQL query.
Collection find(String queryString, Map<String, ?> values)
Find persistent instances through the given single-string JDOQL query.
<T> Collection<T> find(Class<T> entityClass, String filter, String parameters, Object[] values, String ordering)
Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values, with the given result ordering.
<T> Collection<T> find(Class<T> entityClass)
Find all persistent instances of the given class.
Collection find(String language, Object queryObject)
Find persistent instances through the given query object in the specified query language.
Collection find(String queryString, Object... values)
Find persistent instances through the given single-string JDOQL query.
<T> Collection<T> find(Class<T> entityClass, String filter)
Find all persistent instances of the given class that match the given JDOQL filter.
<T> Collection<T> find(Class<T> entityClass, String filter, String parameters, Map<String, ?> values)
Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values.
<T> Collection<T> find(Class<T> entityClass, String filter, String ordering)
Find all persistent instances of the given class that match the given JDOQL filter, with the given result ordering.
<T> Collection<T> findByNamedQuery(Class<T> entityClass, String queryName, Object... values)
Find persistent instances through the given named query.
<T> Collection<T> findByNamedQuery(Class<T> entityClass, String queryName, Map<String, ?> values)
Find persistent instances through the given named query.
<T> Collection<T> findByNamedQuery(Class<T> entityClass, String queryName)
Find persistent instances through the given named query.
void flush()
Flush all transactional modifications to the database.
<T> T getObjectById(Class<T> entityClass, Object idValue)
Return the persistent instance of the given entity class with the given id value, throwing an exception if not found.
Object getObjectById(Object objectId)
Return the persistent instance with the given JDO object id, throwing an exception if not found.
boolean isAllowCreate()
Return if a new PersistenceManager should be created if no thread-bound found.
boolean isExposeNativePersistenceManager()
Return whether to expose the native JDO PersistenceManager to JdoCallback code, or rather a PersistenceManager proxy.
<T> T makePersistent(T entity)
Make the given transient instance persistent.
<T> Collection<T> makePersistentAll(Collection<T> entities)
Make the given transient instances persistent.
void prepareQuery(Query query)
Prepare the given JDO query object.
void refresh(Object entity)
Re-read the state of the given persistent instance.
void refreshAll(Collection entities)
Re-read the state of all given persistent instances.
void refreshAll()
Re-read the state of all persistent instances.
void setAllowCreate(boolean allowCreate)
Set if a new PersistenceManager should be created when no transactional PersistenceManager can be found for the current thread.
void setExposeNativePersistenceManager(boolean exposeNativePersistenceManager)
Set whether to expose the native JDO PersistenceManager to JdoCallback code.
Protected Methods
PersistenceManager createPersistenceManagerProxy(PersistenceManager pm)
Create a close-suppressing proxy for the given JDO PersistenceManager.
<T> T postProcessResult(T result, PersistenceManager pm, boolean existingTransaction)
Post-process the given result object, which might be a Collection.
[Expand]
Inherited Methods
From class org.springframework.orm.jdo.JdoAccessor
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.orm.jdo.JdoOperations

Public Constructors

public JdoTemplate ()

Create a new JdoTemplate instance.

public JdoTemplate (PersistenceManagerFactory pmf)

Create a new JdoTemplate instance.

Parameters
pmf PersistenceManagerFactory to create PersistenceManagers

public JdoTemplate (PersistenceManagerFactory pmf, boolean allowCreate)

Create a new JdoTemplate instance.

Parameters
pmf PersistenceManagerFactory to create PersistenceManagers
allowCreate if a non-transactional PersistenceManager should be created when no transactional PersistenceManager can be found for the current thread

Public Methods

public void deletePersistent (Object entity)

Delete the given persistent instance.

Parameters
entity the persistent instance to delete
Throws
DataAccessException

public void deletePersistentAll (Collection entities)

Delete all given persistent instances.

This can be combined with any of the find methods to delete by query in two lines of code.

Parameters
entities the persistent instances to delete
Throws
DataAccessException

public T detachCopy (T entity)

Detach a copy of the given persistent instance from the current JDO transaction, for use outside a JDO transaction (for example, as web form object).

Parameters
entity the persistent instance to detach
Returns
  • the corresponding detached instance

public Collection<T> detachCopyAll (Collection<T> entities)

Detach copies of the given persistent instances from the current JDO transaction, for use outside a JDO transaction (for example, as web form objects).

Parameters
entities the persistent instances to detach
Returns
  • the corresponding detached instances

public void evict (Object entity)

Remove the given object from the PersistenceManager cache.

Parameters
entity the persistent instance to evict
Throws
DataAccessException

public void evictAll (Collection entities)

Remove all given objects from the PersistenceManager cache.

Parameters
entities the persistent instances to evict
Throws
DataAccessException

public void evictAll ()

Remove all objects from the PersistenceManager cache.

Throws
DataAccessException

public T execute (JdoCallback<T> action)

Execute the action specified by the given action object within a PersistenceManager. Application exceptions thrown by the action object get propagated to the caller (can only be unchecked). JDO exceptions are transformed into appropriate DAO ones. Allows for returning a result object, i.e. a domain object or a collection of domain objects.

Note: Callback code is not supposed to handle transactions itself! Use an appropriate transaction manager like JdoTransactionManager.

Parameters
action callback object that specifies the JDO action
Returns
  • a result object returned by the action, or null
Throws
DataAccessException

public T execute (JdoCallback<T> action, boolean exposeNativePersistenceManager)

Execute the action specified by the given action object within a PersistenceManager.

Parameters
action callback object that specifies the JDO action
exposeNativePersistenceManager whether to expose the native JDO persistence manager to callback code
Returns
  • a result object returned by the action, or null
Throws
DataAccessException in case of JDO errors

public Collection executeFind (JdoCallback<?> action)

Execute the specified action assuming that the result object is a Collection. This is a convenience method for executing JDO queries within an action.

Parameters
action callback object that specifies the JDO action
Returns
  • a Collection result returned by the action, or null
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter, String parameters, Object... values)

Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values.

Parameters
entityClass a persistent class
filter the JDOQL filter to match
parameters the JDOQL parameter declarations
values the corresponding parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter, String parameters, Map<String, ?> values, String ordering)

Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values, with the given result ordering.

Parameters
entityClass a persistent class
filter the JDOQL filter to match
parameters the JDOQL parameter declarations
values a Map with parameter names as keys and parameter values
ordering the ordering of the result (or null if none)
Returns
  • the persistent instances
Throws
DataAccessException

public Collection find (String queryString)

Find persistent instances through the given single-string JDOQL query.

Parameters
queryString the single-string JDOQL query
Returns
  • the persistent instances
Throws
DataAccessException

public Collection find (String queryString, Map<String, ?> values)

Find persistent instances through the given single-string JDOQL query.

Parameters
queryString the single-string JDOQL query
values a Map with parameter names as keys and parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter, String parameters, Object[] values, String ordering)

Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values, with the given result ordering.

Parameters
entityClass a persistent class
filter the JDOQL filter to match
parameters the JDOQL parameter declarations
values the corresponding parameter values
ordering the ordering of the result (or null if none)
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass)

Find all persistent instances of the given class.

Parameters
entityClass a persistent class
Returns
  • the persistent instances
Throws
DataAccessException

public Collection find (String language, Object queryObject)

Find persistent instances through the given query object in the specified query language.

Parameters
language the query language (javax.jdo.Query#JDOQL or javax.jdo.Query#SQL, for example)
queryObject the query object for the specified language
Returns
  • the persistent instances
Throws
DataAccessException

public Collection find (String queryString, Object... values)

Find persistent instances through the given single-string JDOQL query.

Parameters
queryString the single-string JDOQL query
values the corresponding parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter)

Find all persistent instances of the given class that match the given JDOQL filter.

Parameters
entityClass a persistent class
filter the JDOQL filter to match (or null if none)
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter, String parameters, Map<String, ?> values)

Find all persistent instances of the given class that match the given JDOQL filter, using the given parameter declarations and parameter values.

Parameters
entityClass a persistent class
filter the JDOQL filter to match
parameters the JDOQL parameter declarations
values a Map with parameter names as keys and parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> find (Class<T> entityClass, String filter, String ordering)

Find all persistent instances of the given class that match the given JDOQL filter, with the given result ordering.

Parameters
entityClass a persistent class
filter the JDOQL filter to match (or null if none)
ordering the ordering of the result (or null if none)
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> findByNamedQuery (Class<T> entityClass, String queryName, Object... values)

Find persistent instances through the given named query.

Parameters
entityClass a persistent class
queryName the name of the query
values the corresponding parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> findByNamedQuery (Class<T> entityClass, String queryName, Map<String, ?> values)

Find persistent instances through the given named query.

Parameters
entityClass a persistent class
queryName the name of the query
values a Map with parameter names as keys and parameter values
Returns
  • the persistent instances
Throws
DataAccessException

public Collection<T> findByNamedQuery (Class<T> entityClass, String queryName)

Find persistent instances through the given named query.

Parameters
entityClass a persistent class
queryName the name of the query
Returns
  • the persistent instances
Throws
DataAccessException

public void flush ()

Flush all transactional modifications to the database.

Only invoke this for selective eager flushing, for example when JDBC code needs to see certain changes within the same transaction. Else, it's preferable to rely on auto-flushing at transaction completion.

Throws
DataAccessException

public T getObjectById (Class<T> entityClass, Object idValue)

Return the persistent instance of the given entity class with the given id value, throwing an exception if not found.

The given id value is typically just unique within the namespace of the persistent class. Its toString value must correspond to the toString value of the corresponding JDO object id.

Usually, the passed-in value will have originated from the primary key field of a persistent object that uses JDO's application identity.

Parameters
entityClass a persistent class
idValue an id value of the persistent instance
Returns
  • the persistent instance
Throws
DataAccessException

public Object getObjectById (Object objectId)

Return the persistent instance with the given JDO object id, throwing an exception if not found.

A JDO object id identifies both the persistent class and the id within the namespace of that class.

Parameters
objectId a JDO object id of the persistent instance
Returns
  • the persistent instance
Throws
DataAccessException

public boolean isAllowCreate ()

Return if a new PersistenceManager should be created if no thread-bound found.

public boolean isExposeNativePersistenceManager ()

Return whether to expose the native JDO PersistenceManager to JdoCallback code, or rather a PersistenceManager proxy.

public T makePersistent (T entity)

Make the given transient instance persistent. Attach the given entity if the instance is detached.

Parameters
entity the transient instance to make persistent
Returns
  • the persistent instance
Throws
DataAccessException

public Collection<T> makePersistentAll (Collection<T> entities)

Make the given transient instances persistent. Attach the given entities if the instances are detached.

Parameters
entities the transient instances to make persistent
Returns
  • the persistent instances
Throws
DataAccessException

public void prepareQuery (Query query)

Prepare the given JDO query object. To be used within a JdoCallback.

Applies a transaction timeout, if any. If you don't use such timeouts, the call is a no-op.

In general, prefer a proxied PersistenceManager instead, which will automatically apply the transaction timeout (through the use of a special PersistenceManager proxy). You need to set the "exposeNativePersistenceManager" property to "false" to activate this. Note that you won't be able to cast to a provider-specific JDO PersistenceManager class anymore then.

Parameters
query the JDO query object
Throws
if the query could not be properly prepared
JDOException
See Also

public void refresh (Object entity)

Re-read the state of the given persistent instance.

Parameters
entity the persistent instance to re-read
Throws
DataAccessException

public void refreshAll (Collection entities)

Re-read the state of all given persistent instances.

Parameters
entities the persistent instances to re-read
Throws
DataAccessException

public void refreshAll ()

Re-read the state of all persistent instances.

Throws
DataAccessException

public void setAllowCreate (boolean allowCreate)

Set if a new PersistenceManager should be created when no transactional PersistenceManager can be found for the current thread.

JdoTemplate is aware of a corresponding PersistenceManager bound to the current thread, for example when using JdoTransactionManager. If allowCreate is true, a new non-transactional PersistenceManager will be created if none found, which needs to be closed at the end of the operation. If false, an IllegalStateException will get thrown in this case.

See Also
  • PersistenceManagerFactoryUtils#getPersistenceManager(javax.jdo.PersistenceManagerFactory, boolean)

public void setExposeNativePersistenceManager (boolean exposeNativePersistenceManager)

Set whether to expose the native JDO PersistenceManager to JdoCallback code. Default is "false": a PersistenceManager proxy will be returned, suppressing close calls and automatically applying transaction timeouts (if any).

As there is often a need to cast to a provider-specific PersistenceManager class in DAOs that use provider-specific functionality, the exposed proxy implements all interfaces implemented by the original PersistenceManager. If this is not sufficient, turn this flag to "true".

See Also

Protected Methods

protected PersistenceManager createPersistenceManagerProxy (PersistenceManager pm)

Create a close-suppressing proxy for the given JDO PersistenceManager. Called by the execute method.

The proxy also prepares returned JDO Query objects.

Parameters
pm the JDO PersistenceManager to create a proxy for
Returns
  • the PersistenceManager proxy, implementing all interfaces implemented by the passed-in PersistenceManager object (that is, also implementing all provider-specific extension interfaces)
See Also

protected T postProcessResult (T result, PersistenceManager pm, boolean existingTransaction)

Post-process the given result object, which might be a Collection. Called by the execute method.

Default implementation always returns the passed-in Object as-is. Subclasses might override this to automatically detach result collections or even single result objects.

Parameters
result the result object (might be a Collection)
pm the current JDO PersistenceManager
existingTransaction if executing within an existing transaction (within an existing JDO PersistenceManager that won't be closed immediately)
Returns
  • the post-processed result object (can be simply be the passed-in object)
See Also