org.nanes.slideset.pi

Interface PluginOutputPicker

All Known Implementing Classes:

CommandSkeletonService.CommandTemplateOutputPicker, PluginOutputMatcher, PluginOutputMatcherFrame

public interface PluginOutputPicker

Scheme for selecting among available options for handling plugin output values. May require user input.

Author:

Benjamin Nanes

See Also:

SlideSetPluginLoader

Method Summary

Modifier and Type	Method and Description
void	addOutput(String label, String[] choices, boolean[] link, String[] linkDir, String[] linkPre, String[] linkExt) Register a plugin output and available options for handling its value.
void	getOutputChoices(ArrayList<Integer> outputChoices, ArrayList<Integer> selectedParentFields, ArrayList<String> linkDir, ArrayList<String> linkPre, ArrayList<String> linkExt) Get chosen options for handling of each plugin output value, as well as fields from the parent table that should be copied to the results table.
void	setParentFieldLabels(String[] labels) Register fields from the parent table that are available for copying to the results table.

Method Detail

addOutput

void addOutput(String label,
               String[] choices,
               boolean[] link,
               String[] linkDir,
               String[] linkPre,
               String[] linkExt)

Register a plugin output and available options for handling its value. This method is invoked sequentially for each plugin output parameter.

Parameters:

label - Human-readable name of the output, i.e. for labeling a drop-down box.

choices - Human-readable names for each available option for handling the output value.

link - Indicator for an output handling option that should be treated as a file link, and will require values for the link path, file name prefix, and file extension.

linkDir - Default path used to write output data for output handling options using file links (ignored for others). May be null, in which case this PluginOutputPicker will determine the default.

linkPre - Default file prefix used to write output data for output handling options using file links (ignored for others). May be null, in which case this PluginOutputPicker will determine the default.

linkExt - Default file extension used to write output data for output handling options using file links (ignored for others). May be null, in which case this PluginOutputPicker will determine the default.

setParentFieldLabels

void setParentFieldLabels(String[] labels)

Register fields from the parent table that are available for copying to the results table.

Parameters:

labels - Human-readable names for the fields.

getOutputChoices

void getOutputChoices(ArrayList<Integer> outputChoices,
                      ArrayList<Integer> selectedParentFields,
                      ArrayList<String> linkDir,
                      ArrayList<String> linkPre,
                      ArrayList<String> linkExt)
               throws OperationCanceledException

Get chosen options for handling of each plugin output value, as well as fields from the parent table that should be copied to the results table. This method is invoked after all outputs have been registered. If user input is required, it should block until all selections have been made.

Parameters:

outputChoices - Empty list to be filled with index values of the selected output handling methods. The order of values corresponds to the order in which the plugin outputs were registered through addOutput. The values correspond to the indeces of the selected option in the choices array passed to addOutput.

selectedParentFields - Empty list to be filled with index values of the fields from the parent table that have been selected for copying to the results table. Values correspond to the indeces of selected fields in the labels array passed to setParentFieldLabels.

linkDir - Empty list to be filled with default paths to be used to write output data, or null if the selected plugin output handling method does not require a file link.

linkPre - Empty list to be filled with default file prefixes to be used to write output data, or null if the selected plugin output handling method does not require a file link.

linkExt - Empty list to be filled with default file extensions to be used to write output data, or null if the selected plugin output handling method does not require a file link.

Throws:

OperationCanceledException - If the user aborts the plugin, for example, by dismissing a dialog box without making the required selections.