Package org.ametys.odf.skill

Class ODFSkillsHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.skill.ODFSkillsHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ODFSkillsHelper
extends AbstractLogEnabled
implements Serviceable, Component

ODF skills helper

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected ObservationManager	_observationManager	The observation manager
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SolrIndexHelper	_solrIndexHelper	The Solr index helper
static final String	ROLE	The avalon role.
static final String	SKILL_OTHER_NAMES_ATTRIBUTE_NAME	The skills other names attribute name
static final String	SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME	The internal attribute name to excluded from skills

Constructor Summary

Constructors

Constructor	Description
ODFSkillsHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_createSkillTableRef(org.ametys.odf.skill.ODFSkillsHelper.Skill skill)	Create a skill table ref content from the skill object
protected List<org.ametys.odf.skill.ODFSkillsHelper.Skill>	_getSkillsFromCSVFile(String skillsCSVFilePath)	Get the list of skills from the csv file
void	createSkillsFromESCOFileCSV(String skillsCSVFilePath)	Create all skills from ESCO file
Set<ContentValue>	getComputedSkills(AbstractProgram abstractProgram, int maxDepth)	Get the computed skill values for a given AbstractProgram
Map<Content,Map<Content,Map<Content,Content>>>	getSkillsDistribution(ProgramItem programItem)	Get the skills distribution by courses over a ProgramItem Distribution is computed over the course of first level only
Map<Content,Map<Content,Map<Content,Content>>>	getSkillsDistribution(ProgramItem programItem, int maxDepth)	Get the skills distribution by courses over a ProgramItem
boolean	isExcluded(ProgramItem programItem)	true if the program item is excluded from skills display
void	service(ServiceManager manager)
Map<String,Object>	setProgramItemsExclusion(List<String> programItemIds, boolean excluded)	Exclude or include the program items from skills display

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role.

SKILL_OTHER_NAMES_ATTRIBUTE_NAME

public static final String SKILL_OTHER_NAMES_ATTRIBUTE_NAME

The skills other names attribute name

See Also:

• Constant Field Values

SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME

public static final String SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME

The internal attribute name to excluded from skills

See Also:

• Constant Field Values

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_observationManager

protected ObservationManager _observationManager

The observation manager

_solrIndexHelper

protected SolrIndexHelper _solrIndexHelper

The Solr index helper

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

ODFSkillsHelper

public ODFSkillsHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setProgramItemsExclusion

public Map<String,Object> setProgramItemsExclusion(List<String> programItemIds,
 boolean excluded)

Exclude or include the program items from skills display

Parameters:

programItemIds - the list of program item ids

excluded - true if the program items need to be excluded.

Returns:

the map of changed program items properties

isExcluded

public boolean isExcluded(ProgramItem programItem)

true if the program item is excluded from skills display

Parameters:

programItem - the program item

Returns:

true if the program item is excluded from skills display

getComputedSkills

public Set<ContentValue> getComputedSkills(AbstractProgram abstractProgram,
 int maxDepth)

Get the computed skill values for a given AbstractProgram

Parameters:

abstractProgram - the abstract program

maxDepth - the max depth of courses. For example, set to 1 to compute skills over UE only, set 2 to compute skills over UE and EC, ...

Returns:

the skill values computed from the attached courses

getSkillsDistribution

public Map<Content,Map<Content,Map<Content,Content>>> getSkillsDistribution(ProgramItem programItem)

Get the skills distribution by courses over a ProgramItem Distribution is computed over the course of first level only

Parameters:

programItem - the program item

Returns:

the skills distribution

getSkillsDistribution

public Map<Content,Map<Content,Map<Content,Content>>> getSkillsDistribution(ProgramItem programItem,
 int maxDepth)

Get the skills distribution by courses over a ProgramItem

Parameters:

programItem - the program item

maxDepth - the max depth of courses. For example, set to 1 to compute distribution over UE only, set 2 to compute distribution over UE and EC, ...

Returns:

the skills distribution as Map<SkillSet, Map<Skill, Map<Course, AcquisitionLevel>>>

createSkillsFromESCOFileCSV

public void createSkillsFromESCOFileCSV(String skillsCSVFilePath)

Create all skills from ESCO file

Parameters:

skillsCSVFilePath - the skills CSV file path

_getSkillsFromCSVFile

protected List<org.ametys.odf.skill.ODFSkillsHelper.Skill> _getSkillsFromCSVFile(String skillsCSVFilePath)

Get the list of skills from the csv file

Parameters:

skillsCSVFilePath - the skills CSV file path

Returns:

the list of skills

_createSkillTableRef

protected void _createSkillTableRef(org.ametys.odf.skill.ODFSkillsHelper.Skill skill)
                             throws AmetysRepositoryException,
com.opensymphony.workflow.WorkflowException

Create a skill table ref content from the skill object

Parameters:

skill - the skill object

Throws:

AmetysRepositoryException - if a repository error occurred

com.opensymphony.workflow.WorkflowException - if a workflow error occurred