org.jasen.core
Class PluginContainer

java.lang.Object
  extended byorg.jasen.core.PluginContainer
All Implemented Interfaces:
Serializable

public class PluginContainer
extends Object
implements Serializable

Holds a plugin and its runtime configuration.

Author:
Jason Polites
See Also:
Serialized Form

Constructor Summary
PluginContainer()
           
 
Method Summary
 ProbabilityCalculator getCalculator()
          Gets the calculator used for this plugin
 String getDescription()
          Gets the summary description of this plugin.
 String getDisplayName()
          Gets the user friendly name of this plugin.
 String getName()
          Gets the name of this plugin
 JasenPlugin getPlugin()
          Gets the contained plugin
 void setCalculator(ProbabilityCalculator calculator)
          Sets the calculator used for this plugin
 void setDescription(String description)
          Sets the summary description of this plugin.
 void setDisplayName(String displayName)
          Sets the user friendly name of this plugin.
 void setName(String name)
          Sets the name of this plugin
 void setPlugin(JasenPlugin plugin)
          Gets the contained plugin
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginContainer

public PluginContainer()
Method Detail

getCalculator

public ProbabilityCalculator getCalculator()
Gets the calculator used for this plugin

Returns:
The calculator used by the plugin to calculate results

setCalculator

public void setCalculator(ProbabilityCalculator calculator)
Sets the calculator used for this plugin

Parameters:
calculator - The calculator used by the plugin to calculate results

getName

public String getName()
Gets the name of this plugin

Returns:
The display name of the plugin as a String

setName

public void setName(String name)
Sets the name of this plugin

Parameters:
name - The display name of the plugin as a String

getPlugin

public JasenPlugin getPlugin()
Gets the contained plugin

Returns:
The actual plugin instance

setPlugin

public void setPlugin(JasenPlugin plugin)
Gets the contained plugin

Parameters:
plugin - The actual plugin instance

getDescription

public String getDescription()
Gets the summary description of this plugin. Used for display in GUI systems etc.

Returns:
Returns the description.

setDescription

public void setDescription(String description)
Sets the summary description of this plugin. Used for display in GUI systems etc.

Parameters:
description - The description to set.

getDisplayName

public String getDisplayName()
Gets the user friendly name of this plugin. Used for display in GUI systems etc.

Returns:
Returns the displayName.

setDisplayName

public void setDisplayName(String displayName)
Sets the user friendly name of this plugin. Used for display in GUI systems etc.

Parameters:
displayName - The displayName to set.