| org.objectweb.speedo.mim.api.HomeItf
All known Subclasses: org.objectweb.speedo.mim.lib.AbstractHomeImpl,
| HomeItf | | public interface HomeItf extends PClassMapping,UserCacheManager,Loggable(Code) | | It defines a home for a persitent class. Homes manage some properties
(detacheable, cacheable, prefetch on query, prefetch on extent, ...)
and some features (the user cache, named
queries). It references the TPM, the PMF.
author:
S.Chassande-Barrioz |
| Method Summary | |
| void | addInstanceLifeCycleListener(Object listener)
| | QueryDefinition | addNamedQuery(String name, QueryDefinition query)
| | boolean | allLoaded()
| | void | attachCopy(PersistentObjectItf sp, POManagerItf pm, Map map, Object clone, StateItf sa)
| | PersistentObjectItf | detachCopy(PersistentObjectItf sp, POManagerItf pm, Map map, Object clone, Collection fgHints)
| | Properties | getClassProperties()
| | QueryDefinition | getNamedQuery(String name)
Retrieves a query defintion from its name. | | POManagerFactoryItf | getPOManagerFactory()
| | String | getPath()
| | boolean | getPrefetchOnExtent()
| | boolean | getPrefetchOnGenClass()
| | boolean | getPrefetchOnQuery()
| | String | getProjectName()
| | StateItf | getState(PersistentObjectItf sp)
| | TransactionalPersistenceManager | getTransactionalPersistenceManager()
the TransactionalPersistenceManager which manages theconcurrency, loading, caching ... | | byte | getVersioningStrategy()
The versioning strategy. | | boolean | hasInstanceLifeCycleListeners()
| | boolean | hasToFix()
| | void | initSH()
| | boolean | isCacheable()
Indicates if the state of persistent instance managed by this home, are
kept between two transaction. | | boolean | isDetachable()
| | boolean | isFieldLockingLevel()
Indicates if the locking level must be the field. | | boolean | isShareable()
| | StateItf | readIntention(PersistentObjectItf sp, long[] fields)
Notifies the transactional persistency manager of a read intention for
the given persistent instance.
Parameters:
sp - is the PersistentObjectItf which the read access is requested.
Parameters:
fields - the ids of the fields that may be accessed by the callerof this method. | | void | removeInstanceLifeCycleListener(Object listener)
| | QueryDefinition | removeNamedQuery(String name)
| | void | sendEvent(int eventType, Object source, Object target)
| | void | setCachePolicy(byte v)
Permit to Indicate if the state of persistent instance managed by this
home, are kept between two transaction. | | void | setFieldLockingLevel(boolean val)
Permits to Indicate if the locking level must be the field. | | void | setPOManagerFactory(POManagerFactoryItf _pmf)
| | void | setPrefetchOnExtent(boolean prefetch)
Indicates if the prefetching must be activated on extents when they
return instance corresponding to this home. | | void | setPrefetchOnGenClass(boolean prefetch)
Indicates if the prefetching must be activated genclass loading. | | void | setPrefetchOnQuery(boolean prefetch)
Indicates if the prefetching must be activated on queries when they
return instance corresponding to this home. | | void | setShareable(boolean v)
| | void | setTransactionalPersistenceManager(TransactionalPersistenceManager _tpm)
It assignes a TransactionalPersistenceManager
Parameters:
_tpm - is the TransactionalPersistenceManager which manage theconcurrency, loading, ... | | StateItf | writeIntention(PersistentObjectItf sp, long[] fields, Object thinLock)
Notifies the transactional persistency manager of a write intention for
the given persistent instance.
Parameters:
sp - is the PersistentObjectItf which the write access is requested.
Parameters:
fields - the ids of the fields that may be accessed by the callerof this method. | | StateItf | writeIntention(PersistentObjectItf sp, long[] fields)
|
| POST_ATTACH | | int POST_ATTACH(Code) | | |
| POST_CLEAR | | int POST_CLEAR(Code) | | |
| POST_CREATE | | int POST_CREATE(Code) | | |
| POST_DELETE | | int POST_DELETE(Code) | | |
| POST_DETACH | | int POST_DETACH(Code) | | |
| POST_DIRTY | | int POST_DIRTY(Code) | | |
| POST_REMOVE | | int POST_REMOVE(Code) | | |
| POST_UPDATE | | int POST_UPDATE(Code) | | |
| PRE_ATTACH | | int PRE_ATTACH(Code) | | |
| PRE_CREATE | | int PRE_CREATE(Code) | | |
| PRE_DELETE | | int PRE_DELETE(Code) | | |
| PRE_DETACH | | int PRE_DETACH(Code) | | |
| PRE_REMOVE | | int PRE_REMOVE(Code) | | |
| PRE_UPDATE | | int PRE_UPDATE(Code) | | |
| addInstanceLifeCycleListener | | void addInstanceLifeCycleListener(Object listener)(Code) | | |
| addNamedQuery | | QueryDefinition addNamedQuery(String name, QueryDefinition query)(Code) | | Defines a named query
Parameters:
name - is the name identifying the query
Parameters:
query - is the definition of the query the old query definition corresponding to the name, if itexisted one. |
| allLoaded | | boolean allLoaded()(Code) | | |
| getNamedQuery | | QueryDefinition getNamedQuery(String name)(Code) | | Retrieves a query defintion from its name. If the name is not known, the
null value is returned.
Parameters:
name - is the name the wanted query definition |
| getPOManagerFactory | | POManagerFactoryItf getPOManagerFactory()(Code) | | the PersistenceManagerFactory representing the data supportwhere the po is persistent. |
| getPrefetchOnExtent | | boolean getPrefetchOnExtent()(Code) | | |
| getPrefetchOnGenClass | | boolean getPrefetchOnGenClass()(Code) | | |
| getPrefetchOnQuery | | boolean getPrefetchOnQuery()(Code) | | |
| getTransactionalPersistenceManager | | TransactionalPersistenceManager getTransactionalPersistenceManager()(Code) | | the TransactionalPersistenceManager which manages theconcurrency, loading, caching ... of the proxies. |
| getVersioningStrategy | | byte getVersioningStrategy()(Code) | | The versioning strategy.
See Also: org.objectweb.speedo.metadata.SpeeedoVersion.DATE_TIME
See Also:
See Also: org.objectweb.speedo.metadata.SpeeedoVersion.STATE_COMPARISON
See Also:
See Also: org.objectweb.speedo.metadata.SpeeedoVersion.VERSION_NUMBER
See Also: NO_VERSION |
| hasInstanceLifeCycleListeners | | boolean hasInstanceLifeCycleListeners()(Code) | | |
| hasToFix | | boolean hasToFix()(Code) | | |
| isCacheable | | boolean isCacheable()(Code) | | Indicates if the state of persistent instance managed by this home, are
kept between two transaction.
true means the state is kept between transaction. |
| isDetachable | | boolean isDetachable()(Code) | | Indicates if the class has been marked as detacheable
|
| isFieldLockingLevel | | boolean isFieldLockingLevel()(Code) | | Indicates if the locking level must be the field. A false value (default)
means the locking level has to be done at instance level.
|
| isShareable | | boolean isShareable()(Code) | | |
| readIntention | | StateItf readIntention(PersistentObjectItf sp, long[] fields)(Code) | | Notifies the transactional persistency manager of a read intention for
the given persistent instance.
Parameters:
sp - is the PersistentObjectItf which the read access is requested.
Parameters:
fields - the ids of the fields that may be accessed by the callerof this method. If the i-th bit of 'fields' is set to 1, then the i-thfield of the given speedo accessor may be accessed by the caller of thismethod. |
| removeInstanceLifeCycleListener | | void removeInstanceLifeCycleListener(Object listener)(Code) | | |
| removeNamedQuery | | QueryDefinition removeNamedQuery(String name)(Code) | | Remove a named query
Parameters:
name - is the name of the query definition to remove the removed query definition (null if not found) |
| setCachePolicy | | void setCachePolicy(byte v)(Code) | | Permit to Indicate if the state of persistent instance managed by this
home, are kept between two transaction.
|
| setFieldLockingLevel | | void setFieldLockingLevel(boolean val)(Code) | | Permits to Indicate if the locking level must be the field. A false
value (default) means the locking level has to be done at instance level.
|
| setPOManagerFactory | | void setPOManagerFactory(POManagerFactoryItf _pmf)(Code) | | It assignes a PersistenceManagerFactory
Parameters:
_pmf - is the PersistenceManagerFactory representing the data support where the po is persistent. |
| setPrefetchOnExtent | | void setPrefetchOnExtent(boolean prefetch)(Code) | | Indicates if the prefetching must be activated on extents when they
return instance corresponding to this home.
|
| setPrefetchOnGenClass | | void setPrefetchOnGenClass(boolean prefetch)(Code) | | Indicates if the prefetching must be activated genclass loading. This
method is only applicable for gen class home.
|
| setPrefetchOnQuery | | void setPrefetchOnQuery(boolean prefetch)(Code) | | Indicates if the prefetching must be activated on queries when they
return instance corresponding to this home.
|
| setShareable | | void setShareable(boolean v)(Code) | | |
| setTransactionalPersistenceManager | | void setTransactionalPersistenceManager(TransactionalPersistenceManager _tpm)(Code) | | It assignes a TransactionalPersistenceManager
Parameters:
_tpm - is the TransactionalPersistenceManager which manage theconcurrency, loading, ... of the po. |
| writeIntention | | StateItf writeIntention(PersistentObjectItf sp, long[] fields, Object thinLock)(Code) | | Notifies the transactional persistency manager of a write intention for
the given persistent instance.
Parameters:
sp - is the PersistentObjectItf which the write access is requested.
Parameters:
fields - the ids of the fields that may be accessed by the callerof this method. If the i-th bit of 'fields' is set to 1, then the i-thfield of the given speedo accessor may be accessed by the caller of thismethod.
Parameters:
thinLock - permits to allocate a lock on only a part of the resource. The locking size is thinner than a lock on the persistent object entirely. This parameter can be typically used to lock at the field or the genclass element levels. |
|
|