com.ibm.xtools.emf.index.xmi.providers

Class XMIIndexProvider2

java.lang.Object

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

com.ibm.xtools.emf.index.xmi.providers.XMIIndexProvider2

All Implemented Interfaces:

IIndexProvider

public class XMIIndexProvider2
extends AbstractIndexProvider

This class extends the AbstractIndexProvider class and is used for creating index entries by parsing/loading XMI files (files created using the org.eclipse.emf.ecore.xmi.impl.XMIResourceImpl class with ids). The XMIIndexProviderFactory class creates instances of this class within its createIndexProvider method.

Since:

7.6

See Also:

IIndexProvider

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
XMIIndexProvider2() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	createIndexEntriesByLoading(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.common.util.URI resourceURI, IIndexWriter indexWriterArg, 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 indexWriterArg, org.eclipse.core.runtime.IProgressMonitor monitor) Responsible for creating index entries by parsing the resource if possible.
protected IndexSAXXMIHandler2	createIndexSAXXMIHandler(org.eclipse.emf.ecore.xmi.XMIResource resource, org.eclipse.emf.ecore.resource.ResourceSet resourceSet, IIndexWriter indexWriterArg, org.eclipse.core.runtime.IProgressMonitor monitor) Returns a new instance of IndexSAXXMIHandler.
protected void	indexObjectAttributeData(org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EAttribute eAttribute, IEObjectEntry eObjectEntry, java.util.Set<org.eclipse.emf.common.util.URI> imports) Updates the specified EObjectEntry object with attribute information from the specified EObject for the specified attribute feature
protected IEObjectEntry	indexObjectLevelContents(org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.emf.ecore.EObject eObject, java.util.Set<org.eclipse.emf.common.util.URI> imports, org.eclipse.core.runtime.IProgressMonitor monitor) Returns an EObjectEntry object with the specified eObject's attribute and reference information.
protected void	indexObjectReferenceData(org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference reference, IEObjectEntry eObjectEntry, java.util.Set<org.eclipse.emf.common.util.URI> imports) Updates the specified EObjectEntry object with reference information from the specified EObject for the specified reference feature
protected IResourceEntry	indexResourceLevelContents(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.common.util.URI resourceURI, java.util.Set<org.eclipse.emf.common.util.URI> imports) Returns a ResourceEntry object that contains resource level information for the specified resource URI.

Methods inherited from class com.ibm.xtools.emf.index.provider.AbstractIndexProvider

createIndexEntries, dispose, getContext, getField, getField, getResourceSetForLoading, getResourceSetForParsing, init, shouldParseUsingContextResourceSet

Methods inherited from class java.lang.Object

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

Constructor Detail

XMIIndexProvider2

public XMIIndexProvider2()

Constructor

Method Detail

indexObjectAttributeData

protected void indexObjectAttributeData(org.eclipse.emf.ecore.resource.Resource resource,
                                        org.eclipse.emf.ecore.EObject eObject,
                                        org.eclipse.emf.ecore.EAttribute eAttribute,
                                        IEObjectEntry eObjectEntry,
                                        java.util.Set<org.eclipse.emf.common.util.URI> imports)

Updates the specified EObjectEntry object with attribute information from the specified EObject for the specified attribute feature

Parameters:

resource - the resource associated with the eObject

eObject - the eObject whose attribute information is updated in the entry

eAttribute - the eAttribute

eObjectEntry - the corresponding eObject entry that will be added to the index store

imports - a set to capture the imported resources

indexObjectLevelContents

protected IEObjectEntry indexObjectLevelContents(org.eclipse.emf.ecore.resource.Resource resource,
                                                 org.eclipse.emf.ecore.EObject eObject,
                                                 java.util.Set<org.eclipse.emf.common.util.URI> imports,
                                                 org.eclipse.core.runtime.IProgressMonitor monitor)

Returns an EObjectEntry object with the specified eObject's attribute and reference information.

Parameters:

resource - the resource associated with the eObject

eObject - the eObject whose attribute and reference information is updated in the entry

imports - a set to capture the imported resources

monitor - the progress monitor or null

Returns:

the created eObject entry

indexObjectReferenceData

protected void indexObjectReferenceData(org.eclipse.emf.ecore.resource.Resource resource,
                                        org.eclipse.emf.ecore.EObject eObject,
                                        org.eclipse.emf.ecore.EReference reference,
                                        IEObjectEntry eObjectEntry,
                                        java.util.Set<org.eclipse.emf.common.util.URI> imports)

Updates the specified EObjectEntry object with reference information from the specified EObject for the specified reference feature

Parameters:

resource - the resource associated with the eObject

eObject - the eObject whose reference information is updated in the entry

reference - the EReference

eObjectEntry - the corresponding eObject entry that will be added to the index store

imports - a set to capture the imported resources

indexResourceLevelContents

protected IResourceEntry indexResourceLevelContents(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                    org.eclipse.emf.common.util.URI resourceURI,
                                                    java.util.Set<org.eclipse.emf.common.util.URI> imports)

Returns a ResourceEntry object that contains resource level information for the specified resource URI.

Parameters:

resourceSet - the resource set

resourceURI - the resource uri

imports - the collection of uris that the specfied resource imports

Returns:

the resource entry object

createIndexEntriesByParsing

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

Description copied from class: AbstractIndexProvider

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.

Overrides:

createIndexEntriesByParsing in class AbstractIndexProvider

Parameters:

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

resourceURI - the resource uri

indexWriterArg - 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 indexWriterArg,
                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                    throws IndexException

Description copied from class: AbstractIndexProvider

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.

Overrides:

createIndexEntriesByLoading in class AbstractIndexProvider

Parameters:

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

resourceURI - the resource uri

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

monitor - the progress monitor

Throws:

IndexException

createIndexSAXXMIHandler

protected IndexSAXXMIHandler2 createIndexSAXXMIHandler(org.eclipse.emf.ecore.xmi.XMIResource resource,
                                                       org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                       IIndexWriter indexWriterArg,
                                                       org.eclipse.core.runtime.IProgressMonitor monitor)

Returns a new instance of IndexSAXXMIHandler. The instance is initialized with the specified arguments.

Parameters:

resource - the resource handle

resourceSet - the resource set used to parse the resource contents

indexWriterArg - the handle to the index store object for adding the index entries

monitor - the progress monitor or null

Returns:

the new instance of IndexSAXXMIHandler