org.eclipse.tptp.platform.analysis.core.reporting
Interface IAnalysisExporter

All Known Implementing Classes:

AbstractAnalysisHTMLExporter, AbstractAnalysisXMLExporter

public interface IAnalysisExporter

This interface is used to define new data exporters for the static analysis framework. The main entry point in the export() method however before this occurs the path and file for the export will be set.

Method Summary

java.lang.String	export(org.eclipse.core.runtime.IProgressMonitor monitor, AnalysisHistory history, AbstractAnalysisProvider provider) Generate an export document based on the data contained in a given history.
java.lang.String	getDescription()
java.lang.String	getFileType()
java.lang.String	getId()
java.lang.String	getLabel()
void	setDescription(java.lang.String label) Set the description for this data exporter.
void	setExportFile(java.lang.String file) Set the name of the file where the exported data will be written.
void	setExportFolder(java.lang.String folder) Set the base folder where the exported data will be written.
void	setId(java.lang.String id) Set the id for this data exporter.
void	setLabel(java.lang.String label) Set the label for this data exporter.

Method Detail

export

java.lang.String export(org.eclipse.core.runtime.IProgressMonitor monitor,
                        AnalysisHistory history,
                        AbstractAnalysisProvider provider)

Generate an export document based on the data contained in a given history. This document can take almost any format, for example XML or CSV.

Parameters:

monitor - A progress monitor to report status

history - The history to reference for XML data generation

provider - The analysis provider whose data is being exported

Returns:

A complete document containing exported data

setLabel

void setLabel(java.lang.String label)

Set the label for this data exporter. This can be called only once - subsequent calls will be ignored

Parameters:

label - The new label for this exporter

getLabel

java.lang.String getLabel()

Returns:

The label for this data exporter

setDescription

void setDescription(java.lang.String label)

Set the description for this data exporter. This can be called only once - subsequent calls will be ignored

Parameters:

label - The new label for this exporter

getDescription

java.lang.String getDescription()

Returns:

The description for this data exporter

getFileType

java.lang.String getFileType()

Returns:

The file type for this data exporter

setId

void setId(java.lang.String id)

Set the id for this data exporter. This can be called only once - subsequent calls will be ignored

Parameters:

id - The unique identifier for this exporter

getId

java.lang.String getId()

Returns:

The unique identifier for this data exporter

setExportFolder

void setExportFolder(java.lang.String folder)

Set the base folder where the exported data will be written. Note however that not all data exporters will need or desire folder information so it is possible the implementation of this method will be empty.

Parameters:

folder - The base export folder

setExportFile

void setExportFile(java.lang.String file)

Set the name of the file where the exported data will be written. Note however that not all data exporters will need or desire file information so it is possible the implementation of this method will be empty.

Parameters:

file - The name of the export file