com.ibm.xtools.emf.index.provider

Interface IIndexWriter

public interface 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 use this to add the created index entries to the index store. Clients can add individual entries or a collection of entries. Clients should not implement this interface.

See Also:

XMIIndexProvider, IndexSAXXMIHandler

Method Summary

Modifier and Type	Method and Description
void	addEntriesToIndex(java.util.Collection<IEntry> entries, org.eclipse.core.runtime.IProgressMonitor monitor) Adds the specified collection of index entries to the index store.
void	addEObjectEntryToIndex(IEObjectEntry entry, org.eclipse.core.runtime.IProgressMonitor monitor) Adds the specified index entry to the index store.
void	addIndexEntriesToIndex(java.util.Collection<IIndexEntry> entries, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. Use addEntriesToIndex(Collection, IProgressMonitor) instead.
void	addIndexEntryToIndex(IIndexEntry entry, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. Use addEObjectEntryToIndex(IEObjectEntry, IProgressMonitor) or addResourceEntryToIndex(IResourceEntry, IProgressMonitor) instead.
void	addResourceEntryToIndex(IResourceEntry entry, org.eclipse.core.runtime.IProgressMonitor monitor) Adds the specified index entry to the index store.
IEObjectEntry	createEObjectEntry(IndexContext context, org.eclipse.emf.common.util.URI containerURI, org.eclipse.emf.ecore.EClass eClass) Creates an EObject entry particular to this writer.
IResourceEntry	createResourceEntry(IndexContext context, org.eclipse.emf.common.util.URI resourceURI) Creates a resource entry particular to this writer.

Method Detail

addIndexEntriesToIndex

void addIndexEntriesToIndex(java.util.Collection<IIndexEntry> entries,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws IndexException

Deprecated. Use addEntriesToIndex(Collection, IProgressMonitor) instead.

Adds the specified collection of index entries to the index store

Parameters:

entries - the collection of index entries. Each entry is of type IIndexEntry

monitor - the progress monitor or null if none

Throws:

IndexException

addIndexEntryToIndex

void addIndexEntryToIndex(IIndexEntry entry,
                          org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws IndexException

Deprecated. Use addEObjectEntryToIndex(IEObjectEntry, IProgressMonitor) or addResourceEntryToIndex(IResourceEntry, IProgressMonitor) instead.

Adds the specified index entry to the index store

Parameters:

entry - the index entry to be added

monitor - the progress monitor or null if none

Throws:

IndexException

createEObjectEntry

IEObjectEntry createEObjectEntry(IndexContext context,
                                 org.eclipse.emf.common.util.URI containerURI,
                                 org.eclipse.emf.ecore.EClass eClass)

Creates an EObject entry particular to this writer. The entry is populated with data and passed to the addEntriesToIndex(Collection, IProgressMonitor) or addEObjectEntryToIndex(IEObjectEntry, IProgressMonitor).

Parameters:

context - The index context provided to the index provider.

containerURI - The URI of the container for this EObject (or null). Note that the URI should be normalized using IndexContext.normalize(URI, org.eclipse.emf.ecore.resource.ResourceSet).

eClass - The EClass of the EObject (must not be null).

Returns:

A new EObject entry that can be used by index providers to populate EObject data and by the index writer to push that data into the index.

createResourceEntry

IResourceEntry createResourceEntry(IndexContext context,
                                   org.eclipse.emf.common.util.URI resourceURI)

Creates a resource entry particular to this writer. The entry is populated with data and passed to the addEntriesToIndex(Collection, IProgressMonitor) or addResourceEntryToIndex(IResourceEntry, IProgressMonitor).

Parameters:

context - The index context provided to the index provider.

resourceURI - The URI of the resource in question. Note that the URI should be non-null and should be fully normalized using IndexContext.normalize(URI, org.eclipse.emf.ecore.resource.ResourceSet).

Returns:

A new resource entry that can be used by index providers to populate resource data and by the index writer to push that data into the index.

addEntriesToIndex

void addEntriesToIndex(java.util.Collection<IEntry> entries,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws IndexException

Adds the specified collection of index entries to the index store. The provided entries are created by calling createEObjectEntry(IndexContext, URI, EClass) or createResourceEntry(IndexContext, URI). No other types of entries should be provided here.

Parameters:

entries - the collection of index entries. Each entry is either of type IResourceEntry or IEObjectEntry.

monitor - the progress monitor or null if none

Throws:

IndexException

addEObjectEntryToIndex

void addEObjectEntryToIndex(IEObjectEntry entry,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws IndexException

Adds the specified index entry to the index store. The provided entry is created by calling createEObjectEntry(IndexContext, URI, EClass). No other types of EObject entries should be provided here.

Parameters:

entry - the index entry to be added

monitor - the progress monitor or null if none

Throws:

IndexException

addResourceEntryToIndex

void addResourceEntryToIndex(IResourceEntry entry,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws IndexException

Adds the specified index entry to the index store. The provided entry is created by calling createResourceEntry(IndexContext, URI). No other type of Resource entries should be provided here.

Parameters:

entry - the index entry to be added

monitor - the progress monitor or null if none

Throws:

IndexException