fr.onema.sispea.struts.synthesis.action

Class AbstractSynthesisAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

fr.onema.sispea.struts.AbstractSispeaAction

fr.onema.sispea.struts.referential.action.AbstractUsersManagementAction

fr.onema.sispea.struts.referential.action.AbstractExerciseListAction

fr.onema.sispea.struts.synthesis.action.AbstractSynthesisAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, Serializable, org.apache.struts2.interceptor.ApplicationAware, org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.SessionAware

Direct Known Subclasses:

ShowChartSynthesisAction, ShowDataComparatorAction, ShowGlobalSynthesisAction, ShowTypologySynthesisAction

public abstract class AbstractSynthesisAction
extends AbstractExerciseListAction

This action defines the synthesis pages.

Author:

CS

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BoxAndWhiskerChartBean	boxAndWhiskerChart The scatter chart generated by the action.
protected CategoryChartBean	categoryChart The scatter chart Synthesis generated by the action .
protected Integer	chosenCriterionId selected Criterion id
protected Integer	chosenIndicatorId selectedIndicator :
protected Integer	chosenSliceId Selected slice :
protected CompetenceDto	competence competence to display
protected Integer	competenceId competence id to display
protected List<CriterionDto>	criteria exercise list
protected CriterionDto	criterion selected Criterion :
protected IndicatorDto	indicator The Indicator selected
protected Collection<IndicatorDto>	indicators List of indicator.
protected IndicatorService	indicatorService
protected List<IndicatorValueDto>	ipValues Table of ip values for drawing.
protected ReferentialService	referentialService
protected ScatterChartDto	scatterChart The scatter chart generated by the action.
protected SliceDto	slice Selected slice
protected List<SliceDto>	slices Slices :
protected List<SliceValuesDto>	slicesConsolidatedValues slicesValues_ :
protected SliceService	sliceService
protected Short	sliceYear Selected slice year
protected List<SynthDisplayDto>	synthDisplays the synth display list

Fields inherited from class fr.onema.sispea.struts.referential.action.AbstractExerciseListAction

chosenExerciseId, exercise, exerciseList, exerciseService

Fields inherited from class fr.onema.sispea.struts.referential.action.AbstractUsersManagementAction

pagingUser, searchUsersInfo

Fields inherited from class fr.onema.sispea.struts.AbstractSispeaAction

