org.objectweb.speedo.api
Interface SpeedoGenClassProxy

All Superinterfaces:
SpeedoAccessor, SpeedoProxy
All Known Implementing Classes:
GenClass

public interface SpeedoGenClassProxy
extends SpeedoProxy

This interfaces represents a SpeedoProxy for a generic class (Collectio, Set, Map, ...) It permits to specify the mapper throught the generic class is persistent. The Mapper name permits to know the type of GenClassMapping and GenClassBinding (rdb, fos, ...). The PType of the generic class permit to known which is GenClassMapping instance to use.

Author:
S.Chassande-Barrioz

Method Summary
 java.lang.String jdoGetGenClassId()
           
 org.objectweb.jorm.type.api.PType jdoGetPType()
           
 void jdoSetLinkedField(java.lang.String lf)
          Assignes the linked field name for this generic class.
 void jdoSetMapperName(java.lang.String mn)
           
 org.objectweb.jorm.api.PBinding jdoSetPBinding()
           
 void jdoSetPBinding(org.objectweb.jorm.api.PBinding pb)
          assignes the PBinding to use to load/store the generic class Call this method with null value means that the generic is no more persistent.
 void jdoSetPType(org.objectweb.jorm.type.api.PType ptype)
          Assignes the PType of the generic class.
 void setInner(java.lang.Object o)
          Assignes the new value of the generic class (Collection, Map or Array or ...).
 
Methods inherited from interface org.objectweb.speedo.api.SpeedoProxy
getJormConfig, getSpeedoAccessor, getSpeedoAccessors, jdoDeletePersistent, jdoGePNameHints, jdoGetJdoFileName, jdoGetMapperName, jdoGetPersistenceManagerFactory, jdoGetPersistenceManagerSwitch, jdoGetProjectName, jdoGetTransactionalPersistenceManager, jdoIsActive, jdoIsActive, jdoIsContainerId, jdoLoadFieldsFromAccessor, jdoLoadFieldsInAccessor, jdoMakePersistent, jdoSetPersistenceManagerFactory, jdoSetPersistenceManagerSwitch, jdoSetPNameHints, jdoSetTransactionalPersistenceManager, removeSpeedoAccessor
 
Methods inherited from interface org.objectweb.speedo.api.SpeedoAccessor
jdoChangeStatus, jdoGetSpeedoProxy, jdoGetStatus, jdoGetTransaction, jdoSetSpeedoProxy, jdoSetStatus, jdoSetTransaction
 

Method Detail

jdoSetMapperName

public void jdoSetMapperName(java.lang.String mn)
Parameters:
mn - is the mapper name by which the instance is persistent.

jdoSetPType

public void jdoSetPType(org.objectweb.jorm.type.api.PType ptype)
Assignes the PType of the generic class.
Parameters:
ptype - of the generic class

jdoGetPType

public org.objectweb.jorm.type.api.PType jdoGetPType()
Returns:
the PType of the generic class.

jdoGetGenClassId

public java.lang.String jdoGetGenClassId()
Returns:
a string which represents the fully path of the persistent field of the class with wich the generic class is persistent. If the linked fiekf is the 'f1' provided by the class 'com.foo.Bar' then the returned string will be 'com.foo.Bar/f1'

jdoSetLinkedField

public void jdoSetLinkedField(java.lang.String lf)
Assignes the linked field name for this generic class.
Parameters:
lf - is tring which represents the fully path of the persistent field of the class with wich the generic class is persistent. If the linked fiekf is the 'f1' provided by the class 'com.foo.Bar' then the expected string is 'com.foo.Bar/f1'

jdoSetPBinding

public void jdoSetPBinding(org.objectweb.jorm.api.PBinding pb)
assignes the PBinding to use to load/store the generic class Call this method with null value means that the generic is no more persistent.
Parameters:
pb - is the PBinding.

jdoSetPBinding

public org.objectweb.jorm.api.PBinding jdoSetPBinding()
Returns:
the pbinding associated to the generic class. The value is not used if the generic class is not persistent.

setInner

public void setInner(java.lang.Object o)
Assignes the new value of the generic class (Collection, Map or Array or ...).