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

Class StructuredReferenceService

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

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

All Implemented Interfaces:

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

public class StructuredReferenceService
extends AbstractStructuredReferenceService

This service is to provide StructuredReference for the specified domain element, and to resolve specified StructuredReference to a domain Element. This service consults all IStructuredReferenceHandler and IStructuredReferenceProvider registered with with com.ibm.xtools.mmi.core.StructuredReferenceProviders extension point. The registered IStructuredReferenceHandler are assumed to be at ProviderPriority.MEDIUM.

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	getCachingKey(org.eclipse.gmf.runtime.common.core.service.IOperation operation)
IStructuredReferenceHandler	getHandler(java.lang.String providerId) Returns an instance of IStructuredReferenceHandler for the specified providerId,
static java.lang.Object	getInfo(java.lang.Object referencedContext, StructuredReference sRef, java.lang.String infoName) Finds an appropriate IStructuredReferenceHandler for specified StructuredReference and returns the result of call to IStructuredReferenceHandler.getInfo(Object, StructuredReference, String)
static StructuredReferenceService	getInstance() Returns the shared instance of the StructuredReferenceService
java.lang.String	getPriority(org.eclipse.core.runtime.IConfigurationElement element)
static StructuredReference	getStructuredReference(java.lang.Object referencedContext, java.lang.Object domainElement) Finds an appropriate IStructuredReferenceHandler for specified Domain element, and returns the result of the call to IStructuredReferenceHandler.getStructuredReference(Object, Object)
static StructuredReference	getStructuredReferenceFromURI(java.lang.Object referencedContext, java.lang.String sRefString) Finds an appropriate IStructuredReferenceHandler based on provider ID encoded in specified sRefString and returns the result of the call to IStructuredReferenceHandler.getStructuredReference(Object, String)
protected 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.
protected org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor	newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement element)
static java.lang.Object	resolveToDomainElement(java.lang.Object referencedContext, StructuredReference sRef) Finds an appropriate IStructuredReferenceHandler for specified StructuredReference and returns the result of the call to IStructuredReferenceHandler.resolveToDomainElement(Object, StructuredReference)

Methods inherited from class com.ibm.xtools.mmi.core.ref.AbstractStructuredReferenceService

createModifier

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

addProvider, clearCache, configureProviders, configureProviders, createPriorityCache, execute, executeUnique, getAllProviders, getProviders, isOptimistic, isOptimized, 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

Method Detail

getInstance

public static final StructuredReferenceService getInstance()

Returns the shared instance of the StructuredReferenceService

Returns:

StructuredReferenceService, the shared instance of the StructuredReferenceService

internalGetStructuredReferenceFromSRef

protected 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.

Specified by:

internalGetStructuredReferenceFromSRef in class AbstractStructuredReferenceService

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

getStructuredReferenceFromURI

public static StructuredReference getStructuredReferenceFromURI(java.lang.Object referencedContext,
                                                                java.lang.String sRefString)

Finds an appropriate IStructuredReferenceHandler based on provider ID encoded in specified sRefString and returns the result of the call to IStructuredReferenceHandler.getStructuredReference(Object, String)

Parameters:

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

sRefString - serialized form of the StructuredReference

Returns:

StructuredReference for the specified sRefString

getStructuredReference

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

Finds an appropriate IStructuredReferenceHandler for specified Domain element, and returns the result of the call to IStructuredReferenceHandler.getStructuredReference(Object, Object)

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

See Also:

IStructuredReferenceHandler.getStructuredReference(Object, Object)

resolveToDomainElement

public static java.lang.Object resolveToDomainElement(java.lang.Object referencedContext,
                                                      StructuredReference sRef)

Finds an appropriate IStructuredReferenceHandler for specified StructuredReference and returns the result of the call to IStructuredReferenceHandler.resolveToDomainElement(Object, StructuredReference)

Parameters:

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

sRef - StructuredReference for which the domain element is requested.

Returns:

Domain Element for the specified StructuredReference, or null if no IStructuredReferenceHandler is found or sRef is unresolvable.

See Also:

IStructuredReferenceHandler.resolveToDomainElement(Object, StructuredReference)

getInfo

public static java.lang.Object getInfo(java.lang.Object referencedContext,
                                       StructuredReference sRef,
                                       java.lang.String infoName)

Finds an appropriate IStructuredReferenceHandler for specified StructuredReference and returns the result of call to IStructuredReferenceHandler.getInfo(Object, StructuredReference, String)

Parameters:

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

sRef - StructuredReference for which the information is required.

infoName - Identifier for the information requested, usually constants defined in StructuredReferenceInfoConstants

Returns:

value of the Information requested.

See Also:

IStructuredReferenceHandler.getInfo(Object, StructuredReference, String)

newProviderDescriptor

protected org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement element)

Overrides:

newProviderDescriptor in class org.eclipse.gmf.runtime.common.core.service.Service

See Also:

Service.newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement)

getPriority

public java.lang.String getPriority(org.eclipse.core.runtime.IConfigurationElement element)

Overrides:

getPriority in class org.eclipse.gmf.runtime.common.core.service.Service

getCachingKey

protected java.lang.Object getCachingKey(org.eclipse.gmf.runtime.common.core.service.IOperation operation)

Overrides:

getCachingKey in class org.eclipse.gmf.runtime.common.core.service.Service

getHandler

public IStructuredReferenceHandler getHandler(java.lang.String providerId)

Returns an instance of IStructuredReferenceHandler for the specified providerId,

Parameters:

providerId - Provider Id for the requested IStructuredReferenceHandler

Returns:

IStructuredReferenceHandler