The Meta-Environment API

nl.cwi.sen1.visbase.factbrowser.data
Class VisualisationPlugin

java.lang.Object
  extended by nl.cwi.sen1.visbase.factbrowser.data.VisualisationPlugin
All Implemented Interfaces:
java.lang.Comparable<VisualisationPlugin>

public class VisualisationPlugin
extends java.lang.Object
implements java.lang.Comparable<VisualisationPlugin>

This class represents the Visualisation Plugin. In this class the identifier and name of the plugin are registered.

Author:
Renze de Vries

Field Summary
private  int pluginId
           
private  java.lang.String pluginName
           
 
Constructor Summary
VisualisationPlugin()
          This is the default constructor only present for failsafe purposes.
VisualisationPlugin(java.lang.String pluginName, int pluginId)
          The constructor which makes it possible to create the representitive of the plugin visualisation.
 
Method Summary
 int compareTo(VisualisationPlugin arg0)
          This method makes it possible to sort the collection of VisualisationPlugins.
 int getPluginId()
          This method makes it possible to return the identifier of the plugin
 java.lang.String toString()
          This method return the name of the visualisation plugin so it can be displayed in the Tree.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

pluginName

private java.lang.String pluginName

pluginId

private int pluginId
Constructor Detail

VisualisationPlugin

public VisualisationPlugin()
This is the default constructor only present for failsafe purposes. The following constructor should be used: VisualisationPluginNode(String pluginName, int pluginId)


VisualisationPlugin

public VisualisationPlugin(java.lang.String pluginName,
                           int pluginId)
The constructor which makes it possible to create the representitive of the plugin visualisation.

Parameters:
pluginName - The name of the plugin
pluginId - The identifier of the plugin
Method Detail

getPluginId

public int getPluginId()
This method makes it possible to return the identifier of the plugin

Returns:
The identifier

toString

public java.lang.String toString()
This method return the name of the visualisation plugin so it can be displayed in the Tree.

Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(VisualisationPlugin arg0)
This method makes it possible to sort the collection of VisualisationPlugins. This is nessecary to have the same order in the visible Tree every time. This is regardless in which order the ToolBus send this.

Specified by:
compareTo in interface java.lang.Comparable<VisualisationPlugin>

The Meta-Environment API