org.tangram.mutable

Class AbstractMutableBeanFactory<M,Q>

java.lang.Object

org.tangram.content.AbstractBeanFactory<Q>

org.tangram.mutable.AbstractMutableBeanFactory<M,Q>

Type Parameters:

Q - query type constraint

M - manager type constraint

All Implemented Interfaces:

org.tangram.content.BeanFactory<Q>, MutableBeanFactory<M,Q>

public abstract class AbstractMutableBeanFactory<M,Q>
extends org.tangram.content.AbstractBeanFactory<Q>
implements MutableBeanFactory<M,Q>

Common stuff for all bean factories dealing with mutable content.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.tangram.content.Content>	cache
protected java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<java.lang.Class<? extends org.tangram.content.Content>>>	implementingClassesMap mapping from classes or interfaces to non abstract classes implementing them
protected java.util.List<java.lang.Class<? extends org.tangram.content.Content>>	modelClasses
protected static java.lang.String	QUERY_CACHE_KEY
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	queryCache
protected org.tangram.PersistentRestartCache	startupCache
protected org.tangram.monitor.Statistics	statistics
protected java.util.Map<java.lang.String,java.lang.Class<? extends org.tangram.content.Content>>	tableNameMapping

Constructor Summary

Constructors

Constructor and Description
AbstractMutableBeanFactory()

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.Class<? extends org.tangram.content.Content> cls, org.tangram.content.BeanListener listener) Attach a listener for any changes dealing with classes of the given type.
protected abstract <T extends org.tangram.content.Content> void	apiDelete(T bean) Wrap API specific deletion call.
protected abstract <T extends org.tangram.content.Content> void	apiPersist(T bean) Wrap API specific persistence call.
protected void	appendItem(java.lang.StringBuffer result, java.lang.String filterProperty, java.lang.String filterValue)
void	clearCacheFor(java.lang.Class<? extends org.tangram.content.Content> cls) clear caches for instances depending on the given type.
<T extends org.tangram.content.Content> T	createBean(java.lang.Class<T> cls) remember that the newly created bean has to be persisted in the now open transaction!
<T extends org.tangram.content.Content> boolean	delete(T bean) Delete a given bean from persistence storage.
protected <T extends org.tangram.content.Content> void	filterExactClass(java.lang.Class<T> cls, java.util.List<? extends java.lang.Object> rawList, java.util.List<T> filteredList) Filter a list of objects for instances of a given class.
java.util.Set<java.lang.String>	getBasePackages()
<T extends org.tangram.content.Content> T	getBean(java.lang.Class<T> cls, java.lang.String id)
protected abstract <T extends org.tangram.content.Content> T	getBean(java.lang.Class<T> cls, java.lang.String kind, java.lang.String internalId)
protected <T> java.lang.String	getCacheKey(java.lang.Class<T> cls, java.lang.String query, java.lang.String orderProperty, java.lang.Boolean ascending)
java.util.Collection<java.lang.Class<? extends org.tangram.content.Content>>	getClasses() return a collection of all content classes available for mutable contents.
protected <T extends org.tangram.content.Content> java.lang.Class<T>	getClassForName(java.lang.String className) Gets the class for a given type name.
protected java.lang.String	getClassNamesCacheKey() Cache key for the persistent cache to store all class names.
<F extends org.tangram.content.Content> java.lang.String	getFilterQuery(java.lang.Class<F> cls, java.lang.String filterProperty, java.lang.String filterValues) Generic filter expression generation for a filter query.
protected <T extends org.tangram.content.Content> java.util.List<java.lang.Class<T>>	getImplementingBaseClasses(java.lang.Class<T> cls)
<T extends org.tangram.content.Content> java.util.List<java.lang.Class<T>>	getImplementingClasses(java.lang.Class<T> baseClass) Get the classes implementing a given baseClass.
protected java.util.List<java.lang.Class<? extends org.tangram.content.Content>>	getImplementingClassesForModelClass(java.lang.Class<? extends org.tangram.content.Content> baseClass)
java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<java.lang.Class<? extends org.tangram.content.Content>>>	getImplementingClassesMap() just to support JSP's weak calling of methods.
protected <T extends org.tangram.content.Content> java.lang.Class<T>	getKeyClass(java.lang.String key) Get class name from query cache key.
protected java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<org.tangram.content.BeanListener>>	getListeners()
protected abstract boolean	hasManager() Check if the underlying API implementation of the bean factory really has the needed managing instance of some sort at hand.
protected void	injectBeanFactory(java.util.List<? extends org.tangram.content.Content> results) Inject bean factory for objects requesting this.
boolean	isActivateCaching()
boolean	isActivateQueryCaching()
boolean	isRegexFilterQuery()
<T extends org.tangram.content.Content> java.util.List<T>	listBeansOfExactClass(java.lang.Class<T> cls, java.lang.String query, java.lang.String orderProperty, java.lang.Boolean ascending)
<T extends org.tangram.content.Content> boolean	persist(T bean) Persist a given bean.
<T extends org.tangram.content.Content> boolean	persistUncommitted(T bean) Persist a given bean and don't close the open transaction.
void	setActivateCaching(boolean activateCaching)
void	setActivateQueryCaching(boolean activateQueryCaching)
void	setBasePackages(java.util.Set<java.lang.String> basePackages)
void	setRegexFilterQuery(boolean regexFilterQuery)