application, configuration, formatDate, formatDateOnly, menu, nextPage, parameters, serviceMessages, session, sispeaSession, strutsMessages, submitValue, territoryService, userService

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
AbstractSynthesisAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addScatterValueToChart(ScatterChartDto pScatterChart, List<ScatterValueDto> pSerie) adds the value of the list in the chart object
protected List<Short>	buildAllowedStatusIds()
protected String	buildCriterionDescription(boolean pOnlyUnit)
protected Map<String,String>	buildCriterionNameMap(Integer chosenExerciseId)
protected String	buildIndicatorDescription(boolean pOnlyUnit)
protected String	buildTitleDescription()
protected boolean	canViewItsOwnServices(UserDto pUser)
protected void	checkAndGetCompetence() check competence parameters and raise exception if not valid
protected void	checkAndGetCriterion(boolean pGlobalSynthesis) check criterion parameter and raise exception if not valid
protected void	checkAndGetIndicator(boolean pGlobalSynthesis, boolean pCheckConsolidation) check indicator parameter and raise exception if not valid
protected void	checkAndGetParameters(boolean pGlobalSynthesis, boolean pCheckConsolidation) check parameters and raise exception if not valid
protected void	checkAndGetSlices(boolean pGlobalSynthesis) check slice parameter and raise exception if not valid
BoxAndWhiskerChartBean	getBoxAndWhiskerChart()
CategoryChartBean	getCategoryChart()
String	getChartServletUrl()
protected ScatterChartDto	getChartSynthesisBySlice(List<Integer> pSpeaIds, List<Integer> pOwnSpeaIds, IndicatorDto pIndicator, CriterionDto pCriterion, SliceDto pSlice, List<SliceValuesDto> pSliceValues, boolean pSmaller) return a point cloud chart for typology synthesis for one slice
Integer	getChosenCriterionId()
Integer	getChosenIndicatorId()
Integer	getChosenSliceId()
CompetenceDto	getCompetence()
Integer	getCompetenceId()
List<CriterionDto>	getCriteria()
CriterionDto	getCriterion()
IndicatorDto	getIndicator()
Collection<IndicatorDto>	getIndicators()
List<IndicatorValueDto>	getIpValues()
String	getMenuKey(Boolean pGlobalSynthsesis)
ScatterChartDto	getScatterChart()
SliceDto	getSlice()
List<SliceDto>	getSlices()
List<SliceValuesDto>	getSlicesConsolidatedValues()
List<SliceValuesDto>	getSlicesValues()
Short	getSliceYear()
List<SynthDisplayDto>	getSynthDisplays()
protected boolean	getVisibility(Integer pExerciseId, Integer pIndicatorId)
protected Boolean	getVisibility(Integer pExerciseId, Integer pIndicatorId, Integer pSliceId, Integer pSliceNbValues)
protected void	processBarChart(ExerciseDto exercise, IndicatorDto indicator, List<SliceValuesDto> slicesConsolidatedValues, boolean pSmaller) do the job for bar synthesis display
protected void	processScatterChart(SliceDto slice, boolean pSmaller) do the job for box and whisker synthesis display
void	setBoxAndWhiskerChart(BoxAndWhiskerChartBean pBoxAndWhiskerChart)
void	setCategoryChart(CategoryChartBean pCategoryChart)
void	setChosenCriterionId(Integer pChosenCriterionId)
void	setChosenIndicatorId(Integer pChosenIndicatorId)
void	setChosenSliceId(Integer pChosenSliceId)
void	setCompetence(CompetenceDto pCompetence)
void	setCompetenceId(Integer pCompetenceId)
void	setCriteria(List<CriterionDto> pCriteria)
void	setCriterion(CriterionDto pCriterion)
void	setIndicator(IndicatorDto pIndicator)
void	setIndicators(Collection<IndicatorDto> pIndicators)
void	setIpValues(List<IndicatorValueDto> pIpValues)
void	setScatterChart(ScatterChartDto pScatterChart)
void	setSlice(SliceDto pSlice)
void	setSlices(List<SliceDto> pSlices)
void	setSlicesConsolidatedValues(List<SliceValuesDto> pSlicesConsolidatedValues)
void	setSlicesValues(List<SliceValuesDto> pSlicesValues)
void	setSliceYear(Short pSliceYear)
void	setSynthDisplays(List<SynthDisplayDto> pSynthDisplays)

Methods inherited from class fr.onema.sispea.struts.referential.action.AbstractExerciseListAction

checkExercise, getChosenExerciseId, getExercise, getExerciseList, loadExerciseList, setChosenExerciseId, setExercise

Methods inherited from class fr.onema.sispea.struts.referential.action.AbstractUsersManagementAction

checkSessionParams, formatString, getAllUserTypes, getBooleanCriteria, getConnectionTypes, getPagingUser, getSearchUsersInfo, getTrueCriterion, getUserTypes, loadUsers, manageUserPaging, setSearchUsersInfo

Methods inherited from class fr.onema.sispea.struts.AbstractSispeaAction

buildMenu, checkIfUserCanViewDashBoard, checkRight, checkUserRight, checkUserRight, checkUserRight, createMenu, doExecute, doHandleException, doHandleSispeaException, execute, getApplication, getCurrentUser, getCurrentUserTerritory, getFormatDate, getFormatDateOnly, getMenu, getNextPage, getOption, getParameters, getSession, getSispeaSession, getSubmitValue, initSession, isEnglish, isFrench, isSpanish, logException, openMenu, removeSession, setApplication, setMenu, setNextPage, setParameters, setSession, setSubmitValue

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

referentialService

@Autowired
protected transient ReferentialService referentialService

indicatorService

@Autowired
protected transient IndicatorService indicatorService

sliceService

@Autowired
protected transient SliceService sliceService

competenceId

protected Integer competenceId

competence id to display

competence

protected CompetenceDto competence

competence to display

indicators

protected Collection<IndicatorDto> indicators

List of indicator.

chosenIndicatorId

protected Integer chosenIndicatorId

selectedIndicator :

indicator

protected IndicatorDto indicator

The Indicator selected

criteria

protected List<CriterionDto> criteria

exercise list

chosenCriterionId

protected Integer chosenCriterionId

selected Criterion id

criterion

protected CriterionDto criterion

selected Criterion :

slices

protected List<SliceDto> slices

Slices :

chosenSliceId

protected Integer chosenSliceId

Selected slice :

slice

protected SliceDto slice

Selected slice

sliceYear

protected Short sliceYear

Selected slice year

slicesConsolidatedValues

protected List<SliceValuesDto> slicesConsolidatedValues

slicesValues_ :

categoryChart

protected CategoryChartBean categoryChart

The scatter chart Synthesis generated by the action .

scatterChart

protected ScatterChartDto scatterChart

The scatter chart generated by the action.

boxAndWhiskerChart

protected BoxAndWhiskerChartBean boxAndWhiskerChart

The scatter chart generated by the action.

ipValues

protected List<IndicatorValueDto> ipValues

Table of ip values for drawing.

synthDisplays

protected List<SynthDisplayDto> synthDisplays

the synth display list

Constructor Detail

AbstractSynthesisAction

public AbstractSynthesisAction()

Method Detail

getChartSynthesisBySlice

protected ScatterChartDto getChartSynthesisBySlice(List<Integer> pSpeaIds,
                                       List<Integer> pOwnSpeaIds,
                                       IndicatorDto pIndicator,
                                       CriterionDto pCriterion,
                                       SliceDto pSlice,
                                       List<SliceValuesDto> pSliceValues,
                                       boolean pSmaller)
                                            throws SispeaException

return a point cloud chart for typology synthesis for one slice

Parameters:

pSpeaIds -

pIndicator -

pCriterion -

Returns:

Throws:

SispeaException

addScatterValueToChart

protected void addScatterValueToChart(ScatterChartDto pScatterChart,
                          List<ScatterValueDto> pSerie)

adds the value of the list in the chart object

Parameters:

pScatterChart -

pSerie -

checkAndGetParameters

protected void checkAndGetParameters(boolean pGlobalSynthesis,
                         boolean pCheckConsolidation)
                              throws SispeaException

check parameters and raise exception if not valid

Throws:

SispeaException

checkAndGetCompetence

protected void checkAndGetCompetence()
                              throws SispeaException

check competence parameters and raise exception if not valid

Throws:

SispeaException

checkAndGetIndicator

protected void checkAndGetIndicator(boolean pGlobalSynthesis,
                        boolean pCheckConsolidation)
                             throws SispeaException

check indicator parameter and raise exception if not valid

Throws:

SispeaException

checkAndGetCriterion

protected void checkAndGetCriterion(boolean pGlobalSynthesis)
                             throws SispeaException

check criterion parameter and raise exception if not valid

Throws:

SispeaException

checkAndGetSlices

protected void checkAndGetSlices(boolean pGlobalSynthesis)
                          throws SispeaException

check slice parameter and raise exception if not valid

Throws:

SispeaException

processBarChart

protected void processBarChart(ExerciseDto exercise,
                   IndicatorDto indicator,
                   List<SliceValuesDto> slicesConsolidatedValues,
                   boolean pSmaller)
                        throws SispeaException

do the job for bar synthesis display

Throws:

SispeaException

processScatterChart

protected void processScatterChart(SliceDto slice,
                       boolean pSmaller)
                            throws SispeaException

do the job for box and whisker synthesis display

Throws:

SispeaException

canViewItsOwnServices

protected boolean canViewItsOwnServices(UserDto pUser)

Returns:

true if current user can view its own servcies on graph

getMenuKey

public String getMenuKey(Boolean pGlobalSynthsesis)

Parameters:

pGlobalSynthsesis - true if called from global synthesis, false else

Returns:

the menu to open

buildAllowedStatusIds

protected List<Short> buildAllowedStatusIds()

buildTitleDescription

protected String buildTitleDescription()

Returns:

a title for chart

buildCriterionDescription

protected String buildCriterionDescription(boolean pOnlyUnit)

Returns:

a description of selected criterion

buildIndicatorDescription

protected String buildIndicatorDescription(boolean pOnlyUnit)

Returns:

a description of selected indicator

buildCriterionNameMap

protected Map<String,String> buildCriterionNameMap(Integer chosenExerciseId)
                                            throws SispeaException

Throws:

SispeaException

getCompetenceId

public Integer getCompetenceId()

setCompetenceId

public void setCompetenceId(Integer pCompetenceId)

getCompetence

public CompetenceDto getCompetence()

setCompetence

public void setCompetence(CompetenceDto pCompetence)

getIndicators

public Collection<IndicatorDto> getIndicators()

setIndicators

public void setIndicators(Collection<IndicatorDto> pIndicators)

getChosenIndicatorId

public Integer getChosenIndicatorId()

setChosenIndicatorId

public void setChosenIndicatorId(Integer pChosenIndicatorId)

getIndicator

public IndicatorDto getIndicator()

setIndicator

public void setIndicator(IndicatorDto pIndicator)

getChosenCriterionId

public Integer getChosenCriterionId()

setChosenCriterionId

public void setChosenCriterionId(Integer pChosenCriterionId)

getCriterion

public CriterionDto getCriterion()

setCriterion

public void setCriterion(CriterionDto pCriterion)

getSlice

public SliceDto getSlice()

setSlice

public void setSlice(SliceDto pSlice)

getSynthDisplays

public List<SynthDisplayDto> getSynthDisplays()

setSynthDisplays

public void setSynthDisplays(List<SynthDisplayDto> pSynthDisplays)

getCriteria

public List<CriterionDto> getCriteria()

setCriteria

public void setCriteria(List<CriterionDto> pCriteria)

getSlicesValues

public List<SliceValuesDto> getSlicesValues()

setSlicesValues

public void setSlicesValues(List<SliceValuesDto> pSlicesValues)

getScatterChart

public ScatterChartDto getScatterChart()

setScatterChart

public void setScatterChart(ScatterChartDto pScatterChart)

getBoxAndWhiskerChart

public BoxAndWhiskerChartBean getBoxAndWhiskerChart()

setBoxAndWhiskerChart

public void setBoxAndWhiskerChart(BoxAndWhiskerChartBean pBoxAndWhiskerChart)

getChosenSliceId

public Integer getChosenSliceId()

setChosenSliceId

public void setChosenSliceId(Integer pChosenSliceId)

getSlicesConsolidatedValues

public List<SliceValuesDto> getSlicesConsolidatedValues()

setSlicesConsolidatedValues

public void setSlicesConsolidatedValues(List<SliceValuesDto> pSlicesConsolidatedValues)

getSlices

public List<SliceDto> getSlices()

setSlices

public void setSlices(List<SliceDto> pSlices)

getCategoryChart

public CategoryChartBean getCategoryChart()

setCategoryChart

public void setCategoryChart(CategoryChartBean pCategoryChart)

getChartServletUrl

public String getChartServletUrl()

getIpValues

public List<IndicatorValueDto> getIpValues()

setIpValues

public void setIpValues(List<IndicatorValueDto> pIpValues)

getSliceYear

public Short getSliceYear()

setSliceYear

public void setSliceYear(Short pSliceYear)

getVisibility

protected boolean getVisibility(Integer pExerciseId,
                    Integer pIndicatorId)

Parameters:

pExerciseId -

pIndicatorId -

Returns:

true if synthesis is displayed for exercise and competence. False else.

getVisibility

protected Boolean getVisibility(Integer pExerciseId,
                    Integer pIndicatorId,
                    Integer pSliceId,
                    Integer pSliceNbValues)

Parameters:

pExerciseId -

pIndicatorId -

Returns:

true if synthesis is displayed for exercise and competence. False else.