com.ibm.xtools.mmi.core.services.ref

Class AbstractCachingStructuredReferenceProvider

java.lang.Object

org.eclipse.gmf.runtime.common.core.service.AbstractProvider

com.ibm.xtools.mmi.core.services.ref.AbstractCachingStructuredReferenceProvider

All Implemented Interfaces:

IStructuredReferenceHandler, IStructuredReferenceProvider, org.eclipse.gmf.runtime.common.core.service.IProvider

public abstract class AbstractCachingStructuredReferenceProvider
extends org.eclipse.gmf.runtime.common.core.service.AbstractProvider
implements IStructuredReferenceProvider

An abstract implementation of IStructuredReferenceProvider, which supports caching of StructuredReference per Referenced Context.

Constructor Summary

Constructors

Constructor and Description
AbstractCachingStructuredReferenceProvider() Constructor
AbstractCachingStructuredReferenceProvider(boolean useFastCompareForSupportingSRefs) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addSupportingStructuredReference(java.lang.Object referencedContext, StructuredReference structRef, StructuredReference supportingStructRef)
protected void	cleanup() Perform a cleanup by polling the reference queue.
protected abstract StructuredReference	constructStructuredReference(java.lang.Object referencedContext, java.lang.Object domainElement) Constructs a new StructuredReference for the specified domainElement
protected StructuredReference	constructStructuredReference(java.lang.Object referencedContext, java.lang.String sRefFragment) Construct a StructuredReference for the specified serialized form of the StructuredReference.
protected IStructuredReferenceModifier	getModifier() Returns the IStructuredReferenceModifier for this StructuredReferenceHandler.
StructuredReference	getStructuredReference(java.lang.Object referencedContext, java.lang.Object domainElement) Gets the StructuredReference for the specified domain element.
StructuredReference	getStructuredReference(java.lang.Object referencedContext, java.lang.String structRefString) Gets the StructuredReference for the specified serialized form of the StructuredReference.
protected StructuredReference	getStructuredReference(java.lang.Object referencedContext, StructuredReference newStructRef) Returns the StructuredReference from the cache if one exists, else returns newStructRef
protected java.util.Map	getStructuredReferencesCache(java.lang.Object referencedContext) Returns the cache of Structured References given a referencedContext
boolean	provides(org.eclipse.gmf.runtime.common.core.service.IOperation operation)
protected void	putStructuredReferencesCache(java.lang.Object referencedContext, java.util.Map referenceCache) Puts a new Structured Reference in the cache for specified referencedContext
protected void	removeSupportingStructuredReference(java.lang.Object referencedContext, StructuredReference structRef, int index)
protected void	removeSupportingStructuredReference(java.lang.Object referencedContext, StructuredReference structRef, StructuredReference supportingStructRef)
protected void	setProperty(java.lang.Object referencedContext, StructuredReference structRef, java.lang.String name, java.lang.String value)
void	setStructuredReferenceModifier(IStructuredReferenceModifier modifier) Sets the IStructuredReferenceModifier
protected void	uncache(java.lang.Object referencedContext, StructuredReference structRefKey) Removes the specified StructuredReference from the cache corresponding to referencedContext
protected void	verifyCache(java.lang.Object referencedContext, StructuredReference newStructRef, java.lang.String oldKey) Verifies the consistency of the cache

Methods inherited from class org.eclipse.gmf.runtime.common.core.service.AbstractProvider

addProviderChangeListener, fireProviderChange, removeProviderChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider

addProviderChangeListener, removeProviderChangeListener

Methods inherited from interface com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceHandler

getInfo, resolveToDomainElement

Constructor Detail

AbstractCachingStructuredReferenceProvider

public AbstractCachingStructuredReferenceProvider()

Constructor

AbstractCachingStructuredReferenceProvider

public AbstractCachingStructuredReferenceProvider(boolean useFastCompareForSupportingSRefs)

Constructor

Parameters:

useFastCompareForSupportingSRefs - true to enable fast comparison, supported when supporting SRef list is ordered and would contain identical objects, i.e. supporting SRefs must be of the same instance. When false, default collection comparison, typically the equals() method, will take place.

Method Detail

getStructuredReferencesCache

protected java.util.Map getStructuredReferencesCache(java.lang.Object referencedContext)

Returns the cache of Structured References given a referencedContext