Methods inherited from class org.tangram.content.AbstractBeanFactory

convert, listBeans, listBeans, listBeans, listBeansOfExactClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tangram.mutable.MutableBeanFactory

beginTransaction, commitTransaction, getAllClasses, getBaseClass, getManager, rollbackTransaction

Methods inherited from interface org.tangram.content.BeanFactory

createQuery, getBean, listBeans, listBeans, listBeans, listBeans, listBeans, listBeansOfExactClass

Field Detail

QUERY_CACHE_KEY

protected static final java.lang.String QUERY_CACHE_KEY

See Also:

Constant Field Values

statistics

@Inject
protected org.tangram.monitor.Statistics statistics

startupCache

@Inject
protected org.tangram.PersistentRestartCache startupCache

implementingClassesMap

protected java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<java.lang.Class<? extends org.tangram.content.Content>>> implementingClassesMap

mapping from classes or interfaces to non abstract classes implementing them

modelClasses

protected java.util.List<java.lang.Class<? extends org.tangram.content.Content>> modelClasses

tableNameMapping

protected java.util.Map<java.lang.String,java.lang.Class<? extends org.tangram.content.Content>> tableNameMapping

cache

protected java.util.Map<java.lang.String,org.tangram.content.Content> cache

queryCache

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> queryCache

Constructor Detail

AbstractMutableBeanFactory

public AbstractMutableBeanFactory()

Method Detail

getBasePackages

public java.util.Set<java.lang.String> getBasePackages()

setBasePackages

public void setBasePackages(java.util.Set<java.lang.String> basePackages)

isActivateCaching

public boolean isActivateCaching()

setActivateCaching

public void setActivateCaching(boolean activateCaching)

isActivateQueryCaching

public boolean isActivateQueryCaching()

setActivateQueryCaching

public void setActivateQueryCaching(boolean activateQueryCaching)

isRegexFilterQuery

public boolean isRegexFilterQuery()

setRegexFilterQuery

public void setRegexFilterQuery(boolean regexFilterQuery)

getListeners

protected java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<org.tangram.content.BeanListener>> getListeners()

hasManager

protected abstract boolean hasManager()

Check if the underlying API implementation of the bean factory really has the needed managing instance of some sort at hand. common case to check for persisting and deleting instances though highly API specific in detail.

Returns:

tell if manager instance is available in this bean factory instance

apiPersist

protected abstract <T extends org.tangram.content.Content> void apiPersist(T bean)

Wrap API specific persistence call. Higher level methods in this class in turn deal with exception and cachce handling.

