Package org.ametys.plugins.odfpilotage.cost.eqtd

Class AbstractEqTDComputationMode

java.lang.Object

org.ametys.plugins.odfpilotage.cost.eqtd.AbstractEqTDComputationMode

All Implemented Interfaces:

EqTDComputationMode, PluginAware, Configurable

Direct Known Subclasses:

GroupsMode, IndividualMode

public abstract class AbstractEqTDComputationMode
extends Object
implements EqTDComputationMode, PluginAware, Configurable

Abstract class for TD equivalent computation mode.

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nizableText	_description	Description.
protected String	_id	Analysis complete id.
protected I18nizableText	_label	Label.
protected String	_pluginName	Plugin name.

Constructor Summary

Constructors

Constructor	Description
AbstractEqTDComputationMode()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
I18nizableText	getDescription()	Retrieves the description of the computation mode.
String	getId()	Retrieves the id of the computation mode.
I18nizableText	getLabel()	Retrieves the label of the computation mode.
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.odfpilotage.cost.eqtd.EqTDComputationMode

computeEqTD

Field Detail

_pluginName

protected String _pluginName

Plugin name.

_id

protected String _id

Analysis complete id.

_label

protected I18nizableText _label

Label.

_description

protected I18nizableText _description

Description.

Constructor Detail

AbstractEqTDComputationMode

public AbstractEqTDComputationMode()

Method Detail

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: EqTDComputationMode

Retrieves the id of the computation mode.

Specified by:

getId in interface EqTDComputationMode

Returns:

the id.

getLabel

public I18nizableText getLabel()

Description copied from interface: EqTDComputationMode

Retrieves the label of the computation mode.

Specified by:

getLabel in interface EqTDComputationMode

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: EqTDComputationMode

Retrieves the description of the computation mode.

Specified by:

getDescription in interface EqTDComputationMode

Returns:

the description.