com.ibm.xtools.mmi.core.ref

Class AbstractStructuredReferenceService

java.lang.Object

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

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

com.ibm.xtools.mmi.core.ref.AbstractStructuredReferenceService

All Implemented Interfaces:

java.util.EventListener, org.eclipse.gmf.runtime.common.core.service.IProvider, org.eclipse.gmf.runtime.common.core.service.IProviderChangeListener

Direct Known Subclasses:

StructuredReferenceService

public abstract class AbstractStructuredReferenceService
extends org.eclipse.gmf.runtime.common.core.service.Service

Base class for StructuredReferenceService. This is for internal usage.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.gmf.runtime.common.core.service.Service

org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor

Field Summary

Fields inherited from class org.eclipse.gmf.runtime.common.core.service.Service

INVALID_ELEMENT_MESSAGE_PATTERN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStructuredReferenceService(boolean optimized, boolean optimistic) Constructor

Method Summary

Modifier and Type	Method and Description
protected com.ibm.xtools.mmi.core.ref.StructuredReferenceModifier	createModifier(java.util.Set providerIds) Creates StructuredReferenceModifier for the specified providerIds
protected abstract StructuredReference	internalGetStructuredReferenceFromSRef(java.lang.Object referencedContext, java.lang.String sRefString, com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference reference) Finds an appropriate IStructuredReferenceHandler based on provider ID encoded in specified sRefString and returns the result of querying the StructuredReferenceService.

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

addProvider, clearCache, configureProviders, configureProviders, createPriorityCache, execute, executeUnique, getAllProviders, getCachingKey, getPriority, getProviders, isOptimistic, isOptimized, newProviderDescriptor, providerChanged, provides, provides, removeProvider

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

Constructor Detail

AbstractStructuredReferenceService

protected AbstractStructuredReferenceService(boolean optimized,
                                             boolean optimistic)

Constructor

Parameters:

optimized - Flag to make the service optimized

optimistic - Flag to make the service optimistic

Method Detail

createModifier

protected com.ibm.xtools.mmi.core.ref.StructuredReferenceModifier createModifier(java.util.Set providerIds)

Creates StructuredReferenceModifier for the specified providerIds

Parameters:

providerIds - Provider Ids for the modifier.

Returns:

newly created StructuredReferenceModifier

internalGetStructuredReferenceFromSRef

protected abstract StructuredReference internalGetStructuredReferenceFromSRef(java.lang.Object referencedContext,
                                                                              java.lang.String sRefString,
                                                                              com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference reference)

Finds an appropriate IStructuredReferenceHandler based on provider ID encoded in specified sRefString and returns the result of querying the StructuredReferenceService.

Parameters:

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

sRefString - serialized form of the StructuredReference

reference - the StructuredReference to check the cache for

Returns:

StructuredReference for the specified sRefString