Type Parameters:

T - Type constraint for the content to be persisted

Parameters:

bean - bean of the above type

apiDelete

protected abstract <T extends org.tangram.content.Content> void apiDelete(T bean)

Wrap API specific deletion call. Higher level methods in this class in turn deal with exception and cachce handling.

Type Parameters:

T - Type constraint for the content to be deleted

Parameters:

bean - bean of the above type

createBean

public <T extends org.tangram.content.Content> T createBean(java.lang.Class<T> cls)
                                                     throws java.lang.InstantiationException,
                                                            java.lang.IllegalAccessException

remember that the newly created bean has to be persisted in the now open transaction!

Specified by:

createBean in interface MutableBeanFactory<M,Q>

Type Parameters:

T - type of bean to create

Parameters:

cls - instance of that type

Returns:

newly created instance

Throws:

java.lang.IllegalAccessException - some method for the creation of this bean may not be called

java.lang.InstantiationException - bean cannot be instantiated

getClassNamesCacheKey

protected java.lang.String getClassNamesCacheKey()

Cache key for the persistent cache to store all class names. The stored values are taken from the class path package scan and assumed to be persistent over re-starts of the application.

Returns:

String to be used as a cache key

persistUncommitted

public <T extends org.tangram.content.Content> boolean persistUncommitted(T bean)

Description copied from interface: MutableBeanFactory

Persist a given bean and don't close the open transaction.

Specified by:

persistUncommitted in interface MutableBeanFactory<M,Q>

Type Parameters:

T - Type constraint for the given bean

Parameters:

bean - bean to persist without committing the running transaction

Returns:

true if persisting could be completed successfully

delete

public <T extends org.tangram.content.Content> boolean delete(T bean)

Description copied from interface: MutableBeanFactory

Delete a given bean from persistence storage. This method uses a transaction and closes it or does a roll back.

Specified by:

delete in interface MutableBeanFactory<M,Q>

Type Parameters:

T - Type constraint for the given bean

Parameters:

bean - bean to delete from persistent storage

Returns:

true if deleting could be completed successfully

persist

public <T extends org.tangram.content.Content> boolean persist(T bean)

Description copied from interface: MutableBeanFactory

Persist a given bean.

Specified by:

persist in interface MutableBeanFactory<M,Q>

Type Parameters:

T - Type constraint for the given bean

Parameters:

bean - bean to persist

Returns:

true if persisting could be completed successfully

getClassForName

protected <T extends org.tangram.content.Content> java.lang.Class<T> getClassForName(java.lang.String className)

Gets the class for a given type name. Be aware of different class loaders - like with groovy based classes.

Type Parameters:

T - content sub class described by given class name

Parameters:

className - fully qualified name of the class

Returns:

resulting class or null if not possible (should never happen...)

getKeyClass

protected <T extends org.tangram.content.Content> java.lang.Class<T> getKeyClass(java.lang.String key)

Get class name from query cache key. Keys are supposed to be in the form of <classname>:<query>

Type Parameters:

T - Type constraint for the class to be derived from the given key

Parameters:

key - cache key to get content class for

Returns:

Class for the given key or null if the key does not map to any class

clearCacheFor

public void clearCacheFor(java.lang.Class<? extends org.tangram.content.Content> cls)

Description copied from interface: MutableBeanFactory

clear caches for instances depending on the given type. Never dare to issue changes for abstract classes or interfaces! (You cannot have instances of those types anyway) The call is only relevant for the attached listeners.

Specified by:

clearCacheFor in interface MutableBeanFactory<M,Q>

Parameters:

cls - class to trigger listeners for

addListener

public void addListener(java.lang.Class<? extends org.tangram.content.Content> cls,
                        org.tangram.content.BeanListener listener)

Attach a listener for any changes dealing with classes of the given type.

Specified by:

addListener in interface org.tangram.content.BeanFactory<Q>

Parameters:

cls - class to be notified when instances of that class have been changed

listener - listener to be notified about changes

