PersistenceHelperPlugin Interface
- public interface PersistenceHelperPlugin
Interface for Persistence Helper Plugin
A specific driver must be written for each type of persistence cache.
This is not a required optimization for CMP or BMP.
public void |
-
clearRelationalBinding(String attributeIdentifier, Collection collection, EntityImpl entityImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Map map, EntityImpl entityImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Collection collection, Object o, EntityImpl entityImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Map map, Object key, EntityImpl entityImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Collection collection, BelongingImpl belongingImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Map map, BelongingImpl belongingImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Collection collection, Object o, BelongingImpl belongingImpl)
|
public void |
-
clearRelationalBinding(String attributeIdentifier, Map map, Object key, BelongingImpl belongingImpl)
|
public SmartCollectionReference |
-
createSmartCollectionReference(String attributeIdentifier, SmartCollectionReference targetInstance, EntityImpl entityImpl)
|
public SmartCollectionReference |
-
createSmartCollectionReference(String attributeIdentifier, SmartCollectionReference targetInstance, SessionImpl sessionImpl)
|
public SmartCollectionReference |
-
createSmartCollectionReference(String attributeIdentifier, SmartCollectionReference targetInstance, BelongingImpl belonging)
|
public SmartEntityReference |
-
createSmartEntityReference(String attributeIdentifier, SmartEntityReference targetInstance, EntityImpl entityImpl)
|
public SmartEntityReference |
-
createSmartEntityReference(String attributeIdentifier, SmartEntityReference targetInstance, SessionImpl sessionImpl)
|
public SmartEntityReference |
-
createSmartEntityReference(String attributeIdentifier, SmartEntityReference targetInstance, BelongingImpl belonging)
|
public SmartMapReference |
-
createSmartMapReference(String attributeIdentifier, SmartMapReference targetInstance, EntityImpl entityImpl)
|
public SmartMapReference |
-
createSmartMapReference(String attributeIdentifier, SmartMapReference targetInstance, SessionImpl sessionImpl)
|
public SmartMapReference |
-
createSmartMapReference(String attributeIdentifier, SmartMapReference targetInstance, BelongingImpl belonging)
|
public Belonging |
-
doRelationalBinding(String attributeIdentifier, Belonging value, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public Object |
-
doRelationalBinding(String attributeIdentifier, Object value, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public void |
-
doRelationalBinding(String attributeIdentifier, EJBObject ejbObject, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public Belonging |
-
doRelationalBinding(String attributeIdentifier, Belonging value, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public Object |
-
doRelationalBinding(String attributeIdentifier, Object value, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public void |
-
doRelationalBinding(String attributeIdentifier, EJBObject ejbObject, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public Belonging |
-
doRelationalBindingWithMapKey(String attributeIdentifier, Belonging value, Object mapKey, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public Object |
-
doRelationalBindingWithMapKey(String attributeIdentifier, Object value, Object mapKey, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public void |
-
doRelationalBindingWithMapKey(String attributeIdentifier, EJBObject ejbObject, Object mapKey, EntityImpl entityImpl)
- The dependent object will have additional information for object-relational mapping
|
public Belonging |
-
doRelationalBindingWithMapKey(String attributeIdentifier, Belonging value, Object mapKey, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public Object |
-
doRelationalBindingWithMapKey(String attributeIdentifier, Object value, Object mapKey, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public void |
-
doRelationalBindingWithMapKey(String attributeIdentifier, EJBObject ejbObject, Object mapKey, EJBObject parent, BelongingImpl belongingImpl)
- The dependent object will have additional information for object-relational mapping
|
public Belonging |
-
synchronizeWithCache(String attributeIdentifier, Belonging value, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
public Object |
-
synchronizeWithCache(String attributeIdentifier, Object value, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
public Collection |
-
synchronizeWithCache(String attributeIdentifier, Collection collection, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
public Map |
-
synchronizeWithCache(String attributeIdentifier, Map map, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
public Belonging |
-
synchronizeWithCache(Belonging value, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
public Object |
-
synchronizeWithCache(Object value, EntityImpl entityImpl)
- Optimize the dependent object in the persistence cache
|
clearRelationalBinding(String, Collection, EntityImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Collection collection,
EntityImpl entityImpl)
clearRelationalBinding(String, Map, EntityImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Map map,
EntityImpl entityImpl)
clearRelationalBinding(String, Collection, Object, EntityImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Collection collection,
Object o,
EntityImpl entityImpl)
clearRelationalBinding(String, Map, Object, EntityImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Map map,
Object key,
EntityImpl entityImpl)
clearRelationalBinding(String, Collection, BelongingImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Collection collection,
BelongingImpl belongingImpl)
clearRelationalBinding(String, Map, BelongingImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Map map,
BelongingImpl belongingImpl)
clearRelationalBinding(String, Collection, Object, BelongingImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Collection collection,
Object o,
BelongingImpl belongingImpl)
clearRelationalBinding(String, Map, Object, BelongingImpl) Method
public void clearRelationalBinding(String attributeIdentifier,
Map map,
Object key,
BelongingImpl belongingImpl)
createSmartCollectionReference(String, SmartCollectionReference, EntityImpl) Method
public SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
SmartCollectionReference targetInstance,
EntityImpl entityImpl)
createSmartCollectionReference(String, SmartCollectionReference, SessionImpl) Method
public SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
SmartCollectionReference targetInstance,
SessionImpl sessionImpl)
createSmartCollectionReference(String, SmartCollectionReference, BelongingImpl) Method
public SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
SmartCollectionReference targetInstance,
BelongingImpl belonging)
createSmartEntityReference(String, SmartEntityReference, EntityImpl) Method
public SmartEntityReference createSmartEntityReference(String attributeIdentifier,
SmartEntityReference targetInstance,
EntityImpl entityImpl)
createSmartEntityReference(String, SmartEntityReference, SessionImpl) Method
public SmartEntityReference createSmartEntityReference(String attributeIdentifier,
SmartEntityReference targetInstance,
SessionImpl sessionImpl)
createSmartEntityReference(String, SmartEntityReference, BelongingImpl) Method
public SmartEntityReference createSmartEntityReference(String attributeIdentifier,
SmartEntityReference targetInstance,
BelongingImpl belonging)
createSmartMapReference(String, SmartMapReference, EntityImpl) Method
public SmartMapReference createSmartMapReference(String attributeIdentifier,
SmartMapReference targetInstance,
EntityImpl entityImpl)
createSmartMapReference(String, SmartMapReference, SessionImpl) Method
public SmartMapReference createSmartMapReference(String attributeIdentifier,
SmartMapReference targetInstance,
SessionImpl sessionImpl)
createSmartMapReference(String, SmartMapReference, BelongingImpl) Method
public SmartMapReference createSmartMapReference(String attributeIdentifier,
SmartMapReference targetInstance,
BelongingImpl belonging)
doRelationalBinding(String, Belonging, EntityImpl) Method
public Belonging doRelationalBinding(String attributeIdentifier,
Belonging value,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBinding(String, Object, EntityImpl) Method
public Object doRelationalBinding(String attributeIdentifier,
Object value,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBinding(String, EJBObject, EntityImpl) Method
public void doRelationalBinding(String attributeIdentifier,
EJBObject ejbObject,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param ejbObject instance of a remote interface * @param entityImpl implementation of an entity bean
doRelationalBinding(String, Belonging, EJBObject, BelongingImpl) Method
public Belonging doRelationalBinding(String attributeIdentifier,
Belonging value,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBinding(String, Object, EJBObject, BelongingImpl) Method
public Object doRelationalBinding(String attributeIdentifier,
Object value,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBinding(String, EJBObject, EJBObject, BelongingImpl) Method
public void doRelationalBinding(String attributeIdentifier,
EJBObject ejbObject,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param ejbObject instance of a remote interface * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, Belonging, Object, EntityImpl) Method
public Belonging doRelationalBindingWithMapKey(String attributeIdentifier,
Belonging value,
Object mapKey,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, Object, Object, EntityImpl) Method
public Object doRelationalBindingWithMapKey(String attributeIdentifier,
Object value,
Object mapKey,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, EJBObject, Object, EntityImpl) Method
public void doRelationalBindingWithMapKey(String attributeIdentifier,
EJBObject ejbObject,
Object mapKey,
EntityImpl entityImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param ejbObject instance of a remote interface * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, Belonging, Object, EJBObject, BelongingImpl) Method
public Belonging doRelationalBindingWithMapKey(String attributeIdentifier,
Belonging value,
Object mapKey,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, Object, Object, EJBObject, BelongingImpl) Method
public Object doRelationalBindingWithMapKey(String attributeIdentifier,
Object value,
Object mapKey,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
doRelationalBindingWithMapKey(String, EJBObject, Object, EJBObject, BelongingImpl) Method
public void doRelationalBindingWithMapKey(String attributeIdentifier,
EJBObject ejbObject,
Object mapKey,
EJBObject parent,
BelongingImpl belongingImpl)
The dependent object will have additional information for object-relational mapping
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param ejbObject instance of a remote interface * @param entityImpl implementation of an entity bean
synchronizeWithCache(String, Belonging, EntityImpl) Method
public Belonging synchronizeWithCache(String attributeIdentifier,
Belonging value,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
synchronizeWithCache(String, Object, EntityImpl) Method
public Object synchronizeWithCache(String attributeIdentifier,
Object value,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
synchronizeWithCache(String, Collection, EntityImpl) Method
public Collection synchronizeWithCache(String attributeIdentifier,
Collection collection,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
synchronizeWithCache(String, Map, EntityImpl) Method
public Map synchronizeWithCache(String attributeIdentifier,
Map map,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
attributeIdentifier
- identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean
synchronizeWithCache(Belonging, EntityImpl) Method
public Belonging synchronizeWithCache(Belonging value,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
value
- instance of a belonging * @param entityImpl implementation of an entity bean
synchronizeWithCache(Object, EntityImpl) Method
public Object synchronizeWithCache(Object value,
EntityImpl entityImpl)
Optimize the dependent object in the persistence cache
Parameters
-
value
- instance of a belonging * @param entityImpl implementation of an entity bean