Package org.ametys.odf.ose.export.utils

Class ElementRetriever

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.ose.export.utils.ElementRetriever

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ElementRetriever
extends AbstractLogEnabled
implements Component, Serviceable

A retriever used like a helper to retrieve some ODF elements from ODF items.

Field Summary

Fields

Modifier and Type	Field	Description
protected ODFHelper	_odfHelper	The helper for ODF contents
protected OdfReferenceTableHelper	_refTableHelper	The helper for reference tables from ODF
protected AmetysObjectResolver	_resolver	The resolver
static String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ElementRetriever()

Method Summary

Modifier and Type	Method	Description
private OrgUnit	_getDirectOrgUnit(ProgramItem programItem)
private Optional<OdfReferenceTableEntry>	_getPeriodType(ProgramItem programItem)
private Set<Container>	_getSelfAsStepOrParentSteps(ProgramItem programItem)
private Optional<Container>	_getStepHolderFromContainer(ProgramItem programItem)
private Optional<Container>	_getStepHolderFromCourse(ProgramItem programItem)
private Set<Container>	_getStepsHolderFromParentElements(ProgramItem programItem)
private boolean	_isContainerOfNature(ProgramItem programItem, String natureCode)
private boolean	_isSemester(ProgramItem programItem)
private boolean	_isStep(ProgramItem programItem)
private boolean	_mustNotExport(ProgramItem programItem)
private OrgUnit	_resolve(String id)
private <T extends ProgramItem & Content> OrgUnit	_resolveAllAndGetFirst(Collection<String> orgUnitIds, T programElement)
private Set<OrgUnit>	_retrieveOrgUnits(ProgramItem parent)
private Set<OrgUnit>	_retrieveOrgUnitsFromParents(ProgramItem programItem)
private Set<OdfReferenceTableEntry>	_searchPeriodTypesInParents(ProgramItem programItem)
Set<OdfReferenceTableEntry>	retrieveDegree(Container container)	Retrieve the degrees of a given Container
Set<OrgUnit>	retrieveOrgUnits(ProgramItem programItem)	Retrieve the OrgUnits of a given ProgramItem
Set<OdfReferenceTableEntry>	retrievePeriodTypes(ProgramItem programItem)	Get the potential period types of the program item.
Set<Container>	retrieveSteps(ProgramItem programItem)	Retrieve the steps (Containers of nature 'annee') of a given ProgramItem
Set<Container>	retrieveStepsHolder(ProgramItem programItem)	Get the potential steps holder of the program item.
void	service(ServiceManager manager)

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 Detail

ROLE

public static final String ROLE

Avalon Role

_odfHelper

protected ODFHelper _odfHelper

The helper for ODF contents

_refTableHelper

protected OdfReferenceTableHelper _refTableHelper

The helper for reference tables from ODF

_resolver

protected AmetysObjectResolver _resolver

The resolver

Constructor Detail

ElementRetriever

public ElementRetriever()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

retrieveSteps

public Set<Container> retrieveSteps(ProgramItem programItem)

Retrieve the steps (Containers of nature 'annee') of a given ProgramItem

Parameters:

programItem - The program item

Returns:

the steps (Containers of nature 'annee') of the given program item

_mustNotExport

private boolean _mustNotExport(ProgramItem programItem)

_getSelfAsStepOrParentSteps

private Set<Container> _getSelfAsStepOrParentSteps(ProgramItem programItem)

retrieveOrgUnits

public Set<OrgUnit> retrieveOrgUnits(ProgramItem programItem)

Retrieve the OrgUnits of a given ProgramItem

Parameters:

programItem - The program item

Returns:

the OrgUnits of the given program item

_retrieveOrgUnits

private Set<OrgUnit> _retrieveOrgUnits(ProgramItem parent)

_retrieveOrgUnitsFromParents

private Set<OrgUnit> _retrieveOrgUnitsFromParents(ProgramItem programItem)

_getDirectOrgUnit

private OrgUnit _getDirectOrgUnit(ProgramItem programItem)

_resolveAllAndGetFirst

private <T extends ProgramItem & Content> OrgUnit _resolveAllAndGetFirst(Collection<String> orgUnitIds,
                                                                         T programElement)

_resolve

private OrgUnit _resolve(String id)

retrieveDegree

public Set<OdfReferenceTableEntry> retrieveDegree(Container container)

Retrieve the degrees of a given Container

Parameters:

container - The container

Returns:

the degrees of the given container

retrieveStepsHolder

public Set<Container> retrieveStepsHolder(ProgramItem programItem)

Get the potential steps holder of the program item. A step is a container of year type and it can be set manually on intermediate courses.

Parameters:

programItem - The ProgramItem on which we have to retrieve the potential steps holder

Returns:

the potential steps holder of the program item

_getStepHolderFromCourse

private Optional<Container> _getStepHolderFromCourse(ProgramItem programItem)

_getStepHolderFromContainer

private Optional<Container> _getStepHolderFromContainer(ProgramItem programItem)

_isStep

private boolean _isStep(ProgramItem programItem)

_getStepsHolderFromParentElements

private Set<Container> _getStepsHolderFromParentElements(ProgramItem programItem)

retrievePeriodTypes

public Set<OdfReferenceTableEntry> retrievePeriodTypes(ProgramItem programItem)

Get the potential period types of the program item. It can be retrieved on courses or containers. The algorithm doesn't search in the parent of semester containers.

Parameters:

programItem - The ProgramItem on which we have to retrieve the potential period types

Returns:

the potential period types of the program item

_searchPeriodTypesInParents

private Set<OdfReferenceTableEntry> _searchPeriodTypesInParents(ProgramItem programItem)

_getPeriodType

private Optional<OdfReferenceTableEntry> _getPeriodType(ProgramItem programItem)

_isSemester

private boolean _isSemester(ProgramItem programItem)

_isContainerOfNature

private boolean _isContainerOfNature(ProgramItem programItem,
                                     String natureCode)