com.ibm.xtools.emf.index.search

Class IndexContext

java.lang.Object

com.ibm.xtools.emf.index.search.IndexContext

public final class IndexContext
extends java.lang.Object

This class serves as the primary context for indexing platform to perform queries against the index store. Instances of the this class are passed to the various find methods of IIndexSearchManager to control the scope and the search results of the query. The class also provides convenient methods to create some common contexts.

The class also provides some options that can be passed to the options map in the context. These options control aspects such as resolution of the objects which are part of the result set and searching unloaded resources.

Usage:

 IndexContext context = IndexContext.createDefaultContext(new ResourceSetImpl());
 context.getOptions().put(IndexContext.SEARCH_UNLOADED_RESOURCES, Boolean.TRUE);
 context.getOptions().put(IndexContext.RESOLVE_PROXIES, Boolean.FALSE);
 

See Also:

IIndexSearchManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROVIDE_INDEXED_DATA_FOR_PROXIES_AND_PARENTS Option that controls if index information needs to be populated for proxies and their parents (until the root) returned in the result set
static java.lang.String	RESOLVE_PROXIES Option that controls if proxies are to be resolved in the result set.
static java.lang.String	SEARCH_DEPLOYED_RESOURCES Option that controls if all resources deployed in plug-ins (and registered on the com.ibm.xtools.emf.index.configurationEntries extension point) are to be included in the search, in addition to any that are included in the resource scope.
static java.lang.String	SEARCH_IGNORING_CONTENT_TYPE Ignore resource content types
static java.lang.String	SEARCH_UNLOADED_RESOURCES Option that controls if all unloaded resources are to be included in the search, in addition to any that are already loaded in the resource set.
static java.lang.String	STRICT_ECLASS_EQUALITY Option to control the usage of the EClass argument when passed to the find methods.
static java.lang.String	SYNCHRONIZE_INDEX Option to decide whether to synchronize the index during a query.

Constructor Summary

Constructors

Constructor and Description
IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Construct a resource set context that is independent of any scope.
IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<?> scope) Construct a resource scope context.
IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<?> scope, java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes) Construct a resource scope context.
IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<?> scope, java.util.Map<java.lang.String,java.lang.Object> options) Constructs the index context with preset option flags.

Method Summary

