Index Configuration

Identifier:

Since:

Description:

Extension point for the definition of an index contribution. This extension is used by clients to configure entries for the indexing platform. The elements are:

1. structuralFeature: Attribute features (EAttribute) that need to be indexed for the specified EPackage. The nsURI attribute specifies the name space definition for the package. The features attribute is a comma separated list of feature names. In the current version clients have to specify only the attribute features that need to be indexed. The indexing platform by default will index all the reference features. The feature name is specified as the {EClass name}.{EAttribute name}. Please refer to the example shown below.
2. contentType: Content types whose associated file extensions and file names that need to be indexed. The typeIds attribute is a comma separated list of the content type ids whose supported file extensions and file names need to be indexed. The class attribute specifies the com.ibm.xtools.emf.index.provider.IIndexProviderFactory used to create the com.ibm.xtools.emf.index.provider.IIndexProvider objects. The index providers are used for creating index entries for files associated with these content type ids.
3. uriParser: The parser class associated with a specific URI scheme. The scheme attribute defines the URI scheme. The class attribute provides the com.ibm.xtools.emf.index.parser.IURIParser object to handle URIs with the specified scheme.
4. resources: Specifies statically deployed resources to be indexed. The resourceProvider element has a class attribute that provides the fully-qualified name of a class implementing the com.ibm.xtools.emf.index.provider.IResourceProvider interface.

Configuration Markup:

<!ELEMENT extension (structuralFeature* , contentType* , uriParser* , resources*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT structuralFeature EMPTY>

<!ATTLIST structuralFeature

nsURI    CDATA #REQUIRED

features CDATA #REQUIRED>

Specifies all the attribute features to be registered with the indexing platform

• nsURI - The name space definition of the EPackage where the specified attribute features (EAttribute)are declared.
• features - A comma separated list of attribute features (EAttribute) to index. The feature name is specified as the {EClass name}.{EAttribute name}

<!ELEMENT contentType EMPTY>

<!ATTLIST contentType

typeIds           CDATA #REQUIRED

class             CDATA #REQUIRED

interpretContents (true | false) >

Specifies all the content types to be registered with the indexing platform

• typeIds - A comma separated list of the content type ids whose supported file extensions and file names need to be indexed.
• class - This is a class that must extend com.ibm.xtools.emf.index.provider.AbstractIndexProviderFactory class. The factory provides the com.ibm.xtools.emf.index.provider.IIndexProvider instances for creating index entries.
• interpretContents - This optional attribute specifies if the determination of the content type should further involve consulting the platform's content-type manager to find the appropriate content type by inspecting the contents. This applies to scenarios where the file name or file extension is associated with multiple content types. For performance reasons, it is highly recomended to set this attribute only when necessary.

<!ELEMENT uriParser EMPTY>

<!ATTLIST uriParser

scheme CDATA #REQUIRED

class  CDATA #REQUIRED>

Specifies an index URI parser to be registered with the indexing platform

• scheme - The URI scheme associated with the parser.
• class - The parser class must extend the com.ibm.xtools.emf.index.parser.AbstractURIParser class.

<!ELEMENT resources (resource* , bundleResource* , resourceProvider*)>

Specifies statically deployed resources to be indexed.

<!ELEMENT resource EMPTY>

<!ATTLIST resource

uri CDATA #REQUIRED>

Specifies a literal resource URI.

• uri - The literal resource URI.

<!ELEMENT bundleResource EMPTY>

<!ATTLIST bundleResource

bundle CDATA #IMPLIED

path   CDATA #REQUIRED>

• bundle - The symbolic name of the bundle in which the resource is deployed, if different from the plug-in that defines this extension.
• path - The path (relative to the bundle root) of the resource.

<!ELEMENT resourceProvider EMPTY>

<!ATTLIST resourceProvider

class CDATA #REQUIRED>

• class - Fully-qualified name of a class implementing the IResourceProvider interface.

Examples:

     <extension
           point="com.ibm.xtools.emf.index.configurationEntries">
        <contentType
              class="com.ibm.xtools.emf.index.providers.XMIIndexProviderFactory"
              typeIds="org.eclipse.emf.examples.library.extendedLibrary"/>
        <structuralFeature
              features="Book.title,Writer.firstName,Writer.lastName,BookOnTape.title,Library.name"
              nsURI="http:///org/eclipse/emf/examples/library/extlibrary.ecore/1.0.0"/>
        <uriParser
              class="com.ibm.xtools.emf.index.examples.parser.PathMapParser"
              scheme="pathmap"/>
        <resources>
           <resource uri="pathmap://EXAMPLE_MODELS/Example1.extlibrary"/>
           <bundleResource
                 bundle="com.ibm.xtools.emf.index.examples"
                 path="/models/LibraryOfCongress.extlibrary"/>
        </resources>
     </extension>

API Information:

1. contentType: The class attribute for this element must extend com.ibm.xtools.emf.index.provider.AbstractIndexProviderFactory class.
2. uriParser: The class attribute for this element must extend the com.ibm.xtools.emf.index.parser.AbstractURIParser class.
3. resources: The resourceProvider element has a class attribute that must implement the com.ibm.xtools.emf.index.provider.IResourceProvider interface.

Supplied Implementation:

Copyright (c) 2004, 2018 Model RealTime, HCL and others. All Rights Reserved.