org.tangram.mutable

Interface MutableBeanFactory

All Superinterfaces:

org.tangram.content.BeanFactory

All Known Implementing Classes:

AbstractMutableBeanFactory

public interface MutableBeanFactory
extends org.tangram.content.BeanFactory

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Starts a transaction which must subsequently be committed or rolled back.
void	clearCacheFor(java.lang.Class<? extends org.tangram.content.Content> cls) clear caches for instances depending on the given type.
void	commitTransaction() Commits a transaction previously opened with beginTransaction()
<T extends org.tangram.content.Content> T	createBean(java.lang.Class<T> cls) Create a new bean of a given type.
<T extends org.tangram.content.Content> boolean	delete(T bean) Delete a given bean from persistence storage.
java.util.Collection<java.lang.Class<? extends org.tangram.content.Content>>	getAllClasses() return a collection of all classes available related with content for mutable bean instances.
java.lang.Class<? extends org.tangram.content.Content>	getBaseClass() Returns the root class of all content classes handled by the implementing instance - may be null;
java.util.Collection<java.lang.Class<? extends org.tangram.content.Content>>	getClasses() return a collection of all content classes available for mutable contents.
java.lang.String	getFilterQuery(java.lang.Class<?> cls, java.lang.String filterProperty, java.lang.String filterValues) Create a suitable query clause for filter expressions.
<T extends org.tangram.content.Content> java.util.List<java.lang.Class<T>>	getImplementingClasses(java.lang.Class<T> c) Return a list of assignable non-abstract classes for a given type.
java.util.Map<java.lang.Class<? extends org.tangram.content.Content>,java.util.List<java.lang.Class<? extends org.tangram.content.Content>>>	getImplementingClassesMap() Return a map mapping abstract classes to inheriting non-abstract classes.
java.lang.Object	getManager() Get managing instance of the underlying implementation.
<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	rollbackTransaction() Undo the changes initiated by all the commands issued after the last beginTransaction call.

Methods inherited from interface org.tangram.content.BeanFactory

addListener, getBean, getBean, listBeans, listBeans, listBeans, listBeans, listBeansOfExactClass, listBeansOfExactClass

Method Detail

getBaseClass

java.lang.Class<? extends org.tangram.content.Content> getBaseClass()

Returns the root class of all content classes handled by the implementing instance - may be null;

Returns:

base class for this bean factory implementing the content interface

beginTransaction

void beginTransaction()

Starts a transaction which must subsequently be committed or rolled back.

commitTransaction

void commitTransaction()

Commits a transaction previously opened with beginTransaction()

rollbackTransaction

void rollbackTransaction()

Undo the changes initiated by all the commands issued after the last beginTransaction call.

createBean

<T extends org.tangram.content.Content> T createBean(java.lang.Class<T> cls)
                                              throws java.lang.Exception

Create a new bean of a given type. The beans hast to be persisted in a subsequent step! The call of persist() is mandatory after using this call.

Type Parameters:

T - Type constraint for the above class

Parameters:

cls - class to create a persistable instance for

Returns:

newly created instance

Throws:

java.lang.Exception - mostly IO and DB storage related exceptions

persistUncommitted

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

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

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

persist

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

Persist a given bean.

Type Parameters:

T - Type constraint for the given bean

Parameters:

bean - bean to persist

Returns:

true if persisting could be completed successfully

delete

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

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

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

getClasses

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

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

Returns:

collection of content classes

getAllClasses

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

return a collection of all classes available related with content for mutable bean instances. Also abstract classes will be in the returned collection.

Returns:

collection of content classes

getImplementingClassesMap

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

Return a map mapping abstract classes to inheriting non-abstract classes. This map is used in the editor to map abstract classes to inheriting non-abstract classes when it comes to ask the user which non-abstract class to instanciate.

Returns:

mappping from class specifier to non-abstract implementing classes available

getImplementingClasses

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

Return a list of assignable non-abstract classes for a given type.

Type Parameters:

T - abstract class or interfaces

Parameters:

c - class instance for this type

Returns:

list of non abstract classes assignable to the given type

getFilterQuery

java.lang.String getFilterQuery(java.lang.Class<?> cls,
                                java.lang.String filterProperty,
                                java.lang.String filterValues)

Create a suitable query clause for filter expressions. Form a query string from a property name a a space separated list of possible values which should all be met as a substring of the property.

Parameters:

cls - class this resulting query is about

filterProperty - of the property to filter for

filterValues - space separated list of values which should all be met

Returns:

implementation specific query expression

clearCacheFor

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

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.

Parameters:

cls - class to trigger listeners for

getManager

java.lang.Object getManager()

Get managing instance of the underlying implementation. Unspecified type instance of the implementing backend. This is e.g. a JDO PersistenceManager instance or a JPA EntitiyManager instance.

Returns:

implementation specific manager instance