org.eclipse.tptp.platform.analysis.core
Class AnalysisUtil

java.lang.Object
  org.eclipse.tptp.platform.analysis.core.AnalysisUtil

public final class AnalysisUtil
extends java.lang.Object

This utility class contains several useful methods for routine analysis functionality which can be used by any user code

Method Summary

static AbstractAnalysisElement	getAnalysisElement(java.lang.String elementId) This utility method finds the AnalysisElement associated with the given unique identifier
static IAnalysisViewer	getAnalysisViewer(java.lang.String viewerId) Return the analysis viewer for the specified viewer ID
static java.util.List	getFilteredResources(java.util.List inputResources, java.lang.String filter) Retrieve a list of resources matching a defined set of comma-separated content types.
static java.util.List	getFilteredResources(java.util.List inputResources, java.lang.String filter, java.lang.String requiredNature) Retrieve a list of resources matching a defined set of comma-separated content types.
static AnalysisProviderManager	getProviderManager() Return a list of registered analysis provider managers.
static boolean	isBusy() Deprecated. use AnalysisHistoryFactory.instance().isBusy()
static void	setBusy(boolean busy) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

getProviderManager

public static AnalysisProviderManager getProviderManager()

Return a list of registered analysis provider managers. This is a static method that can be used by any code that wants to retrieve this list.

Returns:

The registered analysis provider manager

isBusy

public static boolean isBusy()

Deprecated. use AnalysisHistoryFactory.instance().isBusy()

Returns:

true if the analysis process is busy

setBusy

public static void setBusy(boolean busy)

Deprecated.

INTERNAL USE ONLY

getAnalysisViewer

public static IAnalysisViewer getAnalysisViewer(java.lang.String viewerId)

Return the analysis viewer for the specified viewer ID

Parameters:

viewerId - The id of the viewer to find

Returns:

The IAnalysisViewer for the ID or null if no viewer with this ID exists

getAnalysisElement

public static AbstractAnalysisElement getAnalysisElement(java.lang.String elementId)

This utility method finds the AnalysisElement associated with the given unique identifier

Parameters:

elementId - The unique identifier of the element to find

Returns:

The AnalysisElement with the specified id or null if not found

getFilteredResources

public static java.util.List getFilteredResources(java.util.List inputResources,
                                                  java.lang.String filter)

Retrieve a list of resources matching a defined set of comma-separated content types. This method will return a resolved list of absolute file resources. This means that any folder resources will be resolved to a list of files.

Parameters:

inputResources - A list of resources from which the filter resource set is derived.

filter - A comma-separated string of resource file extensions

Returns:

a collection of filtered file resources

getFilteredResources

public static java.util.List getFilteredResources(java.util.List inputResources,
                                                  java.lang.String filter,
                                                  java.lang.String requiredNature)

Retrieve a list of resources matching a defined set of comma-separated content types. This method will return a resolved list of absolute file resources. This means that any folder resources will be resolved to a list of files.

Parameters:

inputResources - A list of resources from which the filter resource set is derived.

filter - A comma-separated string of resource file extensions

requiredNature - a String identifying the project nature required for analysis, or null if none required

Returns:

a collection of filtered file resources