com.ibm.xtools.emf.index.provider

Class AbstractIndexProvider

java.lang.Object

com.ibm.xtools.emf.index.provider.AbstractIndexProvider

All Implemented Interfaces:

IIndexProvider

Direct Known Subclasses:

XMIIndexProvider, XMIIndexProvider2

public class AbstractIndexProvider
extends java.lang.Object
implements IIndexProvider

An abstract implementation of IIndexProvider. This class needs to be extended by clients for providing the index entries for their supported resources. For XMI resources refer to XMIIndexProvider class that parses the XMI artifact instead of loading the resource. The index entries for a given resource should include a IResourceEntry and every eObject in the resource should have a corresponding IEObjectEntry.

Usage:

                Create a resource entry:
                IResourceEntry resourceEntry = indexWriter.createResourceEntry(getContext(), resourceURI);
                
                Add imports to the entry:
                resourceEntry.addImport(importingResourceURI);
                
                Create an EObject entry:
                IEObjectEntry eObjectEntry = indexWriter.createEObjectEntry(getContext(), containerURI, eClassifier);
                
                Add reference value to the entry:
                eObjectEntry.addEReferenceValue(eReference, referencingEObjectURI);
                
                Add attribute value to the entry:
                eObjectEntry.addEAttributeValue(eAttribute, value);
 

See Also:

IIndexProvider, XMIIndexProvider, IIndexWriter

Field Summary

Fields inherited from interface com.ibm.xtools.emf.index.provider.IIndexProvider

ATT_LC_PREFIX, ATT_PREFIX, CONTAINER, ECLASS, IMPORTS, OBJ_RES_URI, OBJ_URI, REFC_PREFIX, REFNC_PREFIX, RES_URI

Constructor Summary

Constructors

Constructor and Description
AbstractIndexProvider() Constructor

Method Summary

Modifier and Type	Method and Description
void	createIndexEntries(org.eclipse.emf.common.util.URI resourceURI, IIndexWriter indexWriter, org.eclipse.core.runtime.IProgressMonitor monitor) Creates index entries for the specified resource URI.
protected void	createIndexEntriesByLoading(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.common.util.URI resourceURI, IIndexWriter indexWriter, org.eclipse.core.runtime.IProgressMonitor monitor) Responsible for creating index entries by loading the resource.
protected void	createIndexEntriesByParsing(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.common.util.URI resourceURI, IIndexWriter indexWriter, org.eclipse.core.runtime.IProgressMonitor monitor) Responsible for creating index entries by parsing the resource if possible.
void	dispose() Disposes the index provider.
protected IndexContext	getContext() Returns the current index context
static java.lang.String	getField(org.eclipse.emf.ecore.EAttribute eAttribute, java.lang.String attributePrefix) Get the computed field name for the specified attribute.
static java.lang.String	getField(org.eclipse.emf.ecore.EReference eReference) Get the computed field name for the specified reference.
protected org.eclipse.emf.ecore.resource.ResourceSet	getResourceSetForLoading(org.eclipse.emf.ecore.resource.ResourceSet defaultResourceSet) Returns the resource set for loading the resource and creating the index entries.
protected org.eclipse.emf.ecore.resource.ResourceSet	getResourceSetForParsing(org.eclipse.emf.ecore.resource.ResourceSet defaultResourceSet) Returns the resource set for parsing the resource and creating the index entries.
void	init(IndexContext context) Initializes the index provider with the current index context
protected boolean	shouldParseUsingContextResourceSet(org.eclipse.emf.common.util.URI resourceURI) Determines whether the context resource set should be used to find a loaded (and unmodified) resource in order to create EObject entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractIndexProvider

public AbstractIndexProvider()

Constructor

Method Detail

createIndexEntries

public final void createIndexEntries(org.eclipse.emf.common.util.URI resourceURI,
                                     IIndexWriter indexWriter,
                                     org.eclipse.core.runtime.IProgressMonitor monitor)
                              throws IndexException

Description copied from interface: IIndexProvider

Creates index entries for the specified resource URI. The specified IIndexWriter is used to add the index entries to the index store. A request to cancel the operation should be honored and acknowledged by throwing OperationCanceledException.

Specified by:

createIndexEntries in interface IIndexProvider

Parameters:

resourceURI - The resource URI that needs to be indexed

indexWriter - the index writer used to add the index entries to the index store.

monitor - the progress monitor

Throws:

IndexException

shouldParseUsingContextResourceSet

