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

Class AnalysisEnumerator

java.lang.Object

org.ametys.plugins.odfpilotage.report.consistency.AnalysisEnumerator

All Implemented Interfaces:

Enumerator<String>, Configurable, Serviceable

public class AnalysisEnumerator
extends Object
implements Enumerator<String>, Serviceable, Configurable

Enumerator for ConsistencyAnalysis

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_allOption	true to have the all option.
protected AnalysisExtensionPoint	_analysisEP	The analysis extension point

Constructor Summary

Constructors

Constructor	Description
AnalysisEnumerator()

Method Summary

Modifier and Type	Method	Description
protected void	_handleAllOptionEntry(Map<String,I18nizableText> entries)	Add the all option entry to the entry list if necessary
void	configure(Configuration configuration)
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager smanager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.Enumerator

getConfiguration

Field Details

_analysisEP

protected AnalysisExtensionPoint _analysisEP

The analysis extension point

_allOption

protected boolean _allOption

true to have the all option. Default value: true

Constructor Details

AnalysisEnumerator

public AnalysisEnumerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

_handleAllOptionEntry

protected void _handleAllOptionEntry(Map<String,I18nizableText> entries)

Add the all option entry to the entry list if necessary

Parameters:

entries - The enumerator entries

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.