com.ibm.xtools.emf.index.provider

Interface IIndexProvider

All Known Subinterfaces:

ISessionIndexProvider

All Known Implementing Classes:

AbstractIndexProvider, XMIIndexProvider, XMIIndexProvider2

public interface IIndexProvider

This is the inteface that is returned by the IIndexProviderFactory for given content type to parse/load the resource and create index entries. The index provider is invoked for the associated content type to provide a collection of index entries for the resource. Clients should not implement this interface. Clients should extend the AbstractIndexProvider class.

See Also:

EObject, Resource, IIndexEntry, ResourceSet, IIndexConfigurationManager, IndexException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATT_LC_PREFIX Constant for using as the field for capturing lower case values of attribute features that are of string type.
static java.lang.String	ATT_PREFIX Constant prefix for the EObject's attribute fields.
static java.lang.String	CONTAINER Constant for the EObject's container field.
static java.lang.String	ECLASS Constant for the EObject's EClass field.
static java.lang.String	IMPORTS Constant for the resource imports field.
static java.lang.String	OBJ_RES_URI Constant for the EObject resource URI field.
static java.lang.String	OBJ_URI Constant for the EObject's URI field.
static java.lang.String	REFC_PREFIX Constant prefix for the EObject's containment reference fields.
static java.lang.String	REFNC_PREFIX Constant prefix for the EObject's non-containment reference fields.
static java.lang.String	RES_URI Constant for the resource URI field.

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.
void	dispose() Disposes the index provider.
void	init(IndexContext context) Initializes the index provider with the current index context

Field Detail

RES_URI

static final java.lang.String RES_URI

Constant for the resource URI field. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

OBJ_RES_URI

static final java.lang.String OBJ_RES_URI

Constant for the EObject resource URI field. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

IMPORTS

static final java.lang.String IMPORTS

Constant for the resource imports field. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

ECLASS

static final java.lang.String ECLASS

Constant for the EObject's EClass field. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

OBJ_URI

static final java.lang.String OBJ_URI

Constant for the EObject's URI field. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

CONTAINER

static final java.lang.String CONTAINER

Constant for the EObject's container field. If no container then this field should not created. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

ATT_PREFIX

static final java.lang.String ATT_PREFIX

Constant prefix for the EObject's attribute fields. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

REFC_PREFIX

static final java.lang.String REFC_PREFIX

Constant prefix for the EObject's containment reference fields. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

REFNC_PREFIX

static final java.lang.String REFNC_PREFIX

Constant prefix for the EObject's non-containment reference fields. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

ATT_LC_PREFIX

static final java.lang.String ATT_LC_PREFIX

Constant for using as the field for capturing lower case values of attribute features that are of string type. Note that this field is not intended to be used by clients.

See Also:

Constant Field Values

Method Detail

init

void init(IndexContext context)
   throws IndexException

Initializes the index provider with the current index context

Parameters:

context - the index context

Throws:

IndexException

dispose

void dispose()
      throws IndexException

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

Throws:

IndexException

createIndexEntries

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

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.

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