plugin
Interface IArcPlugin

All Known Implementing Classes:

MidiAnalyzer, TextAnalyzer

public interface IArcPlugin

The interface that every plug-in must implement.

Author:

Hannes

Method Summary

edu.umd.cs.piccolo.PNode	getDescription() Returns a kind of description of the actual input (e.g. a sheet of music for a midi file).
java.util.List	getItems() Returns a list of items, according the actual input.
java.lang.String	getName() Returns the plug-ins name (e.g.
javax.swing.JPanel	getPanel() Returns a "configuration panel", which can be displayed somewhere in the application.
boolean	isEqual(java.lang.Object o1, java.lang.Object o2) Compares two objects.
java.lang.String	list2String(java.util.List l) Returns a string, according to the parameter.

Method Detail

getName

java.lang.String getName()

Returns the plug-ins name (e.g. "MIDI")

getItems

java.util.List getItems()
                        throws java.lang.Exception

Returns a list of items, according the actual input.

Throws:

java.lang.Exception

isEqual

boolean isEqual(java.lang.Object o1,
                java.lang.Object o2)

Compares two objects.

Returns:

'true' if the objects are equal, 'false' else.

getPanel

javax.swing.JPanel getPanel()

Returns a "configuration panel", which can be displayed somewhere in the application.

list2String

java.lang.String list2String(java.util.List l)

Returns a string, according to the parameter.

Parameters:

l - should be the list returned by getItems (or a part of it)

getDescription

edu.umd.cs.piccolo.PNode getDescription()

Returns a kind of description of the actual input (e.g. a sheet of music for a midi file).