com.ibm.xtools.emf.index.provider

Interface IIndexConfigurationManager

public interface IIndexConfigurationManager

This is the primary interface used by clients to query information related to the configured index contributions. The contributions provide information related to indexable artifacts, providers for creating index entries, indexable eAttributes etc. Clients do not have to implement this interface. All functionality is provided by a static instance.

See Also:

IIndexProvider, IIndexProviderFactory, IURIParser, IContentType

Field Summary

Fields

Modifier and Type	Field and Description
static IIndexConfigurationManager	INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	doesIndexProviderExist(org.eclipse.core.runtime.content.IContentType contentType) Checks if an index provider exists for specified content type
boolean	doesIndexProviderExist(org.eclipse.emf.common.util.URI resourceURI) Checks if an index provider exists for specified resource URI
boolean	doesURIParserExist(java.lang.String scheme) Checks if an URI parser exists for specified scheme
org.eclipse.core.runtime.content.IContentType	getApplicableContentType(org.eclipse.core.resources.IFile file, java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes) Returns the applicable contentype from the specified content types.
org.eclipse.core.runtime.content.IContentType	getApplicableContentType(org.eclipse.emf.common.util.URI resourceURI, java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes) Returns the applicable content type from the specified content types.
java.util.Collection<org.eclipse.core.runtime.content.IContentType>	getIndexedContentTypes() Returns the collection of indexed content types
IIndexProvider	getIndexProvider(org.eclipse.emf.common.util.URI resourceURI) Returns the IIndexProvider for the specified resource URI.
IIndexProviderFactory	getIndexProviderFactory(org.eclipse.core.runtime.content.IContentType contentType) Returns the IIndexProviderFactory for the specified content type.
java.util.Collection<org.eclipse.emf.common.util.URI>	getRegisteredIndexedURIs() Returns the collection of statically registered URIs that are indexed
IURIParser	getURIParser(java.lang.String scheme) Returns the IURIParser for the specified scheme.
boolean	isContentTypeIndexed(org.eclipse.core.runtime.content.IContentType contentType) Checks if the specified content type is indexed
boolean	isFeatureIndexed(org.eclipse.emf.ecore.EAttribute eAttribute) Checks if the specified attribute feature is indexed
boolean	isResourceIndexed(org.eclipse.emf.common.util.URI resourceURI) Checks if the specified resource URI is indexed.

Field Detail

INSTANCE

static final IIndexConfigurationManager INSTANCE

Method Detail

isFeatureIndexed

boolean isFeatureIndexed(org.eclipse.emf.ecore.EAttribute eAttribute)

Checks if the specified attribute feature is indexed

Parameters:

eAttribute - The attribute feature to check

Returns:

true if feature is indexed, false otherwise

isContentTypeIndexed

boolean isContentTypeIndexed(org.eclipse.core.runtime.content.IContentType contentType)

Checks if the specified content type is indexed

Parameters:

contentType - The content type to check

Returns:

true if content type is indexed, false otherwise

doesIndexProviderExist

boolean doesIndexProviderExist(org.eclipse.core.runtime.content.IContentType contentType)

Checks if an index provider exists for specified content type

Parameters:

contentType - The content type to check

Returns:

true if index provider exists, false otherwise

doesIndexProviderExist

boolean doesIndexProviderExist(org.eclipse.emf.common.util.URI resourceURI)

Checks if an index provider exists for specified resource URI

Note that this method will attempt to discover the content type of the provided URI by checking to see if it is in the workspace, if it is a statically registered resource or if it is a local file system file. If the URI is neither then this method returns false.

Parameters:

resourceURI - The resource URI to check

Returns:

true if index provider exists, false otherwise

doesURIParserExist

boolean doesURIParserExist(java.lang.String scheme)

Checks if an URI parser exists for specified scheme

Parameters:

scheme - The scheme to check

Returns:

true if URI parser exists, false otherwise

getIndexedContentTypes

java.util.Collection<org.eclipse.core.runtime.content.IContentType> getIndexedContentTypes()

Returns the collection of indexed content types

Returns:

The collection of indexed content types

getRegisteredIndexedURIs

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

Returns the collection of statically registered URIs that are indexed

Returns:

The collection of indexed URIs

getIndexProviderFactory

IIndexProviderFactory getIndexProviderFactory(org.eclipse.core.runtime.content.IContentType contentType)

Returns the IIndexProviderFactory for the specified content type.

Parameters:

contentType - The content type to check

Returns:

The index provider factory if exists or null otherwise

getIndexProvider

IIndexProvider getIndexProvider(org.eclipse.emf.common.util.URI resourceURI)

Returns the IIndexProvider for the specified resource URI.

Note that this method will attempt to discover the content type of the provided URI by checking to see if it is in the workspace, if it is a statically registered resource or if it is a local file system file. If the URI is neither then this method returns null.

Parameters:

resourceURI - The resource URI to check

Returns:

The index provider if exists or null otherwise

getURIParser

IURIParser getURIParser(java.lang.String scheme)

Returns the IURIParser for the specified scheme.

Parameters:

scheme - The scheme to check

Returns:

The URI parser if exists or null otherwise

isResourceIndexed

boolean isResourceIndexed(org.eclipse.emf.common.util.URI resourceURI)

Checks if the specified resource URI is indexed.

Note that the provided resource URI must reside within the workspace, in an plugin (or bundle) in the current runtime or a filesystem file.

Parameters:

resourceURI - The given resource URI

Returns:

true if reosurce URI is indexed, false otherwise

getApplicableContentType

org.eclipse.core.runtime.content.IContentType getApplicableContentType(org.eclipse.core.resources.IFile file,
                                                                       java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes)

Returns the applicable contentype from the specified content types. If the specified content types is null then the registered content types are checked that support this file.

Parameters:

file - The given file

contentTypes - the list of content types or null

Returns:

the content type or null

getApplicableContentType

org.eclipse.core.runtime.content.IContentType getApplicableContentType(org.eclipse.emf.common.util.URI resourceURI,
                                                                       java.util.Collection<org.eclipse.core.runtime.content.IContentType> contentTypes)

Returns the applicable content type from the specified content types. If the specified content types is null then the registered content types are checked that support this resource.

Please note that this method can only be used for URI's that resolve to a workspace file, a file within a plugin (or bundle) within the current runtime or a local filesystem file.

Parameters:

resourceURI - The URI of a resource whose content type is required

contentTypes - the list of content types or null

Returns:

the content type or null