protected boolean shouldParseUsingContextResourceSet(org.eclipse.emf.common.util.URI resourceURI)

Determines whether the context resource set should be used to find a loaded (and unmodified) resource in order to create EObject entries.

Parameters:

resourceURI - The resourceURI to be indexed

Returns:

true, if the context resource set should be used or false if the resource should be parsed using the standard approach (ie. checking to see if the resource can be parsed first followed by attempting to load it into a private resource set).

createIndexEntriesByParsing

protected void createIndexEntriesByParsing(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                           org.eclipse.emf.common.util.URI resourceURI,
                                           IIndexWriter indexWriter,
                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                    throws IndexException

Responsible for creating index entries by parsing the resource if possible. This method should use the specified IIndexWriter to add the index entries to the index store. This method should throw a AbortParsingException if parsing is not possible. This will cause the resource to be loaded in order to create the index entries. A request to cancel the operation should be honored and acknowledged by throwing OperationCanceledException.

Parameters:

resourceSet - the resource set to be used for parsing the resource

resourceURI - the resource uri

indexWriter - the index writer to be used for adding the index entries to the index store

monitor - the progress monitor

Throws:

IndexException

createIndexEntriesByLoading

protected void createIndexEntriesByLoading(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                           org.eclipse.emf.common.util.URI resourceURI,
                                           IIndexWriter indexWriter,
                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                    throws IndexException

Responsible for creating index entries by loading the resource. This method should use the specified IIndexWriter to add the index entries to the index store. A request to cancel the operation should be honored and acknowledged by throwing OperationCanceledException.

Parameters:

resourceSet - the resource set to be used for loading the resource

resourceURI - the resource uri

indexWriter - the index writer to be used for adding the index entries to the index store

monitor - the progress monitor

Throws:

IndexException

getResourceSetForLoading

protected org.eclipse.emf.ecore.resource.ResourceSet getResourceSetForLoading(org.eclipse.emf.ecore.resource.ResourceSet defaultResourceSet)

Returns the resource set for loading the resource and creating the index entries. The default resource set that is passed in corresponds to the resource set that comes from the index context passed to the index infrastructure. Clients can override this to provide a new resource set to load the resource so that the default resource set is not modified.

Parameters:

defaultResourceSet - the resource set associated with the index context

Returns:

the resource set for loading the resource

getResourceSetForParsing

protected org.eclipse.emf.ecore.resource.ResourceSet getResourceSetForParsing(org.eclipse.emf.ecore.resource.ResourceSet defaultResourceSet)

Returns the resource set for parsing the resource and creating the index entries. The default resource set that is passed in corresponds to the resource set that comes from the index context passed to the index infrastructure. Clients can override this to provide a new resource set to parse the resource so that the default resource set is not modified.

Parameters:

defaultResourceSet - the resource set associated with the index context

Returns:

the resource set for loading the resource

dispose

public void dispose()
             throws IndexException

Description copied from interface: IIndexProvider

Disposes the index provider. This is the method called after invoking IIndexProvider.createIndexEntries(URI, IIndexWriter, IProgressMonitor) method. Within this method a provider may release any resources and clear any cache held by this provider.

Specified by:

dispose in interface IIndexProvider

Throws:

IndexException

init

public void init(IndexContext context)
          throws IndexException

Description copied from interface: IIndexProvider

Initializes the index provider with the current index context

Specified by:

init in interface IIndexProvider

Parameters:

context - the index context

Throws:

IndexException

getContext

protected final IndexContext getContext()

Returns the current index context

Returns:

the context

getField

public static final java.lang.String getField(org.eclipse.emf.ecore.EAttribute eAttribute,
                                              java.lang.String attributePrefix)

Get the computed field name for the specified attribute. This method is use in the EObjectEntry class.

Note that this method is not intended to be called by clients. In some cases the field name returned by this method will not be consistent with other places in the index.

Parameters:

eAttribute - the specified EAttribute

attributePrefix - the attribute prefix. This is either IIndexProvider.ATT_PREFIX or IIndexProvider.ATT_LC_PREFIX

Returns:

returns the field name used in the index store

getField

public static final java.lang.String getField(org.eclipse.emf.ecore.EReference eReference)

Get the computed field name for the specified reference. This method is use in the EObjectEntry class.

Note that this method is not intended to be called by clients. In some case the field name returned by this method will not be consistent with other places in the index.

Parameters:

eReference - the specified EReference

Returns:

returns the field name used in the index store