Modifier and Type	Method and Description
static IndexContext	createDefaultContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Create a resource set context that is independent of any platform resource.
static IndexContext	createEResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<?> resources) Creates a resource collection context.
static IndexContext	createEResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.ecore.resource.Resource resource) Creates a resource context.
static IndexContext	createPlatformContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Creates a context covering the whole Eclipse platform (workspace and resources deployed in plug-ins).
static IndexContext	createPlatformContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes) Creates a context covering the whole Eclipse platform (workspace and resources deployed in plug-ins) with the specified content types.
static IndexContext	createPlatformResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<?> resources) Creates a platform resource collection context.
static IndexContext	createPlatformResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.core.resources.IResource resource) Creates a platform resource context.
static IndexContext	createWorkspaceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Creates a workspace context.
static IndexContext	createWorkspaceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes) Creates a workspace context with the specified content types.
java.util.Collection<org.eclipse.emf.common.util.URI>	getAllResourceURIs() Gets all the resource URIs in the context.
java.util.Collection<org.eclipse.emf.common.util.URI>	getLoadedResourceURIs() Gets the loaded resource URIs within the context
java.util.Map<java.lang.String,java.lang.Object>	getOptions() Gets the search options.
IProxyData	getProxyData() Returns the interface that provides attribute and reference information for proxies returned by the index store.
static org.eclipse.emf.common.util.URI	getResource(org.eclipse.core.resources.IFile file) Gets the resource uri given a platform IFile
org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.emf.common.util.URI uri, boolean trimFragment) Creates a resource for the specified uri.
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet() Gets the resource set associated with this context.
java.util.Collection<org.eclipse.emf.common.util.URI>	getResourceURIs() Gets the resource URIs within the context based on the IndexContext.SEARCH_UNLOADED_RESOURCES and IndexContext.SEARCH_DEPLOYED_RESOURCES options.
org.eclipse.core.resources.IResource	getWorkspaceResource(org.eclipse.emf.common.util.URI resourceURI) Returns the corresponding workspace resource for the specified resource uri
org.eclipse.core.resources.IResource[]	getWorkspaceResources(java.util.Collection<org.eclipse.emf.common.util.URI> resourceURIs) Returns the corresponding workspace resources for the specified list of resource uris
static org.eclipse.emf.common.util.URI	normalize(org.eclipse.emf.common.util.URI uri, org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Normalizes the specified URI in the specified resource set.

Methods inherited from class java.lang.Object

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

Field Detail

STRICT_ECLASS_EQUALITY

public static final java.lang.String STRICT_ECLASS_EQUALITY

Option to control the usage of the EClass argument when passed to the find methods.

See Also:

Constant Field Values

SYNCHRONIZE_INDEX

public static final java.lang.String SYNCHRONIZE_INDEX

Option to decide whether to synchronize the index during a query. By default the index will be synchronized for every query

See Also:

Constant Field Values

RESOLVE_PROXIES

public static final java.lang.String RESOLVE_PROXIES

Option that controls if proxies are to be resolved in the result set.

See Also:

Constant Field Values

SEARCH_UNLOADED_RESOURCES

public static final java.lang.String SEARCH_UNLOADED_RESOURCES

Option that controls if all unloaded resources are to be included in the search, in addition to any that are already loaded in the resource set.

See Also:

Constant Field Values

SEARCH_DEPLOYED_RESOURCES

public static final java.lang.String SEARCH_DEPLOYED_RESOURCES

Option that controls if all resources deployed in plug-ins (and registered on the com.ibm.xtools.emf.index.configurationEntries extension point) are to be included in the search, in addition to any that are included in the resource scope.

See Also:

Constant Field Values

SEARCH_IGNORING_CONTENT_TYPE

public static final java.lang.String SEARCH_IGNORING_CONTENT_TYPE

Ignore resource content types

See Also:

Constant Field Values

PROVIDE_INDEXED_DATA_FOR_PROXIES_AND_PARENTS

public static final java.lang.String PROVIDE_INDEXED_DATA_FOR_PROXIES_AND_PARENTS

Option that controls if index information needs to be populated for proxies and their parents (until the root) returned in the result set

See Also:

Constant Field Values

Constructor Detail

IndexContext

public IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Construct a resource set context that is independent of any scope.

Parameters:

resourceSet - The given resource set.

IndexContext

public IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                    java.util.Collection<?> scope)

Construct a resource scope context.

Parameters:

resourceSet - The given resource set.

scope - The given scope. The scope can contain resources of type IResource or Resource

IndexContext

public IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                    java.util.Collection<?> scope,
                    java.util.Map<java.lang.String,java.lang.Object> options)

Constructs the index context with preset option flags.

Parameters:

resourceSet - the resource set

scope - scope resources

options - the option flags

IndexContext

public IndexContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                    java.util.Collection<?> scope,
                    java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes)

Construct a resource scope context.

Parameters:

resourceSet - The given resource set.

scope - The given scope. The scope can contain resources of type IResource or Resource

contentTypes - The given set of content types. This is a list of IContentTypes

Method Detail

createDefaultContext

public static IndexContext createDefaultContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Create a resource set context that is independent of any platform resource. Sets SEARCH_UNLOADED_RESOURCES to FALSE, SEARCH_DEPLOYED_RESOURCES to FALSE, RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

Returns:

The newly created context.

createEResourceContext

public static IndexContext createEResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                  org.eclipse.emf.ecore.resource.Resource resource)

Creates a resource context. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE .

Parameters:

resourceSet - The given resource set.

resource - The given resource.

Returns:

The newly created context.

createEResourceContext

public static IndexContext createEResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                  java.util.Collection<?> resources)

Creates a resource collection context. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

resources - The given resource collection.

Returns:

The newly created context.

createWorkspaceContext

public static IndexContext createWorkspaceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Creates a workspace context. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

Returns:

The newly created context.

createWorkspaceContext

public static IndexContext createWorkspaceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                  java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes)

Creates a workspace context with the specified content types. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

contentTypes - The given set of content types. This is a list of IContentTypes

Returns:

The newly created context.

createPlatformResourceContext

public static IndexContext createPlatformResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                         org.eclipse.core.resources.IResource resource)

