org.eclipse.ptp.etfw
Class AbstractToolDataManager

java.lang.Object
  org.eclipse.ptp.etfw.AbstractToolDataManager

public abstract class AbstractToolDataManager
extends java.lang.Object

The implementations of this abstract class can be used by the org.eclipse.ptp.etfw.dataManagers extension point to manage generated performance data.

Constructor Summary

AbstractToolDataManager()

Method Summary

abstract void	cleanup() This operation is called to do the final cleanup after analysis is complete.
abstract java.lang.String	getName() This returns the name of the string associated with this analysis operation The string will be the title of the utility used in a workflow xml document It should be used in the form
abstract void	process(java.lang.String projname, ILaunchConfiguration configuration, java.lang.String projectLocation) This is the primary function for processing data generated by a performance analysis tool.
abstract void	setExternalTarget(boolean external) Used to indicate that this analysis operation is being conducted by the user on arbitrary external data.
abstract void	view() For future expansion: currently unused.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractToolDataManager

public AbstractToolDataManager()

Method Detail

cleanup

public abstract void cleanup()

This operation is called to do the final cleanup after analysis is complete. It should be implemented to work properly even if the process method fails.

getName

public abstract java.lang.String getName()

This returns the name of the string associated with this analysis operation The string will be the title of the utility used in a workflow xml document It should be used in the form

Returns:

process

public abstract void process(java.lang.String projname,
                             ILaunchConfiguration configuration,
                             java.lang.String projectLocation)
                      throws CoreException

This is the primary function for processing data generated by a performance analysis tool. The project name can be used to sort and label generated data. The project location, with respect to the local filesystem, is where many tools generate their data by default. The configuration can be used to extract most of the other data relevant to the analysis procedure.

Parameters:

projname - The name of the project which produced the data

configuration - The launch configuration with which the project was launched

projectLocation - The location of the project with respect to the local filesystem

Throws:

CoreException

setExternalTarget

public abstract void setExternalTarget(boolean external)

Used to indicate that this analysis operation is being conducted by the user on arbitrary external data. The configuration may be an invalid source for some parameters.

view

public abstract void view()

For future expansion: currently unused. Eventually this should get called to view the generated trace data. For now, any viewing should be launched from the process() method.