com.ibm.xtools.emf.index.search

Interface IIndexSearchManager

public interface IIndexSearchManager

The central query interface of the index and search infrastructure. All functionality is provided by a static instance. The index search manager requires an index context in order to perform the queries. The manager will execute the query on loaded resources within the context resource set and optionally include results from the unloaded resources as well.

The queries are executed synchronously by default. All the methods take in a progress monitor through which the progress is reported. Alternatively the utility class QueryJob can be used to execute the queries asynchronously.

Usage:

             Run a query synchronously:
              try {
                  IRunnableWithProgress runnable = new IRunnableWithProgress() {
                      public void run(IProgressMonitor monitor) throws java.lang.reflect.InvocationTargetException,InterruptedException {
                          //create an index context:
                          IndexContext context = IndexContext.createDefaultContext(new ResourceSetImpl());
                          context.getOptions().put(IndexContext.SEARCH_UNLOADED_RESOURCES, Boolean.TRUE);
                          context.getOptions().put(IndexContext.RESOLVE_PROXIES, Boolean.FALSE);
                      
                          BookOnTape b1 = getBookOnTape(); // The EObject
                          
                          try {
                              Collection objects = IIndexSearchManager.INSTANCE.findReferencedEObjects(context, b1,
                              EXTLibraryPackage.eINSTANCE.getBookOnTape_Author(), EXTLibraryPackage.eINSTANCE.getWriter(), monitor);
                          } catch (IndexException ) {
                              // Handle the exception
                          }
                     };
                  };
                  
                  new ProgressMonitorDialog(workbenchWindow.getShell()).run(false, true, runnable);
              } catch (InvocationTargetException e) {
                  // handle exception
              } catch (InterruptedException e) {
                  // handle exception
              }
 

             Run a query asynchronously: 
              Create the job:
               QueryJob job = new QueryJob("Example Query") {
                   protected Collection doRun(IProgressMonitor monitor) {
                       // create the index context
                       IndexContext context = IndexContext.createDefaultContext(new ResourceSetImpl());
                            
                       // run the query
                       Collection result = Collections.EMPTY_LIST;
                       result = IIndexSearchManager.INSTANCE.findEObjects(context, EXTLibraryPackage.eINSTANCE.
                       .getBookOnTape(), monitor);
                            
                       // return the result
                       return result;
                   };
               };
             
              Schedule the job:
               job.schedule();
               
              Get the results:
               job.getResults();   
 

Field Summary

Fields

Modifier and Type	Field and Description
static IIndexSearchManager	INSTANCE The following variable provides access to the one instance of the Index Manager.

Method Summary

