org.eclipse.hyades.ui.report
Interface IReportGenerator

Deprecated. Use ReportGeneratorWizard instead. See bugzilla #79181 for details.

public interface IReportGenerator

Pluggable Report Generator Interface All report generator specified in the Preferences/Component Test/Local Report Definitions must implement this interface.

Method Summary

java.io.InputStream	generate(org.eclipse.core.resources.IFile reportFile, org.eclipse.jface.viewers.ISelection selection) Deprecated. This method will be invoked to generate the report for the given selection.
java.lang.String	getReportFileExtension(org.eclipse.jface.viewers.ISelection selection) Deprecated. Before the generate method invocation, the Component Test will execute this method in order to retrieve the extension of the resource that will be created for the report.
boolean	isAvailable(org.eclipse.jface.viewers.ISelection selection) Deprecated. Check if the report generator is available to the given selection.
void	setUsedClasspath(java.lang.String fullPath) Deprecated. If the report is registered into the Component Test tool by the preference page it will be difficult for the report generator to figure it out where it is located in the file system.

Method Detail

setUsedClasspath

void setUsedClasspath(java.lang.String fullPath)

Deprecated.

If the report is registered into the Component Test tool by the preference page it will be difficult for the report generator to figure it out where it is located in the file system. So, in this case, this method will be invoked

Parameters:

String - The classpath entered by the user in the preference page.

getReportFileExtension

java.lang.String getReportFileExtension(org.eclipse.jface.viewers.ISelection selection)

Deprecated.

Before the generate method invocation, the Component Test will execute this method in order to retrieve the extension of the resource that will be created for the report.

Parameters:

ISelection - The selection

Returns:

String The resource extension

isAvailable

boolean isAvailable(org.eclipse.jface.viewers.ISelection selection)

Deprecated.

Check if the report generator is available to the given selection.

Parameters:

selection - The selection.

Returns:

true if the report generator is applicable to the given selection.

generate

java.io.InputStream generate(org.eclipse.core.resources.IFile reportFile,
                             org.eclipse.jface.viewers.ISelection selection)
                             throws java.lang.Exception

Deprecated.

This method will be invoked to generate the report for the given selection.

The reportFile argument is the Eclipse resource that will be created by Component Test using the InputStream returned by the method. The implementors of this method should NOT create any resource with this file name.

Parameters:

IFile - The report file that will be created by the Component Test Plugin

ISelection - The selection

Returns:

InputStream The content of the report

Throws:

java.lang.Exception - Any exception thrown by this method will be treated.