org.castor.persist.resolver
Class ManyRelationResolver

java.lang.Object
  org.castor.persist.resolver.ManyRelationResolver

All Implemented Interfaces:

ResolverStrategy

Direct Known Subclasses:

ManyToManyRelationResolver, OneToManyRelationResolver

public abstract class ManyRelationResolver
extends Object
implements ResolverStrategy

Implementation of ResolverStrategy for many relations. This class carries behaviour common to 1:M and M:N relations.

Since:

0.9.9

Author:

Werner Guttmann

Field Summary

protected ClassMolder	_classMolder Associated ClassMolder.
protected FieldMolder	_fieldMolder Associated FieldMolder.

Constructor Summary

ManyRelationResolver(ClassMolder classMolder, FieldMolder fieldMolder, int fieldIndex, boolean debug)
Creates an instance of ManyRelationResolver.

Method Summary

Object	create(TransactionContext tx, Object object) Create an object of the base class with specified identity into the persistence storage.
void	expireCache(TransactionContext tx, Object field) Inspect the fields stored in the object passed as an argument for contained objects.
void	load(TransactionContext tx, OID oid, ProposedEntity proposedObject, AccessMode suggestedAccessMode) Load an object with specified identity from the persistent storage.
abstract boolean	markCreate(TransactionContext tx, OID oid, Object object) Walk the object model and mark object that should be created.
abstract void	markDelete(TransactionContext tx, Object object, Object field) Prepare to delete an object with the specified identity.
abstract Object	postCreate(TransactionContext tx, OID oid, Object object, Object field, Identity createdId) Called after successful creation of an object of the base class.
abstract UpdateFlags	preStore(TransactionContext tx, OID oid, Object object, int timeout, Object field) Check the object for modification.
UpdateAndRemovedFlags	removeRelation(TransactionContext tx, Object object, ClassMolder relatedMolder, Object relatedObject) Remove the reference of a related object from an object of the base class.
void	revertObject(TransactionContext tx, OID oid, Object object, Object field) Revert the object back to the state of begining of the transaction If the object is loaded, it will be revert as it was loaded.
Object	store(TransactionContext tx, Object object, Object field) Store a data object into the persistent storage of the base class of this ClassMolder.
abstract void	update(TransactionContext tx, OID oid, Object object, AccessMode suggestedAccessMode, Object field) Update the object which loaded or created in the other transaction to the persistent storage.
Object	updateCache(TransactionContext tx, OID oid, Object object) Update the dirty checking cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.castor.persist.resolver.ResolverStrategy

updateWhenNoTimestampSet

Field Detail

_classMolder

protected ClassMolder _classMolder

Associated ClassMolder.

_fieldMolder

protected FieldMolder _fieldMolder

Associated FieldMolder.

Constructor Detail

ManyRelationResolver

public ManyRelationResolver(ClassMolder classMolder,
                            FieldMolder fieldMolder,
                            int fieldIndex,
                            boolean debug)

Creates an instance of ManyRelationResolver.

Parameters:

classMolder - Associated ClassMolder

fieldMolder - Associated FieldMolder

fieldIndex - Field index within all fields of parent class molder.

debug - ???

Method Detail

create

public final Object create(TransactionContext tx,
                           Object object)

Description copied from interface: ResolverStrategy

Create an object of the base class with specified identity into the persistence storage.

Specified by:

create in interface ResolverStrategy

Parameters:

tx - transaction in action

object - the object to be created

Returns:

the identity of the object

See Also:

#create(org.castor.persist.TransactionContext, java.lang.Object)

markCreate

public abstract boolean markCreate(TransactionContext tx,
                                   OID oid,
                                   Object object)
                            throws PersistenceException

Description copied from interface: ResolverStrategy

Walk the object model and mark object that should be created.

Specified by:

markCreate in interface ResolverStrategy

Parameters:

tx - transaction in action

oid - the object identity of the object to be created.

object - the object to be created

Returns:

true if there's objects that should be created

Throws:

PersistenceException

See Also:

ResolverStrategy.markCreate( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object)

preStore

public abstract UpdateFlags preStore(TransactionContext tx,
                                     OID oid,
                                     Object object,
                                     int timeout,
                                     Object field)
                              throws PersistenceException

Description copied from interface: ResolverStrategy

Check the object for modification. If dpendent object is dereferenced, it method will remove the object thru the transaction. If an related object is dereferenced, it method will make sure the formally object will be dereferenced from the other side as well. This method is called in prepare (for commit) state of the transaction. This method indicates if the object needed to be persist or cache should be update using TransactionContext.markDelete.

Specified by:

preStore in interface ResolverStrategy

Parameters:

tx - transaction in action

oid - the object identity of the object

object - the data object to be checked

timeout - timeout of updating the lock if needed

field - The field value as returned by the SQLEngine

Returns:

true if the object is modified

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.preStore( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object, int, java.lang.Object)

store

public final Object store(TransactionContext tx,
                          Object object,
                          Object field)

Description copied from interface: ResolverStrategy

Store a data object into the persistent storage of the base class of this ClassMolder.

Specified by:

store in interface ResolverStrategy

Parameters:

tx - Transaction in action

object - the object to be stored

field - The field value as returned by the SQLEngine