Parameters:

referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomain

Returns:

A Map whose key is String and value is a list of StructuredReferences.

putStructuredReferencesCache

protected void putStructuredReferencesCache(java.lang.Object referencedContext,
                                            java.util.Map referenceCache)

Puts a new Structured Reference in the cache for specified referencedContext

Parameters:

referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomain

referenceCache - A new cache for specified referencedContext

getStructuredReference

public StructuredReference getStructuredReference(java.lang.Object referencedContext,
                                                  java.lang.Object domainElement)

Gets the StructuredReference for the specified domain element. Constructs a new StructuredReference by invoking constructStructuredReference(Object, Object), and returns the newly created StructuredReference or an equal one from the cache.

Specified by:

getStructuredReference in interface IStructuredReferenceHandler

Parameters:

referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomain

domainElement - Domain Element for which the StructuredReference is requested

Returns:

StructuredReference for the specified domainElement

getStructuredReference

public StructuredReference getStructuredReference(java.lang.Object referencedContext,
                                                  java.lang.String structRefString)

Gets the StructuredReference for the specified serialized form of the StructuredReference. Returns the cached StructuredReference if one already exists in the cache

Specified by:

getStructuredReference in interface IStructuredReferenceHandler

Parameters:

referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomain

structRefString - serialized form of the StructuredReference

Returns:

StructuredReference for the specified sRefString

getStructuredReference

protected StructuredReference getStructuredReference(java.lang.Object referencedContext,
                                                     StructuredReference newStructRef)

Returns the StructuredReference from the cache if one exists, else returns newStructRef

Parameters:

newStructRef - corresponding to the structRefString

Returns:

cached StructuredReference equal to specified StructuredReference or the specified StructuredReference.

constructStructuredReference

protected abstract StructuredReference constructStructuredReference(java.lang.Object referencedContext,
                                                                    java.lang.Object domainElement)

Constructs a new StructuredReference for the specified domainElement

Parameters:

domainElement - Domain Element for which the StructuredReference is requested.

Returns:

newly created StructuredReference

setStructuredReferenceModifier

public void setStructuredReferenceModifier(IStructuredReferenceModifier modifier)

Sets the IStructuredReferenceModifier

Specified by:

setStructuredReferenceModifier in interface IStructuredReferenceHandler

Parameters:

modifier - the IStructuredReferenceModifier to set

getModifier

protected IStructuredReferenceModifier getModifier()

Returns the IStructuredReferenceModifier for this StructuredReferenceHandler.

uncache

protected void uncache(java.lang.Object referencedContext,
                       StructuredReference structRefKey)

Removes the specified StructuredReference from the cache corresponding to referencedContext

Parameters:

referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomain

structRefKey - StructuredReference to be removed from the cache

constructStructuredReference

protected final StructuredReference constructStructuredReference(java.lang.Object referencedContext,
                                                                 java.lang.String sRefFragment)

Construct a StructuredReference for the specified serialized form of the StructuredReference. The supporting Structured References of the newly constructed StructuredReference are retrieved from the cache if it exists, else a new one is created.

Parameters:

sRefFragment - serialized form of the StructuredReference

Returns:

newly constructed StructuredReference

cleanup

protected void cleanup()

Perform a cleanup by polling the reference queue.

verifyCache

protected void verifyCache(java.lang.Object referencedContext,
                           StructuredReference newStructRef,
                           java.lang.String oldKey)

Verifies the consistency of the cache

addSupportingStructuredReference

protected void addSupportingStructuredReference(java.lang.Object referencedContext,
                                                StructuredReference structRef,
                                                StructuredReference supportingStructRef)

removeSupportingStructuredReference

protected void removeSupportingStructuredReference(java.lang.Object referencedContext,
                                                   StructuredReference structRef,
                                                   int index)

removeSupportingStructuredReference

protected void removeSupportingStructuredReference(java.lang.Object referencedContext,
                                                   StructuredReference structRef,
                                                   StructuredReference supportingStructRef)

setProperty

protected void setProperty(java.lang.Object referencedContext,
                           StructuredReference structRef,
                           java.lang.String name,
                           java.lang.String value)

provides

public boolean provides(org.eclipse.gmf.runtime.common.core.service.IOperation operation)

Specified by:

provides in interface org.eclipse.gmf.runtime.common.core.service.IProvider