edu.northwestern.at.wordhoard.swing.calculator.analysis
Interface AnalysisRunner

All Known Implementing Classes:

CollocateFrequencies, CompareCollocateFrequencies, CompareMultipleWordFrequencies, CompareSingleWordFrequencies, CompareTexts, FindCollocates, FindMultiwordUnits, FrequencyAnalysisRunnerBase, TrackWordOverTime, WordFrequencies

public interface AnalysisRunner

Interface implemented by WordHoard analysis classes.

Method Summary

boolean	areResultOptionsAvailable() Are result options available?
ResultsPanel	getChart() Get chart output.
ResultsPanel	getCloud() Get cloud output.
ResultsPanel	getContext(javax.swing.JFrame parentWindow, ProgressReporter progressReporter) Get context results.
LabeledColumn	getResultOptions() Get result options.
ResultsPanel	getResults() Get results.
void	handleTableSelectionChange(javax.swing.event.ListSelectionEvent event) Handle selection change in results table.
boolean	isChartAvailable() Is chart output available?
boolean	isCloudAvailable() Is cloud output available?
boolean	isContextAvailable() Is context output available?
boolean	isFilterAvailable() Is output filter available?
void	runAnalysis(javax.swing.JFrame parentWindow, ProgressReporter progressReporter) Run the analysis.
void	saveChart() Save the chart to a file.
void	setContextButton(javax.swing.JButton contextButton) Set the context button.
boolean	showDialog(javax.swing.JFrame parentWindow) Display the analysis dialog.

Method Detail

showDialog

boolean showDialog(javax.swing.JFrame parentWindow)

Display the analysis dialog.

Parameters:

parentWindow - The parent window for the dialog.

Returns:

true if OK pressed in dialog, false otherwise.

runAnalysis

void runAnalysis(javax.swing.JFrame parentWindow,
                 ProgressReporter progressReporter)

Run the analysis.

Parameters:

parentWindow - Parent window for dialogs in the analysis.

progressReporter - Progress display for analysis.

getChart

ResultsPanel getChart()

Get chart output.

Returns:

ResultsPanel containing the chart.

getCloud

ResultsPanel getCloud()

Get cloud output.

Returns:

ResultsPanel containing the cloud.

getResults

ResultsPanel getResults()

Get results.

Returns:

ResultsPanel containing the analysis results.

getContext

ResultsPanel getContext(javax.swing.JFrame parentWindow,
                        ProgressReporter progressReporter)

Get context results.

Parameters:

parentWindow - Parent window for dialogs in the analysis.

progressReporter - Progress display for analysis.

Returns:

ResultsPanel containing the context results.

isChartAvailable

boolean isChartAvailable()

Is chart output available?

Returns:

true if chart output available, false otherwise.

isContextAvailable

boolean isContextAvailable()

Is context output available?

Returns:

true if context output available, false otherwise.

isCloudAvailable

boolean isCloudAvailable()

Is cloud output available?

Returns:

true if cloud output available, false otherwise.

isFilterAvailable

boolean isFilterAvailable()

Is output filter available?

Returns:

true if output filter available, false otherwise.

areResultOptionsAvailable

boolean areResultOptionsAvailable()

Are result options available?

Returns:

true if result options are available, false otherwise.

getResultOptions

LabeledColumn getResultOptions()

Get result options.

Returns:

Result options as LabeledColumn.

setContextButton

void setContextButton(javax.swing.JButton contextButton)

Set the context button.

Parameters:

contextButton - The context button.

saveChart

void saveChart()

Save the chart to a file.

handleTableSelectionChange

void handleTableSelectionChange(javax.swing.event.ListSelectionEvent event)

Handle selection change in results table.

Parameters:

event - Table selection event.