fdda.plugins.xmlreader
Class AlgorithmReader

java.lang.Object
  |
  +--fdda.plugins.xmlreader.AlgorithmReader

All Implemented Interfaces:

AlgorithmLoader, Plugin

public class AlgorithmReader

extends Object

implements AlgorithmLoader

Reads information about an algorithm from an XML file according to 'algorithm.dtd'. Loads the associated classes.

Author:

Jörg Rüdenauer

Field Summary

static String	ALGORITHM_DEFAULT_PATH the default default path to algorithms
static String	ALGORITHM_PATH_OPTION preference option for the default path to algorithms

Fields inherited from interface fdda.plugins.Plugin

ALGORITHM_READER, SYSTEM_READER, SYSTEM_WRITER

Constructor Summary

AlgorithmReader()

Method Summary

void	configure() This method is used to configure the plug-in by user interaction.
String	getName() Returns the name of the plug-in.
int	getType() Returns the type of the plug-in (one of the constants of this interface)
boolean	hasOptions() Returns whether this plug-in can be configured by a call to configure()
void	searchForAlgorithms(ErrorHandler errorHandler) Searches in its storage location for algorithms and loads them into the instance of fdda.algorithms.Algorithms.
void	useDialog(String component) Tells the plug-in to use the specified dialog component for its interactions with the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALGORITHM_PATH_OPTION

public static final String ALGORITHM_PATH_OPTION

preference option for the default path to algorithms

See Also:

Constant Field Values

ALGORITHM_DEFAULT_PATH

public static final String ALGORITHM_DEFAULT_PATH

the default default path to algorithms

Constructor Detail

AlgorithmReader

public AlgorithmReader()

Method Detail

getName

public String getName()

Description copied from interface: Plugin

Returns the name of the plug-in.

Specified by:

getName in interface Plugin

Returns:

the name

getType

public int getType()

Description copied from interface: Plugin

Returns the type of the plug-in (one of the constants of this interface)

Specified by:

getType in interface Plugin

Returns:

the type

hasOptions

public boolean hasOptions()

Description copied from interface: Plugin

Returns whether this plug-in can be configured by a call to configure()

Specified by:

hasOptions in interface Plugin

Returns:

true, iff the plug-in can be configured

useDialog

public void useDialog(String component)
               throws ComponentNotSupportedException

Description copied from interface: Plugin

Tells the plug-in to use the specified dialog component for its interactions with the user.

Specified by:

useDialog in interface Plugin

Parameters:

component - name of the dialog component (e.g. "swing")

Throws:

ComponentNotSupportedException - if the plug-in can't use this component

configure

public void configure()

Description copied from interface: Plugin

This method is used to configure the plug-in by user interaction. It may show a dialog.

Specified by:

configure in interface Plugin

searchForAlgorithms

public void searchForAlgorithms(ErrorHandler errorHandler)

Description copied from interface: AlgorithmLoader

Searches in its storage location for algorithms and loads them into the instance of fdda.algorithms.Algorithms.

Specified by:

searchForAlgorithms in interface AlgorithmLoader

Parameters:

errorHandler - object that handles errors