org.apache.isis.core.metamodel.adapter.mgr

Interface AdapterManager

All Superinterfaces:

Injectable

All Known Implementing Classes:

AdapterManagerAbstract, AdapterMapDelegator

public interface AdapterManager
extends Injectable

Responsible for managing the adapters and identities for each and every POJO that is being used by the framework.

It provides a consistent set of adapters in memory, providing an adapter for the POJOs that are in use ensuring that the same object is not loaded twice into memory.

Each POJO is given an adapter so that the framework can work with the POJOs even though it does not understand their types. Each POJO maps to an adapter and these are reused.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AdapterManager.ConcurrencyChecking

Method Summary

Methods

Modifier and Type	Method and Description
ObjectAdapter	adapterFor(Object domainObject) Looks up or creates a standalone (value) or root adapter.
ObjectAdapter	adapterFor(Object domainObject, ObjectAdapter parentAdapter) Looks up or creates a standalone (value), aggregated or root adapter.
ObjectAdapter	adapterFor(Object pojo, ObjectAdapter parentAdapter, OneToManyAssociation collection) Looks up or creates a collection adapter.
ObjectAdapter	adapterFor(TypedOid oid) As per adapterFor(TypedOid, ConcurrencyChecking), with .
ObjectAdapter	adapterFor(TypedOid oid, AdapterManager.ConcurrencyChecking concurrencyChecking) Either returns an existing adapter (as per getAdapterFor(Oid)), otherwise re-creates an adapter with the specified (persistent) Oid.
ObjectAdapter	getAdapterFor(Object pojo) Gets the adapter for the specified domain object if it exists in the identity map.
ObjectAdapter	getAdapterFor(Oid oid) Gets the adapter for the Oid if it exists in the identity map.

Methods inherited from interface org.apache.isis.core.commons.components.Injectable

injectInto

Method Detail

getAdapterFor

ObjectAdapter getAdapterFor(Oid oid)

Gets the adapter for the Oid if it exists in the identity map.

Parameters:

oid - - must not be null

Returns:

adapter, or null if doesn't exist.

getAdapterFor

ObjectAdapter getAdapterFor(Object pojo)

Gets the adapter for the specified domain object if it exists in the identity map.

Provided by the AdapterManager when used by framework.

Parameters:

pojo - - must not be null

Returns:

adapter, or null if doesn't exist.

adapterFor

ObjectAdapter adapterFor(TypedOid oid)

As per adapterFor(TypedOid, ConcurrencyChecking), with .

This method will always return an object, possibly indicating it is persistent; so make sure that you know that the oid does indeed represent an object you know exists.

adapterFor

ObjectAdapter adapterFor(TypedOid oid,
                       AdapterManager.ConcurrencyChecking concurrencyChecking)

Either returns an existing adapter (as per getAdapterFor(Oid)), otherwise re-creates an adapter with the specified (persistent) Oid.

Typically called when the Oid is already known, that is, when resolving an already-persisted object. Is also available for Memento support however, so Oid could also represent a transient object.

The pojo itself is recreated by delegating to a PojoRecreator implementation. The default impl just uses the ObjectSpecification.createObject(); however object stores (eg JDO/DataNucleus) can provide alternative implementations in order to ensure that the created pojo is attached to a persistence context.

If the adapter is recreated, its ResolveState will be set to ResolveState.GHOST.

The AdapterManager.ConcurrencyChecking parameter determines whether concurrency checking is performed. If it is requested, then a check is made to ensure that the version of the oid of the recreated adapter is the same as that of the provided oid. If the version differs, then a ConcurrencyException is thrown.

ALSO, even if a ConcurrencyException, then the provided oid's version will be set to the current value. This allows the client to retry if they wish.

Throws:

{@link - ObjectNotFoundException} if the object does not exist.

adapterFor

ObjectAdapter adapterFor(Object domainObject)

Looks up or creates a standalone (value) or root adapter.

adapterFor

ObjectAdapter adapterFor(Object domainObject,
                       ObjectAdapter parentAdapter)

Looks up or creates a standalone (value), aggregated or root adapter.

adapterFor

ObjectAdapter adapterFor(Object pojo,
                       ObjectAdapter parentAdapter,
                       OneToManyAssociation collection)

Looks up or creates a collection adapter.