org.jasen.config
Class JasenPluginConfiguration

java.lang.Object
  org.jasen.config.JasenPluginConfiguration

All Implemented Interfaces:

Comparable, Serializable

public class JasenPluginConfiguration

extends Object

implements Serializable, Comparable

Holds the configuration for a single jASEN plugin component.

Author:

Jason Polites

See Also:

Serialized Form

Constructor Summary

JasenPluginConfiguration()

Method Summary

int	compareTo(Object o)
String	getCalculator() Gets the calculator used to compute the result 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 internal name used to identify this plugin
String	getPriority() Gets the priority for this plugin.
String	getProperties() Gets the classpath relative path to the properties file used to configure this plugin
String	getType() Gets the plugin type.
void	setCalculator(String calculatorClass) Sets the calculator used to compute the result 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 internal name used to identify this plugin
void	setPriority(String priority) Sets the priority for this plugin.
void	setProperties(String properties) Gets the classpath relative path to the properties file used to configure this plugin This file MUST be in the classpath for the application
void	setType(String type) Sets the plugin type.

Methods inherited from class java.lang.Object

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

Constructor Detail

JasenPluginConfiguration

public JasenPluginConfiguration()

Method Detail

getCalculator

public String getCalculator()

Gets the calculator used to compute the result for this plugin

Returns:

The FQCN of the calculator class as a String

setCalculator

public void setCalculator(String calculatorClass)

Sets the calculator used to compute the result for this plugin

Parameters:

calculatorClass - The FQCN of the calculator class as a String

getName

public String getName()

Gets the internal name used to identify this plugin

Returns:

A String representation of the name

setName

public void setName(String name)

Sets the internal name used to identify this plugin

Parameters:

name - A String representation of the name

getType

public String getType()

Gets the plugin type. This represents the fully qualified class name of the plugin class

Returns:

The FQCN of the plugin class as a String

setType

public void setType(String type)

Sets the plugin type. This represents the fully qualified class name of the plugin class

Parameters:

type - The FQCN of the plugin class as a String

getPriority

public String getPriority()

Gets the priority for this plugin. This should be a parseable integer string

Returns:

A String representation of an integer

setPriority

public void setPriority(String priority)

Sets the priority for this plugin. This should be a parseable integer string

Parameters:

priority - A String representation of an integer

getProperties

public String getProperties()

Gets the classpath relative path to the properties file used to configure this plugin

Returns:

A String which represents either the absolute, or classpath-relative path to the properties file

setProperties

public void setProperties(String properties)

Gets the classpath relative path to the properties file used to configure this plugin
This file MUST be in the classpath for the application

Parameters:

properties - A String which represents either the absolute, or classpath-relative path to the properties file

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.

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable