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
- {@link com.ibm.xtools.emf.index.provider.AbstractIndexProvider}:
An abstract implementation of
IIndexProvider
. This class
needs to be extended by clients for creating the index entries for their
supported resources
- {@link com.ibm.xtools.emf.index.provider.AbstractIndexProviderFactory}:
A default implementation of
IIndexProviderFactory
. This class
needs to be extended by clients for providing IIndexProvider
s
that create index entries for their resources
- {@link com.ibm.xtools.emf.index.provider.IIndexConfigurationManager}:
This is the interface used to query the information related to the configured
index contributions. Clients do not have to implement this interface.
- {@link com.ibm.xtools.emf.index.provider.IIndexEntry}:
Represents an indexable entry in the index store. The
IIndexProvider
creates
these entries while parsing/loading the resource.
- {@link com.ibm.xtools.emf.index.provider.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.
- {@link com.ibm.xtools.emf.index.provider.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
- {@link com.ibm.xtools.emf.index.provider.IIndexProviderFactory}:
A factory for creating
IIndexProvider
s for parsing/loading the resources
and creating index entries. Clients do not have implement this interface.
Clients should extend the AbstractIndexProviderFactory
class
- {@link com.ibm.xtools.emf.index.provider.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.
- {@link com.ibm.xtools.emf.index.provider.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.
- {@link com.ibm.xtools.emf.index.provider.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.
- {@link com.ibm.xtools.emf.index.provider.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
- {@link com.ibm.xtools.emf.index.provider.IIndexWriter}:
A handle to the index store for adding index entries. This interface is passed to the
{@link com.ibm.xtools.emf.index.provider.IIndexProvider#createIndexEntries(org.eclipse.emf.common.util.URI, IIndexWriter, IProgressMonitor)}
method. Clients do not have to implement this interface