|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HomeItf
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.objectweb.jorm.api.PClassMapping |
---|
org.objectweb.jorm.api.PClassMapping.ReferenceConfigurator |
Field Summary | |
---|---|
static byte |
ALL
|
static byte |
CACHED
|
static byte |
FIXED
|
static byte |
NO_CACHE
|
static int |
POST_ATTACH
|
static int |
POST_CLEAR
|
static int |
POST_CREATE
|
static int |
POST_DELETE
|
static int |
POST_DETACH
|
static int |
POST_DIRTY
|
static int |
POST_LOAD
|
static int |
POST_NEW
|
static int |
POST_REMOVE
|
static int |
POST_UPDATE
|
static int |
PRE_ATTACH
|
static int |
PRE_CLEAR
|
static int |
PRE_CREATE
|
static int |
PRE_DELETE
|
static int |
PRE_DETACH
|
static int |
PRE_DIRTY
|
static int |
PRE_NEW
|
static int |
PRE_REMOVE
|
static int |
PRE_UPDATE
|
Fields inherited from interface org.objectweb.jorm.api.PClassMapping |
---|
CLEANUP_DONOTHING, CLEANUP_REMOVEALL, CLEANUP_REMOVEDATA, CREATE_STRUCTURE_IF_NEEDED |
Method Summary | |
---|---|
void |
addInstanceLifeCycleListener(java.lang.Object listener)
|
QueryDefinition |
addNamedQuery(java.lang.String name,
QueryDefinition query)
Defines a named query |
boolean |
allLoaded()
|
void |
attachCopy(PersistentObjectItf sp,
POManagerItf pm,
java.util.Map map,
java.lang.Object clone,
StateItf sa)
|
PersistentObjectItf |
detachCopy(PersistentObjectItf sp,
POManagerItf pm,
java.util.Map map,
java.lang.Object clone,
java.util.Collection fgHints)
|
java.util.Properties |
getClassProperties()
|
QueryDefinition |
getNamedQuery(java.lang.String name)
Retrieves a query defintion from its name. |
java.lang.String |
getPath()
|
POManagerFactoryItf |
getPOManagerFactory()
|
boolean |
getPrefetchOnExtent()
|
boolean |
getPrefetchOnGenClass()
|
boolean |
getPrefetchOnQuery()
|
java.lang.String |
getProjectName()
|
StateItf |
getState(PersistentObjectItf sp)
|
TransactionalPersistenceManager |
getTransactionalPersistenceManager()
|
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()
Indicates if the class has been marked as detacheable |
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. |
void |
removeInstanceLifeCycleListener(java.lang.Object listener)
|
QueryDefinition |
removeNamedQuery(java.lang.String name)
Remove a named query |
void |
sendEvent(int eventType,
java.lang.Object source,
java.lang.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)
It assignes a PersistenceManagerFactory |
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 |
StateItf |
writeIntention(PersistentObjectItf sp,
long[] fields)
|
StateItf |
writeIntention(PersistentObjectItf sp,
long[] fields,
java.lang.Object thinLock)
Notifies the transactional persistency manager of a write intention for the given persistent instance. |
Methods inherited from interface org.objectweb.jorm.api.PClassMapping |
---|
addAssociation, classDefined, configureRefFields, createPBinding, exist, getAssociationTable, getClassName, getClassPNameCoder, getDecodedPName, getGenClassMapping, getGenClassMapping, getIndexesTable, getMetaInfo, getPBinder, getPMapper, getPNameCoder, getPNameCoder, getPNameIterator, getPNameIterator, getPType, getSubPCMs, init, init, isConform, match, read, read, read, resolve, setPBinder, write |
Methods inherited from interface org.objectweb.speedo.usercache.api.UserCacheManager |
---|
activeUserCache, getActiveUserCache, getUserCache, getUserCache, userCacheEntryUnbound |
Methods inherited from interface org.objectweb.jorm.util.api.Loggable |
---|
getLogger, getLoggerFactory, setLogger, setLoggerFactory |
Field Detail |
---|
static final int PRE_NEW
static final int POST_NEW
static final int PRE_CREATE
static final int POST_CREATE
static final int PRE_REMOVE
static final int POST_REMOVE
static final int PRE_DELETE
static final int POST_DELETE
static final int POST_LOAD
static final int PRE_UPDATE
static final int POST_UPDATE
static final int PRE_CLEAR
static final int POST_CLEAR
static final int PRE_DIRTY
static final int POST_DIRTY
static final int PRE_DETACH
static final int POST_DETACH
static final int PRE_ATTACH
static final int POST_ATTACH
static final byte NO_CACHE
static final byte CACHED
static final byte FIXED
static final byte ALL
Method Detail |
---|
java.lang.String getProjectName()
getProjectName
in interface org.objectweb.jorm.api.PClassMapping
boolean isDetachable()
boolean isCacheable()
boolean hasToFix()
boolean allLoaded()
void setCachePolicy(byte v)
boolean isShareable()
void setShareable(boolean v)
boolean isFieldLockingLevel()
void setFieldLockingLevel(boolean val)
byte getVersioningStrategy()
speedo.metadata.SpeeedoVersion
,
speedo.metadata.SpeeedoVersion
,
NO_VERSION
POManagerFactoryItf getPOManagerFactory()
void setPOManagerFactory(POManagerFactoryItf _pmf)
_pmf
- is the PersistenceManagerFactory representing the data
support where the po is persistent.TransactionalPersistenceManager getTransactionalPersistenceManager()
void setTransactionalPersistenceManager(TransactionalPersistenceManager _tpm)
_tpm
- is the TransactionalPersistenceManager which manage the
concurrency, loading, ... of the po.StateItf readIntention(PersistentObjectItf sp, long[] fields)
sp
- is the PersistentObjectItf which the read access is requested.fields
- the ids of the fields that may be accessed by the caller
of this method. If the i-th bit of 'fields' is set to 1, then the i-th
field of the given speedo accessor may be accessed by the caller of this
method.StateItf writeIntention(PersistentObjectItf sp, long[] fields, java.lang.Object thinLock)
sp
- is the PersistentObjectItf which the write access is requested.fields
- the ids of the fields that may be accessed by the caller
of this method. If the i-th bit of 'fields' is set to 1, then the i-th
field of the given speedo accessor may be accessed by the caller of this
method.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.StateItf writeIntention(PersistentObjectItf sp, long[] fields)
StateItf getState(PersistentObjectItf sp)
PersistentObjectItf detachCopy(PersistentObjectItf sp, POManagerItf pm, java.util.Map map, java.lang.Object clone, java.util.Collection fgHints)
void attachCopy(PersistentObjectItf sp, POManagerItf pm, java.util.Map map, java.lang.Object clone, StateItf sa)
java.util.Properties getClassProperties()
QueryDefinition addNamedQuery(java.lang.String name, QueryDefinition query)
name
- is the name identifying the queryquery
- is the definition of the query
QueryDefinition removeNamedQuery(java.lang.String name)
name
- is the name of the query definition to remove
QueryDefinition getNamedQuery(java.lang.String name)
name
- is the name the wanted query definitionvoid initSH()
java.lang.String getPath()
void setPrefetchOnQuery(boolean prefetch)
boolean getPrefetchOnQuery()
void setPrefetchOnExtent(boolean prefetch)
boolean getPrefetchOnExtent()
void setPrefetchOnGenClass(boolean prefetch)
boolean getPrefetchOnGenClass()
void addInstanceLifeCycleListener(java.lang.Object listener)
void removeInstanceLifeCycleListener(java.lang.Object listener)
void sendEvent(int eventType, java.lang.Object source, java.lang.Object target)
boolean hasInstanceLifeCycleListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |