ariba.ui.meta.persistence
Class ObjectContext

java.lang.Object
  ariba.ui.meta.persistence.ObjectContext

Direct Known Subclasses:

JPAContext

public abstract class ObjectContext
extends Object

Nested Class Summary

static class	ObjectContext.ChangeWatch
static interface	ObjectContext.EntityQueryFilterProvider Implement this interface if you want to add additional filtering on queries linked to an entity.
static interface	ObjectContext.Provider

Constructor Summary

ObjectContext()

Method Summary

static void	bind(ObjectContext ctx)
static void	bindNestedContext()
static void	bindNewContext()
static void	bindNewContext(String groupName)
abstract boolean	contains(Object o)
<T> T	create(Class<T> tClass)
<T> T	create(String className)
ObjectContext.ChangeWatch	createChangeWatch()
static ObjectContext	createContext()
ObjectContext	createNestedContext() Create a nested ObjectContext.
abstract List	executeNamedQuery(String s, Map<String,Object> params)
<T> List<T>	executeQuery(Class<T> tClass, Map<String,Object> fieldValues)
List	executeQuery(QuerySpecification spec)
abstract <T> T	find(Class<T> tClass, Object primaryKey)
<T> T	findOne(Class<T> tClass, Map<String,Object> fieldValues)
static ObjectContext	get()
abstract Object	getDelegate()
ObjectContext	getParentContext() Returns parent context for a nested child context
abstract Object	getPrimaryKey(Object o)
static ObjectContext.Provider	getProvider()
String	groupName_debug()
abstract void	lock(Object o)
abstract <T> T	merge(T t)
static ObjectContext	peek()
abstract QueryProcessor	processorForQuery(QuerySpecification spec)
void	recordForInsert(Object o) Records object for insert on next save().
static void	registerQueryFilterProviderForEntityClass(String entityClass, ObjectContext.EntityQueryFilterProvider filter)
abstract void	remove(Object o)
abstract void	save()
static void	setProvider(ObjectContext.Provider provider)
TypeProvider	typeProvider(String entityName)
static void	unbind()
static void	unregisterQueryFilterProviderForEntityClass(String entityClass)
Map	userMap() Map for storage of additional state associated with this context

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectContext

public ObjectContext()

Method Detail

get

public static ObjectContext get()

peek

public static ObjectContext peek()

create

public <T> T create(String className)

create

public <T> T create(Class<T> tClass)

recordForInsert

public void recordForInsert(Object o)

Records object for insert on next save(). Some contexts may persist here, others may defer the persist until just pre-save, to give the newly created object a change to be fully initialized prior to persist()

Parameters:

o - object instance to be inserted

userMap

public Map userMap()

Map for storage of additional state associated with this context

merge

public abstract <T> T merge(T t)

remove

public abstract void remove(Object o)

find

public abstract <T> T find(Class<T> tClass,
                           Object primaryKey)

findOne

public <T> T findOne(Class<T> tClass,
                     Map<String,Object> fieldValues)

getPrimaryKey

public abstract Object getPrimaryKey(Object o)

save

public abstract void save()

lock

public abstract void lock(Object o)

contains

public abstract boolean contains(Object o)

executeQuery

public List executeQuery(QuerySpecification spec)

executeNamedQuery

public abstract List executeNamedQuery(String s,
                                       Map<String,Object> params)

getDelegate

public abstract Object getDelegate()

executeQuery

public <T> List<T> executeQuery(Class<T> tClass,
                                Map<String,Object> fieldValues)

processorForQuery

public abstract QueryProcessor processorForQuery(QuerySpecification spec)

typeProvider

public TypeProvider typeProvider(String entityName)

registerQueryFilterProviderForEntityClass

public static void registerQueryFilterProviderForEntityClass(String entityClass,
                                                             ObjectContext.EntityQueryFilterProvider filter)

unregisterQueryFilterProviderForEntityClass

public static void unregisterQueryFilterProviderForEntityClass(String entityClass)

bind

public static void bind(ObjectContext ctx)

unbind

public static void unbind()

bindNewContext

public static void bindNewContext(String groupName)

bindNewContext

public static void bindNewContext()

bindNestedContext

public static void bindNestedContext()

createContext

public static ObjectContext createContext()

createChangeWatch

public ObjectContext.ChangeWatch createChangeWatch()

groupName_debug

public String groupName_debug()

getProvider

public static ObjectContext.Provider getProvider()

setProvider

public static void setProvider(ObjectContext.Provider provider)

createNestedContext

public ObjectContext createNestedContext()

Create a nested ObjectContext. Nested contexts have visibility to their parent's uncommited changes, and commit to their parent's in-memory objects rather than to to database. Nested Contexts are useful for modal UI flows, where an operation may be cancelled and doing so should leave the parent's objects unaffected -- by "sandboxing" these changes in copies of objects in a nested context, the Cancel is handled by simply discarding the child context, and Okay by doing a save(). NOTE: not all ObjectContext implementations can support Nested Contexts. (e.g. such support is not part of the JPA EntityManager specification)

Returns:

the new child context instance

getParentContext

public ObjectContext getParentContext()

Returns parent context for a nested child context

Returns:

the parent context, or null if not nested.