filterExactClass

protected <T extends org.tangram.content.Content> void filterExactClass(java.lang.Class<T> cls,
                                                                        java.util.List<? extends java.lang.Object> rawList,
                                                                        java.util.List<T> filteredList)

Filter a list of objects for instances of a given class. No instances of subclasses are inserted into the filtered result.

Type Parameters:

T - type constraint for the class to filter for

Parameters:

cls - type to filter for

rawList - list to filter

filteredList - result list

getBean

protected abstract <T extends org.tangram.content.Content> T getBean(java.lang.Class<T> cls,
                                                                     java.lang.String kind,
                                                                     java.lang.String internalId)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

getBean

public <T extends org.tangram.content.Content> T getBean(java.lang.Class<T> cls,
                                                         java.lang.String id)

Specified by:

getBean in interface org.tangram.content.BeanFactory<Q>

appendItem

protected void appendItem(java.lang.StringBuffer result,
                          java.lang.String filterProperty,
                          java.lang.String filterValue)

getFilterQuery

public <F extends org.tangram.content.Content> java.lang.String getFilterQuery(java.lang.Class<F> cls,
                                                                               java.lang.String filterProperty,
                                                                               java.lang.String filterValues)

Generic filter expression generation for a filter query. This implementation is sufficient for many ORMs to generate where clauses.

Specified by:

getFilterQuery in interface MutableBeanFactory<M,Q>

Type Parameters:

F - content type constraint

Parameters:

filterProperty - property to filter for

filterValues - values to filter for

cls - class this resulting query is about

Returns:

parts of a string based query expression

getImplementingClassesForModelClass

protected java.util.List<java.lang.Class<? extends org.tangram.content.Content>> getImplementingClassesForModelClass(java.lang.Class<? extends org.tangram.content.Content> baseClass)

getImplementingClassesMap

public java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<java.lang.Class<? extends org.tangram.content.Content>>> getImplementingClassesMap()

just to support JSP's weak calling of methods. It does not allow any parameters.

Specified by:

getImplementingClassesMap in interface MutableBeanFactory<M,Q>

Returns:

map to map abstract classes to all non-abstract classes implementing/extending them

getImplementingClasses

public <T extends org.tangram.content.Content> java.util.List<java.lang.Class<T>> getImplementingClasses(java.lang.Class<T> baseClass)

Get the classes implementing a given baseClass.

Specified by:

getImplementingClasses in interface MutableBeanFactory<M,Q>

Type Parameters:

T - type constraint for the class to get implementing classes for

Parameters:

baseClass - class or interface to get implementing classes for

Returns:

list of non-abstract classes that can be assigned to the given base class

getCacheKey

protected <T> java.lang.String getCacheKey(java.lang.Class<T> cls,
                                           java.lang.String query,
                                           java.lang.String orderProperty,
                                           java.lang.Boolean ascending)

getImplementingBaseClasses

protected <T extends org.tangram.content.Content> java.util.List<java.lang.Class<T>> getImplementingBaseClasses(java.lang.Class<T> cls)

listBeansOfExactClass

public <T extends org.tangram.content.Content> java.util.List<T> listBeansOfExactClass(java.lang.Class<T> cls,
                                                                                       java.lang.String query,
                                                                                       java.lang.String orderProperty,
                                                                                       java.lang.Boolean ascending)

Specified by:

listBeansOfExactClass in interface org.tangram.content.BeanFactory<Q>

injectBeanFactory

protected void injectBeanFactory(java.util.List<? extends org.tangram.content.Content> results)

Inject bean factory for objects requesting this.

Parameters:

results - list of optionally bean aware objects

getClasses

public java.util.Collection<java.lang.Class<? extends org.tangram.content.Content>> getClasses()

Description copied from interface: MutableBeanFactory

return a collection of all content classes available for mutable contents. No abstract classes will be in the returned collection.

Specified by:

getClasses in interface MutableBeanFactory<M,Q>

Returns:

collection of content classes