See Also:

ResolverStrategy.store( org.castor.persist.TransactionContext, java.lang.Object, java.lang.Object)

update

public abstract void update(TransactionContext tx,
                            OID oid,
                            Object object,
                            AccessMode suggestedAccessMode,
                            Object field)
                     throws PersistenceException

Description copied from interface: ResolverStrategy

Update the object which loaded or created in the other transaction to the persistent storage.

Specified by:

update in interface ResolverStrategy

Parameters:

tx - Transaction in action

oid - the object identity of the stored object

object - the object to be stored

suggestedAccessMode - Suggested access mode

field - The field value as returned by the SQLEngine

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.update( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object, org.exolab.castor.mapping.AccessMode, java.lang.Object)

updateCache

public final Object updateCache(TransactionContext tx,
                                OID oid,
                                Object object)

Description copied from interface: ResolverStrategy

Update the dirty checking cache. This method is called after a transaction completed successfully.

Specified by:

updateCache in interface ResolverStrategy

Parameters:

tx - - transaction in action

oid - - object's identity of the target object

object - - the target object

Returns:

The object tha twas stored in the cache previously.

See Also:

ResolverStrategy.updateCache( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object)

markDelete

public abstract void markDelete(TransactionContext tx,
                                Object object,
                                Object field)
                         throws PersistenceException

Description copied from interface: ResolverStrategy

Prepare to delete an object with the specified identity. If any sub-object should be deleted along with the target object, it should be deleted by this method.

Specified by:

markDelete in interface ResolverStrategy

Parameters:

tx - - transaction in action

object - - the target object

field - The field value as returned by the SQLEngine

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.markDelete( org.castor.persist.TransactionContext, java.lang.Object, java.lang.Object)

revertObject

public final void revertObject(TransactionContext tx,
                               OID oid,
                               Object object,
                               Object field)
                        throws PersistenceException

Description copied from interface: ResolverStrategy

Revert the object back to the state of begining of the transaction If the object is loaded, it will be revert as it was loaded. If the object is created, it will be revert as it was just created.

Specified by:

revertObject in interface ResolverStrategy

Parameters:

tx - - transaction in action

oid - - the object identity of the target object

object - - the target object

field - The field value as returned by the SQLEngine

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.revertObject( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object, java.lang.Object)

expireCache

public final void expireCache(TransactionContext tx,
                              Object field)
                       throws PersistenceException

Description copied from interface: ResolverStrategy

Inspect the fields stored in the object passed as an argument for contained objects. Request an expireCache for each contained object.

Specified by:

expireCache in interface ResolverStrategy

Parameters:

tx - The TransactionContext

field - The field value as returned by the SQLEngine

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.expireCache( org.castor.persist.TransactionContext, java.lang.Object)

load

public final void load(TransactionContext tx,
                       OID oid,
                       ProposedEntity proposedObject,
                       AccessMode suggestedAccessMode)
                throws PersistenceException

Description copied from interface: ResolverStrategy

Load an object with specified identity from the persistent storage.

Specified by:

load in interface ResolverStrategy

Parameters:

tx - the TransactionContext in action

oid - the object identity of the desired object

proposedObject - Object holder storing information about assumed and actual object instances.

suggestedAccessMode - the acessMode for the object

Throws:

PersistenceException - If it is not possible to successfully complete this method.

See Also:

ResolverStrategy.load( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, org.castor.persist.ProposedEntity, org.exolab.castor.mapping.AccessMode)

postCreate

public abstract Object postCreate(TransactionContext tx,
                                  OID oid,
                                  Object object,
                                  Object field,
                                  Identity createdId)
                           throws PersistenceException

Description copied from interface: ResolverStrategy

Called after successful creation of an object of the base class.

Specified by:

postCreate in interface ResolverStrategy

Parameters:

tx - transaction in action

oid - the object identity of the object to be created.

object - the object to be created

field - The field value as returned by the SQLEngine

createdId - ???

Returns:

the identity of the object

Throws:

PersistenceException

See Also:

ResolverStrategy.postCreate( org.castor.persist.TransactionContext, org.exolab.castor.persist.OID, java.lang.Object, java.lang.Object, org.exolab.castor.persist.spi.Identity)

removeRelation

public final UpdateAndRemovedFlags removeRelation(TransactionContext tx,
                                                  Object object,
                                                  ClassMolder relatedMolder,
                                                  Object relatedObject)

Description copied from interface: ResolverStrategy

Remove the reference of a related object from an object of the base class.

If the related object is PersistanceCapable, the field will be set null. If the related object is a Collection, then the related object will be removed from the Collection.

If any changed occured, transactionContext.markModified will be called, to indicate the object is modified.

It method will iterate thur all of the object's field and try to remove all the occurrence.

Specified by:

removeRelation in interface ResolverStrategy

Parameters:

tx - the TransactionContext of the transaction in action

object - the target object of the base type of this ClassMolder

relatedMolder - the ClassMolder of the related object to be removed from the object

relatedObject - the object to be removed

Returns:

Various flags related to updating/removing object instances.

See Also:

ResolverStrategy.removeRelation( org.castor.persist.TransactionContext, java.lang.Object, org.exolab.castor.persist.ClassMolder, java.lang.Object)