Package org.ametys.plugins.odfpilotage.report.consistency

Class AbstractConsistencyAnalysis

java.lang.Object

org.ametys.plugins.odfpilotage.report.consistency.AbstractConsistencyAnalysis

All Implemented Interfaces:

ConsistencyAnalysis, PluginAware, Prioritizable, Configurable, Serviceable

Direct Known Subclasses:

ECTSSumAnalysis, StepHolderAnalysis

public abstract class AbstractConsistencyAnalysis
extends Object
implements ConsistencyAnalysis, Configurable, Serviceable, PluginAware

The abstract class for ConsistencyAnalysis which parse the ID, label and short ID.

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nizableText	_description	Description.
protected String	_id	Analysis complete id.
protected I18nizableText	_label	Label.
protected ODFHelper	_odfHelper	The ODF helper.
protected String	_pluginName	Plugin name.
protected int	_priority	Priority.
protected String	_shortId	Analysis short id.

Constructor Summary

Constructors

Constructor	Description
AbstractConsistencyAnalysis()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
I18nizableText	getDescription()	Retrieves the description of the consistency analysis.
String	getId()	Retrieves the id of the consistency analysis.
I18nizableText	getLabel()	Retrieves the label of the consistency analysis.
int	getPriority()	Get the priority for the component.
String	getShortId()	Retrieves the short id of the consistency analysis.
void	service(ServiceManager manager)
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.report.consistency.ConsistencyAnalysis

analyze

Field Details

_pluginName

protected String _pluginName

Plugin name.

_id

protected String _id

Analysis complete id.

_shortId

protected String _shortId

Analysis short id.

_label

protected I18nizableText _label

Label.

_description

protected I18nizableText _description

Description.

_priority

protected int _priority

Priority.

_odfHelper

protected ODFHelper _odfHelper

The ODF helper.

Constructor Details

AbstractConsistencyAnalysis

public AbstractConsistencyAnalysis()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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: ConsistencyAnalysis

Retrieves the id of the consistency analysis.

Specified by:

getId in interface ConsistencyAnalysis

Returns:

the id.

getLabel

public I18nizableText getLabel()

Description copied from interface: ConsistencyAnalysis

Retrieves the label of the consistency analysis.

Specified by:

getLabel in interface ConsistencyAnalysis

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: ConsistencyAnalysis

Retrieves the description of the consistency analysis.

Specified by:

getDescription in interface ConsistencyAnalysis

Returns:

the description.

getShortId

public String getShortId()

Description copied from interface: ConsistencyAnalysis

Retrieves the short id of the consistency analysis.

Specified by:

getShortId in interface ConsistencyAnalysis

Returns:

the short id.

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority