Package org.ametys.plugins.odfpilotage.cost.entity

Class CostComputationData

java.lang.Object

org.ametys.plugins.odfpilotage.cost.entity.CostComputationData

public class CostComputationData
extends Object

This class store all of the information computed by the CostComputationComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<CoursePart,CoursePartCostData>	_coursePartsCostData	All informations about each coursePart gathered by their id
protected Map<String,Effectives>	_effectives	Effectives informations gathered by a program item
protected Map<String,EqTD>	_eqTD	TD equivalent values gathered by a program item
protected Map<String,Map<Container,Double>>	_eqTDByStep	All td equivalent by step gathered by their program item id
private Map<String,Double>	_heReport	HE report value gathered by a program item
protected Map<String,Map<Container,Double>>	_programItemEffectiveByStep	All effectives by step gathered by their program item id
protected List<ProgramItem>	_programItemStructure	List of program items in the program structure
protected Map<ProgramItem,Map<String,Container>>	_steps	Steps gathered by their program
protected Map<String,VolumesOfHours>	_volumesOfHours	Hourly volume gathered by a program item

Constructor Summary

Constructors

Constructor	Description
CostComputationData()	The constructor

Method Summary

Modifier and Type	Method	Description
void	add(Double effective, Container step, ProgramItem programItem)	Add a new effective by step to a program item
void	add(String parentId, String programItemId)	Transfer and compute effectives by step of the parent to the program item
void	addCoursePartCostData(CoursePart coursePart, CoursePartCostData coursePartCostData)	Add an element in the coursePartInformation map
void	addEnteredEffective(String programItemId, Optional<Double> enteredEffective)	Affect a new entered effective to a programItem
void	addEqTD(String programItemId, EqTD eqTD)	Add a new TD equivalent to a programItem
void	addEqTDByStep(String coursePartId, Map<Container,Double> eqTDByStep)	Affect eqTD values by step to a course part
void	addGlobalComputedEffective(String programItemId, Double computedGlobalEffective)	Affect a new global computed effective to a programItem
void	addHeReport(String programItemPath, Double heReport)	Add a new HE report value to a programItem
void	addLocalComputedEffective(String programItemId, String programItemPath, Double effectifCalculeLocal)	Affect a new local computed effective to a programItem
void	addProgramItem(ProgramItem programItem)	Add a new ProgramItem to the structure
void	addSteps(Map<String,Container> steps, ProgramItem programItem)	Add all steps of a program item
void	addVolumeOfHours(String programItemId, VolumesOfHours volumeOfHours)	Add a new volume of hours to a programItem
void	cloneWithWeight(double weight, ProgramItem programItem)	Apply a weight to all effectives by step of a program item
Boolean	contains(ProgramItem programItem)	Check if the program item belong to current structure
Map<Container,Double>	getAllEffectivesByStep()	Get all effectives by step
Optional<Double>	getComputedLocalEffective(String programItemId, String programItempath)	Get the local computed effective of a program item
Map<CoursePart,CoursePartCostData>	getCoursePartCostData()	Get the computedCourseParts map
CoursePartCostData	getCoursePartCostData(CoursePart coursePart)	Get coursePart informations retrieved by a coursePart
Effectives	getEffective(String programItemId)	Get the effective of a programItem
Map<Container,Double>	getEffectiveByStep(String programItemId)	Get effectives by step of a program item
Optional<Double>	getEnteredEffective(String programItemId)	Get the entered effective of a programItem
EqTD	getEqTD(String programItemId)	Get the TD equivalent of a programItem
Map<Container,Double>	getEqTDByStep(String coursePartId)	Get eqTD values of a course part
Map<String,Double>	getEqTDGlobal()	Get all global eqTD values
Map<String,Double>	getEqTDPorte()	Get all local eqTD values
Map<String,Double>	getEqTDProratise()	Get all pro-rated eqTD values
Optional<Double>	getGlobalComputedEffective(String programItemId)	Get the global computed effective of a programItem
Map<String,Double>	getHeReport()	Get all HE report values
Double	getHeReport(String programItemPath)	Get the HE report value of a programItem
List<ProgramItem>	getProgramItemStructure()	Get the program item structure
Map<ProgramItem,Map<String,Container>>	getSteps()	Get all steps of all program item
Map<String,VolumesOfHours>	getVolumesOfHours()	Get all volumes of hours gathered by their program item id
VolumesOfHours	getVolumesOfHours(String programItemId)	Get the volume of hours of a programItem
boolean	hasCoursePartsInfos(CoursePart coursePart)	Check if the map contains the key in parameter
void	setEffective(String programItemId, Effectives effective)	Add the effective of a programItem

Methods inherited from class java.lang.Object

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

Field Detail

_coursePartsCostData

protected Map<CoursePart,CoursePartCostData> _coursePartsCostData

All informations about each coursePart gathered by their id

_steps

protected Map<ProgramItem,Map<String,Container>> _steps

Steps gathered by their program

_volumesOfHours

protected Map<String,VolumesOfHours> _volumesOfHours

Hourly volume gathered by a program item

_effectives

protected Map<String,Effectives> _effectives

Effectives informations gathered by a program item

_eqTD

protected Map<String,EqTD> _eqTD

TD equivalent values gathered by a program item

_programItemStructure

protected List<ProgramItem> _programItemStructure

List of program items in the program structure

_eqTDByStep

protected Map<String,Map<Container,Double>> _eqTDByStep

All td equivalent by step gathered by their program item id

_programItemEffectiveByStep

protected Map<String,Map<Container,Double>> _programItemEffectiveByStep

All effectives by step gathered by their program item id

_heReport

private Map<String,Double> _heReport

HE report value gathered by a program item

Constructor Detail

CostComputationData

public CostComputationData()

The constructor

Method Detail

addProgramItem

public void addProgramItem(ProgramItem programItem)

Add a new ProgramItem to the structure

Parameters:

programItem - the new ProgramItem

contains

public Boolean contains(ProgramItem programItem)

Check if the program item belong to current structure

Parameters:

programItem - the programItem

Returns:

true if the list contains the programItem in parameter

getProgramItemStructure

public List<ProgramItem> getProgramItemStructure()

Get the program item structure

Returns:

the program item structure

getCoursePartCostData

public Map<CoursePart,CoursePartCostData> getCoursePartCostData()

Get the computedCourseParts map

Returns:

the computedCourseParts map

addCoursePartCostData

public void addCoursePartCostData(CoursePart coursePart,
                                  CoursePartCostData coursePartCostData)

Add an element in the coursePartInformation map

Parameters:

coursePart - the coursePart

coursePartCostData - cost data values of the coursePart

hasCoursePartsInfos

public boolean hasCoursePartsInfos(CoursePart coursePart)

Check if the map contains the key in parameter

Parameters:

coursePart - the key

Returns:

true is the map contains the key

getCoursePartCostData

public CoursePartCostData getCoursePartCostData(CoursePart coursePart)

Get coursePart informations retrieved by a coursePart

Parameters:

coursePart - the coursePart

Returns:

coursePart informations

cloneWithWeight

public void cloneWithWeight(double weight,
                            ProgramItem programItem)

Apply a weight to all effectives by step of a program item

Parameters:

weight - the weight

programItem - the program item

add

public void add(Double effective,
                Container step,
                ProgramItem programItem)

Add a new effective by step to a program item

Parameters:

effective - the effective to sum

step - the step

programItem - the program item

add

public void add(String parentId,
                String programItemId)

Transfer and compute effectives by step of the parent to the program item

Parameters:

parentId - the id of the parent

programItemId - the id of the program item

addEnteredEffective

public void addEnteredEffective(String programItemId,
                                Optional<Double> enteredEffective)

Affect a new entered effective to a programItem

Parameters:

programItemId - the id of the programItem

enteredEffective - the new entered effective

addGlobalComputedEffective

public void addGlobalComputedEffective(String programItemId,
                                       Double computedGlobalEffective)

Affect a new global computed effective to a programItem

Parameters:

programItemId - the id of the programItem

computedGlobalEffective - the new computed global effective

addLocalComputedEffective

public void addLocalComputedEffective(String programItemId,
                                      String programItemPath,
                                      Double effectifCalculeLocal)

Affect a new local computed effective to a programItem

Parameters:

programItemId - the id of the programItem

programItemPath - the current path

effectifCalculeLocal - the new computed local effective

getEnteredEffective

public Optional<Double> getEnteredEffective(String programItemId)

Get the entered effective of a programItem

Parameters:

programItemId - the id of the programItem

Returns:

the optional value of the effective

getGlobalComputedEffective

public Optional<Double> getGlobalComputedEffective(String programItemId)

Get the global computed effective of a programItem

Parameters:

programItemId - the id of the programItem

Returns:

the optional value of the effective

getComputedLocalEffective

public Optional<Double> getComputedLocalEffective(String programItemId,
                                                  String programItempath)

Get the local computed effective of a program item

Parameters:

programItemId - the id of the program item

programItempath - the program item path

Returns:

the optional value of the effective

getEffective

public Effectives getEffective(String programItemId)

Get the effective of a programItem

Parameters:

programItemId - the id of the programItem

Returns:

the effective

setEffective

public void setEffective(String programItemId,
                         Effectives effective)

Add the effective of a programItem

Parameters:

programItemId - the id of the programItem

effective - the effective

getVolumesOfHours

public VolumesOfHours getVolumesOfHours(String programItemId)

Get the volume of hours of a programItem

Parameters:

programItemId - the id of the programItem

Returns:

the hourly volume

getVolumesOfHours

public Map<String,VolumesOfHours> getVolumesOfHours()

Get all volumes of hours gathered by their program item id

Returns:

all volumes of hours

addVolumeOfHours

public void addVolumeOfHours(String programItemId,
                             VolumesOfHours volumeOfHours)

Add a new volume of hours to a programItem

Parameters:

programItemId - the id of the programItem

volumeOfHours - the volume of hours

addEqTD

public void addEqTD(String programItemId,
                    EqTD eqTD)

Add a new TD equivalent to a programItem

Parameters:

programItemId - the id of the programItem

eqTD - the TD equivalent

getEqTD

public EqTD getEqTD(String programItemId)

Get the TD equivalent of a programItem

Parameters:

programItemId - the id of a programItem

Returns:

the TD equivalent

addSteps

public void addSteps(Map<String,Container> steps,
                     ProgramItem programItem)

Add all steps of a program item

Parameters:

steps - all steps

programItem - the program item

getSteps

public Map<ProgramItem,Map<String,Container>> getSteps()

Get all steps of all program item

Returns:

all steps of all program item

getAllEffectivesByStep

public Map<Container,Double> getAllEffectivesByStep()

Get all effectives by step

Returns:

all effectives by step

getEffectiveByStep

public Map<Container,Double> getEffectiveByStep(String programItemId)

Get effectives by step of a program item

Parameters:

programItemId - the program item id

Returns:

effectives by step of a program item

addEqTDByStep

public void addEqTDByStep(String coursePartId,
                          Map<Container,Double> eqTDByStep)

Affect eqTD values by step to a course part

Parameters:

coursePartId - the coursePart id

eqTDByStep - eqTD by step values

getEqTDByStep

public Map<Container,Double> getEqTDByStep(String coursePartId)

Get eqTD values of a course part

Parameters:

coursePartId - the course part id

Returns:

eqTD values

addHeReport

public void addHeReport(String programItemPath,
                        Double heReport)

Add a new HE report value to a programItem

Parameters:

programItemPath - the path of the programItem

heReport - the HE report value

getHeReport

public Double getHeReport(String programItemPath)

Get the HE report value of a programItem

Parameters:

programItemPath - the path of a programItem

Returns:

the HE report value

getHeReport

public Map<String,Double> getHeReport()

Get all HE report values

Returns:

all HE report values

getEqTDProratise

public Map<String,Double> getEqTDProratise()

Get all pro-rated eqTD values

Returns:

all pro-rated eqTD values

getEqTDPorte

public Map<String,Double> getEqTDPorte()

Get all local eqTD values

Returns:

all local eqTD values

getEqTDGlobal

public Map<String,Double> getEqTDGlobal()

Get all global eqTD values

Returns:

all global eqTD values