org.trianacode.gui.hci

Interface ToolFilter

All Known Implementing Classes:

AllPackagesFilter, AllToolsFilter, DataTypeFilter, InputToolsFilter, OutputToolsFilter, SearchFilter, SubPackageFilter, ToolboxFilter, WorkflowFilter

public interface ToolFilter

An interface implemented by classes that map between tools and tool tree locations

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ROOT

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() This method is called when the filter is unchoosen.
java.lang.String[]	getFilteredPackage(Tool tool)
java.lang.String	getName()
java.lang.String	getRoot()
void	init() This method is called when the filter is choosen.

Field Detail

DEFAULT_ROOT

static final java.lang.String DEFAULT_ROOT

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns:

the name of this filter

getRoot

java.lang.String getRoot()

Returns:

the root for the tool tree

getFilteredPackage

java.lang.String[] getFilteredPackage(Tool tool)

Returns:

the filtered packages for the tool, empty array if the tool is ignored. (e.g. a tool in SignalPro.Input could become Input.SignalProc)

init

void init()

This method is called when the filter is choosen. The initialisation of the filter should be implemented here

dispose

void dispose()

This method is called when the filter is unchoosen. Any disposal related to the filter should be implemented here