Package com.ibm.xtools.emf.index.provider

This package defines the classes and interfaces for the configuration of index contributions.

See: Description

Interface Summary

Interface	Description
IEntry	Represents an index entry that will be used to store EMF data that will be placed into an index.
IEObjectEntry	An entry interface for capturing the EObject information.
IIndexConfigurationManager	This is the primary interface used by clients to query information related to the configured index contributions.
IIndexEntry	Deprecated Use the factory methods IIndexWriter.createEObjectEntry(com.ibm.xtools.emf.index.search.IndexContext, org.eclipse.emf.common.util.URI, org.eclipse.emf.ecore.EClass) and IIndexWriter.createResourceEntry(com.ibm.xtools.emf.index.search.IndexContext, org.eclipse.emf.common.util.URI) instead.
IIndexProvider	This is the inteface that is returned by the IIndexProviderFactory for given content type to parse/load the resource and create index entries.
IIndexProviderFactory	A factory for creating IIndexProviders for parsing/loading the resources and creating index entries.
IIndexWriter	A handle to the index store for adding index entries.
IResourceEntry	An index entry interface for capturing the resource level information.
IResourceProvider	Interface for an object declared on the com.ibm.xtools.emf.index.configurationEntries extension point to provide URIs for resources that should be indexed.
ISessionIndexProvider	This interface extends the original index provider interface to facilitate disk index session level state caching.

Class Summary

Class	Description
AbstractIndexEntry	Deprecated Use IIndexWriter.createEObjectEntry(IndexContext, org.eclipse.emf.common.util.URI, org.eclipse.emf.ecore.EClass) and IIndexWriter.createResourceEntry(IndexContext, org.eclipse.emf.common.util.URI) instead.
AbstractIndexProvider	An abstract implementation of IIndexProvider.
AbstractIndexProviderFactory	A default implementation of IIndexProviderFactory.
EObjectEntry	Deprecated Use the factory method IIndexWriter.createEObjectEntry(IndexContext, URI, EClass) instead.
ResourceEntry	Deprecated Use the factory method IIndexWriter.createResourceEntry(IndexContext, URI) instead.

Exception Summary

Exception	Description
AbortParsingException	This exception is intended to be thrown during parsing of the resource to create index entries.

Package com.ibm.xtools.emf.index.provider Description

This package defines the classes and interfaces for the configuration of index contributions. The extension point "com.ibm.xtools.emf.index.configurationEntries" requires the clients to implement the interfaces or extend the classes defined in this package

Package Specification

• AbstractIndexProvider: An abstract implementation of IIndexProvider. This class needs to be extended by clients for creating the index entries for their supported resources
• AbstractIndexProviderFactory: A default implementation of IIndexProviderFactory. This class needs to be extended by clients for providing IIndexProviders that create index entries for their resources
• IIndexConfigurationManager: This is the interface used to query the information related to the configured index contributions. Clients do not have to implement this interface.
• IIndexEntry: Represents an indexable entry in the index store. The IIndexProvider creates these entries while parsing/loading the resource.
• AbstractIndexEntry: An abstract implementation of IIndexEntry. Clients need not extend this class. Clients should create instances of EObjectEntry and ResourceEntry classes to create the index entries.
• IIndexProvider: This is the inteface that is returned by the IIndexProviderFactory for the given content type to parse/load the resource. Clients do not need to implement this interface. Clients should extend the AbstractIndexProvider class
• IIndexProviderFactory: A factory for creating IIndexProviders for parsing/loading the resources and creating index entries. Clients do not have implement this interface. Clients should extend the AbstractIndexProviderFactory class
• AbortParsingException: This exception is intended to be thrown while creating index entries by parsing the resource. If this exception is thrown then the AbstractIndexProvider will try to load the resource to create the index entries.
• EObjectEntry: An implementation of IIndexEntry for capturing the EObject information. This class should be used by the IIndexProvider to create index entries associated with each EObject within the resource.
• ResourceEntry: An implementation of IIndexEntry for capturing the resource level information. This class should be used by the IIndexProvider to create a entry for capturing resource level information.
• IResourceProvider: Interface for an object declared on the com.ibm.xtools.emf.index.configurationEntries extension point to provide URIs for resources that should be indexed
• IIndexWriter: A handle to the index store for adding index entries. This interface is passed to the IIndexProvider.createIndexEntries(org.eclipse.emf.common.util.URI, IIndexWriter, IProgressMonitor) method. Clients do not have to implement this interface