fdda.plugins
Interface Plugin

All Known Subinterfaces:
AlgorithmLoader, SystemReader, SystemWriter
All Known Implementing Classes:
AlgorithmReader, ProjectReader, ProjectWriter

public interface Plugin

Generic interface for all plug-ins. All plug-ins of fdda must implement this interface.

Author:
Jörg Rüdenauer

Field Summary
static int ALGORITHM_READER
          Plug-in type: loads algorithms
static int SYSTEM_READER
          Plug-in type: loads projects
static int SYSTEM_WRITER
          Plug-in type: saves projects
 
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 useDialog(String component)
          Tells the plug-in to use the specified dialog component for its interactions with the user.
 

Field Detail

SYSTEM_READER

public static final int SYSTEM_READER
Plug-in type: loads projects

See Also:
Constant Field Values

SYSTEM_WRITER

public static final int SYSTEM_WRITER
Plug-in type: saves projects

See Also:
Constant Field Values

ALGORITHM_READER

public static final int ALGORITHM_READER
Plug-in type: loads algorithms

See Also:
Constant Field Values
Method Detail

getName

public String getName()
Returns the name of the plug-in.

Returns:
the name

getType

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

Returns:
the type

hasOptions

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

Returns:
true, iff the plug-in can be configured

useDialog

public void useDialog(String component)
               throws ComponentNotSupportedException
Tells the plug-in to use the specified dialog component for its interactions with the user.

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()
This method is used to configure the plug-in by user interaction. It may show a dialog.



API documentation for FDDA version 0.9. Generated on 17/02/2004 14:12.