Modifier and Type	Method and Description
<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>>	findAllContainedEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return map of EObjects to their contained objects of the given type starting at the specified EObject and recursively their contained eObjects at the given containment reference feature.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findAllExports(IndexContext context, org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that directly import the given resource and recursively their exports.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findAllImports(IndexContext context, org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that are directly imported by a given resource and recursively their imports.
<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>>	findAllReferencedEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return map of EObjects to their referenced objects of the given type starting at the specified EObject and recursively their references at the given reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>>	findAllReferencingEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return map of EObjects to their referencers of the given type starting at the specified EObject and recursively their referencers at the given reference feature.
<T1,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>>	findContainedEObjects(IndexContext context, java.util.Collection<T1> eObjectsOrURIs, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that are contained by the collection of specified EObjects at the given containment reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findContainedEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that are contained by the given EObject at the given containment reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findContainedEObjects(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that are referenced by the given URI at the given containment reference feature.
<T1 extends org.eclipse.emf.ecore.EObject,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,T2>	findContainer(IndexContext context, java.util.Collection<T1> eObjects, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return the containers of the given EObjects.
<T extends org.eclipse.emf.ecore.EObject> T	findContainer(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return the container of the given EObject.
<T extends org.eclipse.emf.ecore.EObject> T	findContainer(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return the container of the given EObject's URI.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findEObjects(IndexContext context, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findEObjects(IndexContext context, java.lang.Object value, org.eclipse.emf.ecore.EAttribute eAttribute, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that reference the given value at the given attribute feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findEObjects(IndexContext context, java.lang.String pattern, boolean ignoreCase, org.eclipse.emf.ecore.EAttribute eAttributeFeature, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the specified class type that reference string values containing the specified pattern through the given attribute feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findEObjects(IndexContext context, java.lang.String uriFragment, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) Return the EObjects that resolve for the given URI URI.fragment() fragment.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findExports(IndexContext context, org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that directly import the given resource.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findImports(IndexContext context, org.eclipse.emf.ecore.resource.Resource resource, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that are directly imported by a given resource.
<T1 extends org.eclipse.emf.ecore.EObject,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>>	findReferencedEObjects(IndexContext context, java.util.Collection<T1> eObjects, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method returns a map of EObjects to their referenced eObjects of the given type that reference objects in the given collection at the given non-containment reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findReferencedEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that are referenced by the given EObject at the given non-containment reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findReferencedEObjects(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given class type that are referenced by the given URI at the given non-containment reference feature.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findReferencedResources(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all resources that are referenced by the given EObject.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findReferencedResources(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all resources that are referenced by the given EObject URI.
<T1,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>>	findReferencingEObjects(IndexContext context, java.util.Collection<T1> eObjectsOrUris, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method returns a map of EObjects to their referencers of the given type that reference objects in the given collection of eObjects at the given reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findReferencingEObjects(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given type that reference a given EObject at the given reference feature.
<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T>	findReferencingEObjects(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.emf.ecore.EReference eReference, org.eclipse.emf.ecore.EClass eClass, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all EObjects of the given type that reference a given URI at the given reference feature.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findReferencingResources(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that directly reference the given EObject.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	findReferencingResources(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return all the resources that directly reference the given EObject URI.
<T1 extends org.eclipse.emf.ecore.EObject,T2> java.util.Map<T1,T2>	findValue(IndexContext context, java.util.Collection<T1> eObjects, org.eclipse.emf.ecore.EAttribute eAttribute, org.eclipse.core.runtime.IProgressMonitor monitor) This method returns a map of EObjects to their values for the given attribute feature
<T> T	findValue(IndexContext context, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EAttribute eAttribute, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return the value of the given attribute feature given an EObject.
<T> T	findValue(IndexContext context, org.eclipse.emf.common.util.URI uri, org.eclipse.emf.ecore.EAttribute eAttribute, org.eclipse.core.runtime.IProgressMonitor monitor) This method will return the value of the given attribute feature given a EObject's URI.

Field Detail

INSTANCE

static final IIndexSearchManager INSTANCE

The following variable provides access to the one instance of the Index Manager.

Method Detail

findImports

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findImports(IndexContext context,
                                                                          org.eclipse.emf.ecore.resource.Resource resource,
                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                   throws IndexException

This method will return all the resources that are directly imported by a given resource. The context is used to restrict the results to the given scope.

Parameters:

context - The context of the search.

resource - The importing resource.

monitor - the progress monitor or null

Returns:

All the resources that are directly imported by the given resource.

Throws:

IndexException

findExports

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findExports(IndexContext context,
                                                                          org.eclipse.emf.ecore.resource.Resource resource,
                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                   throws IndexException

This method will return all the resources that directly import the given resource. The context is used to restrict the results to the given scope.

Parameters:

context - The context of the search.

resource - The imported resource.

monitor - the progress monitor or null

Returns:

All the resources that directly import the given resource.

Throws:

IndexException

findAllImports

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findAllImports(IndexContext context,
                                                                             org.eclipse.emf.ecore.resource.Resource resource,
                                                                             org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                      throws IndexException

This method will return all the resources that are directly imported by a given resource and recursively their imports. The context is used to restrict the results to the given scope.

Parameters:

context - The context of the search.

resource - The importing resource.

monitor - the progress monitor or null

Returns:

All the resources that are directly imported by the given resource and recursively their imports.

Throws:

IndexException

findAllExports

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findAllExports(IndexContext context,
                                                                             org.eclipse.emf.ecore.resource.Resource resource,
                                                                             org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                      throws IndexException

This method will return all the resources that directly import the given resource and recursively their exports. The context is used to restrict the results to the given scope.

Parameters:

context - The context of the search.

resource - the imported resource

monitor - the progress monitor or null

Returns:

All the resources that directly import the given resource and recursively their exports.

Throws:

IndexException

findReferencingResources

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findReferencingResources(IndexContext context,
                                                                                       org.eclipse.emf.ecore.EObject eObject,
                                                                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                throws IndexException

This method will return all the resources that directly reference the given EObject. The context is used to restrict the results to the given scope. The EObject argument can be a proxy object.

Parameters:

context - The context of the search.

eObject - The referenced EObject

monitor - the progress monitor or null

Returns:

All the resources that directly reference the given EObject.

Throws:

IndexException

findReferencingResources

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findReferencingResources(IndexContext context,
                                                                                       org.eclipse.emf.common.util.URI uri,
                                                                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                throws IndexException

This method will return all the resources that directly reference the given EObject URI. The context is used to restrict the results to the given scope.

Parameters:

context - The context of the search.

uri - The referenced URI.

monitor - the progress monitor or null

Returns:

All the resources that directly reference the given EObject URI.

Throws:

IndexException

findReferencedResources

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findReferencedResources(IndexContext context,
                                                                                      org.eclipse.emf.ecore.EObject eObject,
                                                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                               throws IndexException

This method will return all resources that are referenced by the given EObject. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The referencing EObject

monitor - the progress monitor or null

Returns:

All resources that are referenced by the given EObject.

Throws:

IndexException

findReferencedResources

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> findReferencedResources(IndexContext context,
                                                                                      org.eclipse.emf.common.util.URI uri,
                                                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                               throws IndexException

This method will return all resources that are referenced by the given EObject URI.

Parameters:

context - The context of the search.

uri - The referencing EObject's URI.

monitor - the progress monitor or null

Returns:

All resources that are referenced by the given EObject's URI.

Throws:

IndexException

findEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findEObjects(IndexContext context,
                                                                               org.eclipse.emf.ecore.EClass eClass,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                        throws IndexException

This method will return all EObjects of the given class type.

Parameters:

context - The context of the search.

eClass - The given class type.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type.

Throws:

IndexException

findEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findEObjects(IndexContext context,
                                                                               java.lang.Object value,
                                                                               org.eclipse.emf.ecore.EAttribute eAttribute,
                                                                               org.eclipse.emf.ecore.EClass eClass,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                        throws IndexException

This method will return all EObjects of the given class type that reference the given value at the given attribute feature.

Parameters:

context - The context of the search.

value - The given value

eAttribute - The given attribute feature

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that reference the given value at the given attribute feature.

Throws:

IndexException

findEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findEObjects(IndexContext context,
                                                                               java.lang.String pattern,
                                                                               boolean ignoreCase,
                                                                               org.eclipse.emf.ecore.EAttribute eAttributeFeature,
                                                                               org.eclipse.emf.ecore.EClass eClass,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                        throws IndexException

This method will return all EObjects of the specified class type that reference string values containing the specified pattern through the given attribute feature.

Parameters:

context - The context of the search.

pattern - The specified pattern

ignoreCase - The boolean flag to spcify whether to ignore case sensitivity or not

eAttributeFeature - The given attribute feature or null. If null then the search engine will check for all the attribute features in the index

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that reference string values containing the specified pattern

Throws:

IndexException

findReferencingEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findReferencingEObjects(IndexContext context,
                                                                                          org.eclipse.emf.ecore.EObject eObject,
                                                                                          org.eclipse.emf.ecore.EReference eReference,
                                                                                          org.eclipse.emf.ecore.EClass eClass,
                                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                   throws IndexException

This method will return all EObjects of the given type that reference a given EObject at the given reference feature. The EObject can be a proxy object. If the reference argument is null the result set will comprise of EObjects that reference the specified EObject through containment and non-containment references

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given type that reference the given EObject at the given reference feature

Throws:

IndexException

findReferencingEObjects

<T1,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>> findReferencingEObjects(IndexContext context,
                                                                                                                 java.util.Collection<T1> eObjectsOrUris,
                                                                                                                 org.eclipse.emf.ecore.EReference eReference,
                                                                                                                 org.eclipse.emf.ecore.EClass eClass,
                                                                                                                 org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                          throws IndexException

This method returns a map of EObjects to their referencers of the given type that reference objects in the given collection of eObjects at the given reference feature. The collection can contain proxies. If the reference argument is null the result set will comprise of EObjects that reference through containment and non-containment references

Parameters:

context - The context of the search.

eObjectsOrUris - The collection of eObjects or URIs

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of EObjects to their referencers

Throws:

IndexException

findAllReferencingEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>> findAllReferencingEObjects(IndexContext context,
                                                                                                                                          org.eclipse.emf.ecore.EObject eObject,
                                                                                                                                          org.eclipse.emf.ecore.EReference eReference,
                                                                                                                                          org.eclipse.emf.ecore.EClass eClass,
                                                                                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                                                   throws IndexException

This method will return map of EObjects to their referencers of the given type starting at the specified EObject and recursively their referencers at the given reference feature. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of EObjects to their referencers

Throws:

IndexException

findAllReferencedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>> findAllReferencedEObjects(IndexContext context,
                                                                                                                                         org.eclipse.emf.ecore.EObject eObject,
                                                                                                                                         org.eclipse.emf.ecore.EReference eReference,
                                                                                                                                         org.eclipse.emf.ecore.EClass eClass,
                                                                                                                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                                                  throws IndexException

This method will return map of EObjects to their referenced objects of the given type starting at the specified EObject and recursively their references at the given reference feature. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of EObjects to their referenced eObjects

Throws:

IndexException

findAllContainedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Map<org.eclipse.emf.ecore.EObject,java.util.Collection<T>> findAllContainedEObjects(IndexContext context,
                                                                                                                                        org.eclipse.emf.ecore.EObject eObject,
                                                                                                                                        org.eclipse.emf.ecore.EReference eReference,
                                                                                                                                        org.eclipse.emf.ecore.EClass eClass,
                                                                                                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                                                 throws IndexException

This method will return map of EObjects to their contained objects of the given type starting at the specified EObject and recursively their contained eObjects at the given containment reference feature. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of EObjects to their referencers

Throws:

IndexException

findReferencingEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findReferencingEObjects(IndexContext context,
                                                                                          org.eclipse.emf.common.util.URI uri,
                                                                                          org.eclipse.emf.ecore.EReference eReference,
                                                                                          org.eclipse.emf.ecore.EClass eClass,
                                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                   throws IndexException

This method will return all EObjects of the given type that reference a given URI at the given reference feature. If the reference argument is null the result set will comprise of EObjects that reference the specified URI through containment and non-containment references

Parameters:

context - The context of the search.

uri - The given URI.

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given type that reference the given URI at the given reference feature

Throws:

IndexException

findValue

<T> T findValue(IndexContext context,
                org.eclipse.emf.ecore.EObject eObject,
                org.eclipse.emf.ecore.EAttribute eAttribute,
                org.eclipse.core.runtime.IProgressMonitor monitor)
         throws IndexException

This method will return the value of the given attribute feature given an EObject. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The given EObject

eAttribute - The given attribute feature.

monitor - the progress monitor or null

Returns:

The value of the given attribute feature given the EObject.

Throws:

IndexException

findValue

<T1 extends org.eclipse.emf.ecore.EObject,T2> java.util.Map<T1,T2> findValue(IndexContext context,
                                                                             java.util.Collection<T1> eObjects,
                                                                             org.eclipse.emf.ecore.EAttribute eAttribute,
                                                                             org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                      throws IndexException

This method returns a map of EObjects to their values for the given attribute feature

Parameters:

context - The context of the search.

eObjects - The collection of eObjects

eAttribute - The given attribute feature.

monitor - the progress monitor or null

Returns:

a map of EObjects to their values

Throws:

IndexException

findValue

<T> T findValue(IndexContext context,
                org.eclipse.emf.common.util.URI uri,
                org.eclipse.emf.ecore.EAttribute eAttribute,
                org.eclipse.core.runtime.IProgressMonitor monitor)
         throws IndexException

This method will return the value of the given attribute feature given a EObject's URI.

Parameters:

context - The context of the search.

uri - The given EObject's URI.

eAttribute - The given attribute feature.

monitor - the progress monitor or null

Returns:

The value of the given attribute feature given the EObject's URI.

Throws:

IndexException

findReferencedEObjects

<T1 extends org.eclipse.emf.ecore.EObject,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>> findReferencedEObjects(IndexContext context,
                                                                                                                                                      java.util.Collection<T1> eObjects,
                                                                                                                                                      org.eclipse.emf.ecore.EReference eReference,
                                                                                                                                                      org.eclipse.emf.ecore.EClass eClass,
                                                                                                                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                                                               throws IndexException

This method returns a map of EObjects to their referenced eObjects of the given type that reference objects in the given collection at the given non-containment reference feature. The collection can contain proxies. If the reference argument is null the result set will comprise of EObjects that reference through non-containment references

Parameters:

context - The context of the search.

eObjects - The collection of EObjects

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of EObjects to their referenced eObjects.

Throws:

IndexException

findReferencedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findReferencedEObjects(IndexContext context,
                                                                                         org.eclipse.emf.ecore.EObject eObject,
                                                                                         org.eclipse.emf.ecore.EReference eReference,
                                                                                         org.eclipse.emf.ecore.EClass eClass,
                                                                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                  throws IndexException

This method will return all EObjects of the given class type that are referenced by the given EObject at the given non-containment reference feature. The EObject can be a proxy object. If the reference argument is null the result set will comprise of EObjects that are referenced by the specified EObject through non-containment references.

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that are referenced by the given EObject at the given reference feature.

Throws:

IndexException

findReferencedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findReferencedEObjects(IndexContext context,
                                                                                         org.eclipse.emf.common.util.URI uri,
                                                                                         org.eclipse.emf.ecore.EReference eReference,
                                                                                         org.eclipse.emf.ecore.EClass eClass,
                                                                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                  throws IndexException

This method will return all EObjects of the given class type that are referenced by the given URI at the given non-containment reference feature. If the reference argument is null the result set will comprise of EObjects that are referenced by the specified URI through non-containment references.

Parameters:

context - The context of the search.

uri - The given URI.

eReference - The given reference feature.

eClass - The given class type.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that are referenced by the given URI at the given reference feature.

Throws:

IndexException

findContainedEObjects

<T1,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,java.util.Collection<T2>> findContainedEObjects(IndexContext context,
                                                                                                               java.util.Collection<T1> eObjectsOrURIs,
                                                                                                               org.eclipse.emf.ecore.EReference eReference,
                                                                                                               org.eclipse.emf.ecore.EClass eClass,
                                                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                        throws IndexException

This method will return all EObjects of the given class type that are contained by the collection of specified EObjects at the given containment reference feature. The EObject can be a proxy object. If the reference argument is null the result set will comprise of EObjects that are referenced by the specified EObject through containment references.

Parameters:

context - The context of the search.

eObjectsOrURIs - The collection of EObjects or URIs

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

a map of eObjects to their contained eObjects.

Throws:

IndexException

findContainedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findContainedEObjects(IndexContext context,
                                                                                        org.eclipse.emf.ecore.EObject eObject,
                                                                                        org.eclipse.emf.ecore.EReference eReference,
                                                                                        org.eclipse.emf.ecore.EClass eClass,
                                                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                 throws IndexException

This method will return all EObjects of the given class type that are contained by the given EObject at the given containment reference feature. The EObject can be a proxy object. If the reference argument is null the result set will comprise of EObjects that are referenced by the specified EObject through containment references.

Parameters:

context - The context of the search.

eObject - The given EObject

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that are contained by the given EObject at the given reference feature.

Throws:

IndexException

findContainedEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findContainedEObjects(IndexContext context,
                                                                                        org.eclipse.emf.common.util.URI uri,
                                                                                        org.eclipse.emf.ecore.EReference eReference,
                                                                                        org.eclipse.emf.ecore.EClass eClass,
                                                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                 throws IndexException

This method will return all EObjects of the given class type that are referenced by the given URI at the given containment reference feature. If the reference argument is null the result set will comprise of EObjects that are referenced by the specified URI through containment references.

Parameters:

context - The context of the search.

uri - The given EObject's URI.

eReference - The given reference feature or null.

eClass - The given class type or null.

monitor - the progress monitor or null

Returns:

All EObjects of the given class type that are contained by the given EObject's URI at the given reference feature.

Throws:

IndexException

findContainer

<T extends org.eclipse.emf.ecore.EObject> T findContainer(IndexContext context,
                                                          org.eclipse.emf.ecore.EObject eObject,
                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                   throws IndexException

This method will return the container of the given EObject. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObject - The given EObject

monitor - the progress monitor or null

Returns:

The container of the given EObject.

Throws:

IndexException

findContainer

<T1 extends org.eclipse.emf.ecore.EObject,T2 extends org.eclipse.emf.ecore.EObject> java.util.Map<T1,T2> findContainer(IndexContext context,
                                                                                                                       java.util.Collection<T1> eObjects,
                                                                                                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                                throws IndexException

This method will return the containers of the given EObjects. The EObject can be a proxy object.

Parameters:

context - The context of the search.

eObjects - The collection of EObjects

monitor - the progress monitor or null

Returns:

a map of eObjects to their containers.

Throws:

IndexException

findContainer

<T extends org.eclipse.emf.ecore.EObject> T findContainer(IndexContext context,
                                                          org.eclipse.emf.common.util.URI uri,
                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                   throws IndexException

This method will return the container of the given EObject's URI.

Parameters:

context - The context of the search.

uri - The given URI.

monitor - the progress monitor or null

Returns:

The container of the given EObject's URI.

Throws:

IndexException

findEObjects

<T extends org.eclipse.emf.ecore.EObject> java.util.Collection<T> findEObjects(IndexContext context,
                                                                               java.lang.String uriFragment,
                                                                               org.eclipse.emf.ecore.EClass eClass,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                        throws IndexException

Return the EObjects that resolve for the given URI URI.fragment() fragment. The returned objects will be of the specified EClass.

Parameters:

context - The context of the search.

uriFragment - The uri fragment

eClass - The EClass or null

monitor - progress monitor

Returns:

The collection of EObjects

Throws:

IndexException