de.tud.cs.peaks.osgi.framework.api

Interface IAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

Type Parameters:

Result - The Result type of the analysis,

Config - The configuration type of the analysis

All Known Implementing Classes:

AbstractAnalysisService

public interface IAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

This is the general Interface for all Analyses

Author:

Florian Kuebler

See Also:

AbstractAnalysisService

Method Summary

Modifier and Type	Method and Description
IAnalysisConfig	convertConfig(Config config, Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>> serviceClass) Converts the config of this analysis to a config of the given analysis this depends on.
org.osgi.framework.Bundle	getBundle() The Bundle which this AnalysisService belongs to.
String	getName() This is the name that will be displayed to the user in the OSGi Framework
Config	parseConfig(String[] config) Creates the config for this analysis from commandline arguments
Future<Result>	performAnalysis(Config config) Performs the analysis with the given config, running all required other analyses This is implemented by AbstractAnalysisService
Result	runAnalysis(Config config, Map<Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>>,IAnalysisResult> previousResults) Runs the actual analysis with the given configuration
boolean	shouldBeHidden() Method the framework uses to decide whether this service should be hidden from the user

Method Detail

getName

String getName()

This is the name that will be displayed to the user in the OSGi Framework

Returns:

the Name of the Analysis

runAnalysis

Result runAnalysis(Config config,
                   Map<Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>>,IAnalysisResult> previousResults)

Runs the actual analysis with the given configuration

Parameters:

config - the configuration to run

previousResults - the results of other analyses this analysis depends on

Returns:

the result of the Analysis

performAnalysis

Future<Result> performAnalysis(Config config)
                        throws IllegalClassFormatException

Performs the analysis with the given config, running all required other analyses This is implemented by AbstractAnalysisService

Parameters:

config - the given config

Returns:

a future which will contain the analysis result

Throws:

IllegalClassFormatException

See Also:

DependsOn, AbstractAnalysisService

convertConfig

IAnalysisConfig convertConfig(Config config,
                              Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>> serviceClass)

Converts the config of this analysis to a config of the given analysis this depends on.

Parameters:

config - the config to convert

serviceClass - the required analysis type, for which the config needs to be converted

Returns:

the converted config

parseConfig

Config parseConfig(String[] config)

Creates the config for this analysis from commandline arguments

Parameters:

config - the commandline arguments

Returns:

the resulting config

getBundle

org.osgi.framework.Bundle getBundle()

The Bundle which this AnalysisService belongs to.

Returns:

the corresponding OSGi Bundle

shouldBeHidden

boolean shouldBeHidden()

Method the framework uses to decide whether this service should be hidden from the user

Returns:

whether this service should be hidden from the user