Structured Reference Providers

Identifier:

com.ibm.xtools.mmi.core.StructuredReferenceProviders

Since:

This extension point is new to Version 7.0.

Description:

This extension point is used to define com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceProviders for com.ibm.xtools.mmi.core.ref.StructuredReferenceService

StructuredReferenceService provides a mechanism to get a com.ibm.xtools.mmi.core.ref.StructuredReference for a given domain Element, and to resolve any given StructuredReference to a domain Element. To perform these operations, StructuredReferenceService finds appropriate com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceProvider based on the handler id encoded in StructuredReference, or the type of domain element and then delegates the call to the IStructuredReferenceProvider.

StructuredReferenceProviders extension point allows provider writers to register their com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceProvider implementation and provide basic information about what their provider does. The basic information that can be provided is what domain elements can be transformed to StructuredReference and what StructuredReference can be resolved to domain elements.

Configuration Markup:

<!ELEMENT extension (StructuredReferenceProvider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - A fully qualified identifier of the target extension point
id - An optional identifier of the extension instance
name - An optional name of the extension instance

<!ELEMENT StructuredReferenceProvider (StructuredReferenceProviderId+ , DomainElementType* , Priority?)>

<!ATTLIST StructuredReferenceProvider

class CDATA #REQUIRED>

class - Class implementing com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceProvider

<!ELEMENT Priority EMPTY>

<!ATTLIST Priority

name (Lowest|Low|Medium|High|Highest) >

name - Priority of this provider.

<!ELEMENT StructuredReferenceProviderId EMPTY>

<!ATTLIST StructuredReferenceProviderId

id CDATA #REQUIRED>

id - Id of the provider.

<!ELEMENT DomainElementType EMPTY>

<!ATTLIST DomainElementType

class CDATA #REQUIRED>

class - Type of the element for which this provider can provider StructuredReference

Examples:

Following is an example of a StructuredReferenceProvider configuration:


   <extension
         id="illustrationStructuredReferenceProvider"
         name="Illustration StructuredReference Provider"
         point="com.ibm.xtools.mmi.core.StructuredReferenceProviders">
      <StructuredReferenceProvider
            class="com.ibm.xtools.mmi.core.illustration.IllustrationSRefProvider">
         <StructuredReferenceProviderId
               id="com.ibm.xtools.mmi.core.illustration">
         </StructuredReferenceProviderId>
         <DomainElementType
               class="org.eclipse.pde.core.plugin.IPlugin">
         </DomainElementType>
      </StructuredReferenceProvider>
   </extension>

If this extension was defined in a plug-in with id "com.ibm.xtools.mmi.core.illustration", the fully qualified name of this StructuredReferenceProvider would be "com.ibm.xtools.mmi.core.illustration.illustrationStructuredReferenceProvider".

API Information:

The value of the class attribute in StructuredReferenceProvider element must represent a subclass of com.ibm.xtools.mmi.core.services.ref.IStructuredReferenceProvider.

Supplied Implementation:

The platform itself does not have any predefined StructuredReferenceProviders. Particular product installs may include StructuredReferenceProviders as required. Please see the Example PDE Visualizer for an example StructuredReferenceProvider.