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

Interface IStructuredReferenceHandler

All Known Subinterfaces:

IStructuredReferenceProvider

All Known Implementing Classes:

AbstractCachingStructuredReferenceProvider

public interface IStructuredReferenceHandler

Interface to be implemented to provide a StructuredReference for specific Domain Element, and to resolve StructuredReference with a specific providerId to the domain Element.

Register the implementor of this interface with the com.ibm.xtools.mmi.core.StrcuturedReferenceProviders extension point, to enable StructuredReferenceService to consult this as and when required.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getInfo(java.lang.Object referencedContext, StructuredReference sRef, java.lang.String infoName) Returns the information requested for the specified StructuredReference.
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 sRefString) Gets the StructuredReference for the specified serialized form of the StructuredReference.
java.lang.Object	resolveToDomainElement(java.lang.Object referencedContext, StructuredReference sRef) Resolves the specified StructuredReference to appropriate domain element
void	setStructuredReferenceModifier(IStructuredReferenceModifier modifier) Called by StructuredReferenceService to set the IStructuredReferenceModifier for this handler.

Method Detail

resolveToDomainElement

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

Resolves the specified StructuredReference to appropriate domain element

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 the domain element isn't resolvable

getInfo

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

Returns the information requested for the specified StructuredReference.

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:

StructuredReferenceInfoConstants

getStructuredReference

StructuredReference getStructuredReference(java.lang.Object referencedContext,
                                           java.lang.String sRefString)

Gets the StructuredReference for the specified serialized form of the StructuredReference.

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

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

Gets the StructuredReference for the specified domain element.

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

setStructuredReferenceModifier

void setStructuredReferenceModifier(IStructuredReferenceModifier modifier)

Called by StructuredReferenceService to set the IStructuredReferenceModifier for this handler.

Parameters:

modifier - to be set in this handler.