Creates a platform resource context. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

resource - The platform resource.

Returns:

The newly created context.

createPlatformResourceContext

public static IndexContext createPlatformResourceContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                         java.util.Collection<?> resources)

Creates a platform resource collection context. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to FALSE, and RESOLVE_PROXIES to FALSE

Parameters:

resourceSet - The given resource set.

resources - The given platform resource collection.

Returns:

The newly created context.

createPlatformContext

public static IndexContext createPlatformContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Creates a context covering the whole Eclipse platform (workspace and resources deployed in plug-ins). Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to TRUE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

Returns:

The newly created context.

createPlatformContext

public static IndexContext createPlatformContext(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                 java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes)

Creates a context covering the whole Eclipse platform (workspace and resources deployed in plug-ins) with the specified content types. Sets SEARCH_UNLOADED_RESOURCES to TRUE, SEARCH_DEPLOYED_RESOURCES to TRUE, and RESOLVE_PROXIES to FALSE.

Parameters:

resourceSet - The given resource set.

contentTypes - The given set of content types. This is a list of IContentTypes

Returns:

The newly created context.

getResourceSet

public org.eclipse.emf.ecore.resource.ResourceSet getResourceSet()

Gets the resource set associated with this context.

Returns:

The resource set.

getOptions

public java.util.Map<java.lang.String,java.lang.Object> getOptions()

Gets the search options.

Returns:

The options map.

getProxyData

public IProxyData getProxyData()

Returns the interface that provides attribute and reference information for proxies returned by the index store.

Returns:

The IProxyData object

getAllResourceURIs

public java.util.Collection<org.eclipse.emf.common.util.URI> getAllResourceURIs()

Gets all the resource URIs in the context.

Returns:

the collection of resource URIs

getResource

public static org.eclipse.emf.common.util.URI getResource(org.eclipse.core.resources.IFile file)

Gets the resource uri given a platform IFile

Parameters:

file - the platform file object

Returns:

the resource uri associated with the file

getResource

public org.eclipse.emf.ecore.resource.Resource getResource(org.eclipse.emf.common.util.URI uri,
                                                           boolean trimFragment)

Creates a resource for the specified uri. The returned resource is not added to the resource set

Parameters:

uri - the input uri

trimFragment - flag to trim the fragment

Returns:

the resource associated with the uri or null if cannot create a resource

getWorkspaceResources

public org.eclipse.core.resources.IResource[] getWorkspaceResources(java.util.Collection<org.eclipse.emf.common.util.URI> resourceURIs)

Returns the corresponding workspace resources for the specified list of resource uris

Parameters:

resourceURIs - the resource uris

Returns:

the workspace resources associated with the specified uris or null if none

getWorkspaceResource

public org.eclipse.core.resources.IResource getWorkspaceResource(org.eclipse.emf.common.util.URI resourceURI)

Returns the corresponding workspace resource for the specified resource uri

Parameters:

resourceURI - the resource uri

Returns:

the workspace resource or null if none

getLoadedResourceURIs

public java.util.Collection<org.eclipse.emf.common.util.URI> getLoadedResourceURIs()

Gets the loaded resource URIs within the context

Returns:

the collection of resource URIs

getResourceURIs

public java.util.Collection<org.eclipse.emf.common.util.URI> getResourceURIs()

Gets the resource URIs within the context based on the IndexContext.SEARCH_UNLOADED_RESOURCES and IndexContext.SEARCH_DEPLOYED_RESOURCES options. If the IndexContext.SEARCH_UNLOADED_RESOURCES is true then the returned result will contain URIs for unloaded resources as well. If the IndexContext.SEARCH_DEPLOYED_RESOURCES is true then the returned result will contain URIs for statically registered resource URIs (loaded or unloaded) as well.

Returns:

the collection of resource URIs

normalize

public static org.eclipse.emf.common.util.URI normalize(org.eclipse.emf.common.util.URI uri,
                                                        org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Normalizes the specified URI in the specified resource set. All normalization performed by the index framework and its providers should invoke this method, as any customizations to the normalization logic will be done here and should be shared for consistency.

Parameters:

uri - the URI to normalize

resourceSet - the resource set defining the URI converter

Returns:

the normalized URI (which may not be different from the original)