fr.ifremer.coser.services

Class PublicationService

java.lang.Object

fr.ifremer.coser.services.PublicationService

public class PublicationService
extends Object

Publication service (charts, reports, export, pdf...)

Author:

chatellier

Field Summary

Fields

Modifier and Type	Field and Description
protected CommonService	commonService
protected CoserBusinessConfig	config

Constructor Summary

Constructors

Constructor and Description
PublicationService(CoserBusinessConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.jfree.chart.JFreeChart	displayGraph(org.jfree.data.category.CategoryDataset categoryDataSet, String title)
File	exportErrorsAsHTML(Project project, AbstractDataContainer container, List<ControlError> validationErrors) Export la liste d'erreurs dans un fichier html avec la liste des graphes si necessaire.
protected void	exportErrorsAsHTML(Project project, AbstractDataContainer container, List<ControlError> validationErrors, Writer out, boolean includeProjectInfo) Export la liste d'erreurs dans un fichier html avec la liste des graphes si necessaire.
File	extractControlLogAsHTML(Project project, Control control) Extrait les logs des modifications faites sur un control au format html.
protected void	extractControlLogAsHTML(Project project, Control control, Writer out) Extrait les logs des modifications faites sur un control au format html dans un flux donné.
void	extractControlLogAsPDF(Project project, Control control, List<ControlError> validationErrors, File pdfFile) Extrait les logs des modifications faites sur un control au format pdf.
protected void	extractHistoryCommandReport(Project project, AbstractDataContainer container, Writer out) Partie commune aux export qui effectue en 2 passe la recuperation des lignes d'erreur, la recuperation des données correspondant à ces lignes dans les fichiers originaux et la sortie des erreurs.
protected void	extractProjectReport(Project project, Writer out) Extrait la partie "detail projet" vers le flux.
File	extractSelectionLogAsHTML(Project project, Selection selection) Extrait les logs des modifications faites sur une selection au format html.
protected void	extractSelectionLogAsHTML(Project project, Selection selection, Writer out) Extrait les logs des modifications faites sur une selection au format html dans le flux donné.
void	extractSelectionLogAsPDF(Project project, Selection selection, File pdfFile) Extrait les logs des modifications faites sur une selection au format pdf.
Map<String,org.jfree.chart.JFreeChart>	getCompareCatchLengthGraph(Project project, AbstractDataContainer container, Collection<String> speciesCollection) Retourne les graphiques de comparaison entre le nombre de capture et le nombre dans les tailles pour toutes les especes.
File	getRsufiResultComChart(Project project, File resultDirectory, RSufiResult rsufiResult, File codeTypeEspecesFile, String indicator, String list, String zoneDisplayName, String indicatorName, String unit, Locale locale) Generate community graph for selected indicator.
File	getRsufiResultComChartData(File resultDirectory, RSufiResult rsufiResult, String indicator, String list) Genere un sous fichier CSV (qui contient un sous ensemble de estPopInd) et qui a servit a generer le graphique.
Map<String,Object[]>	getRsufiResultComCharts(Project project, File resultDirectory, RSufiResult rsufiResult, File codeTypeEspecesFile, Collection<String> indicators, String zoneDisplayName, org.apache.commons.collections4.map.MultiKeyMap indicatorMap, Locale locale, int width, int height) Generate community graph for selected indicators.
File	getRsufiResultPopChart(Project project, File resultDirectory, RSufiResult rsufiResult, String species, String indicator, String zoneDisplayName, String indicatorName, String unit, Locale locale) Generate population graph for selected species and indicator.
File	getRsufiResultPopChartData(File resultDirectory, RSufiResult rsufiResult, String species, String indicator) Genere un sous fichier CSV (qui contient un sous ensemble de estPopInd) et qui a servit a generer le graphique.
Map<String,Object[]>	getRsufiResultPopCharts(Project project, File resultDirectory, RSufiResult rsufiResult, Collection<String> species, Collection<String> indicators, String zoneDisplayName, org.apache.commons.collections4.map.MultiKeyMap indicatorMap, Locale locale, int width, int height) Generate population graph for selected species and indicator.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected CoserBusinessConfig config

commonService

protected CommonService commonService

Constructor Detail

PublicationService

public PublicationService(CoserBusinessConfig config)

Method Detail

getCompareCatchLengthGraph

public Map<String,org.jfree.chart.JFreeChart> getCompareCatchLengthGraph(Project project,
                                                                AbstractDataContainer container,
                                                                Collection<String> speciesCollection)

Retourne les graphiques de comparaison entre le nombre de capture et le nombre dans les tailles pour toutes les especes.

Parameters:

project - project

container - data container

speciesCollection - utilisé pour n'avoir qu'une partie des especes (can be null)

Returns:

chart

displayGraph

protected org.jfree.chart.JFreeChart displayGraph(org.jfree.data.category.CategoryDataset categoryDataSet,
                                      String title)

exportErrorsAsHTML

public File exportErrorsAsHTML(Project project,
                      AbstractDataContainer container,
                      List<ControlError> validationErrors)
                        throws CoserBusinessException

Export la liste d'erreurs dans un fichier html avec la liste des graphes si necessaire. Genere les graphes en fin de fichier avec des liens html pour voir les graphes depuis les erreurs.

Parameters:

project - project

container - data container

validationErrors - errors list

Returns:

export html file

Throws:

CoserBusinessException

exportErrorsAsHTML

protected void exportErrorsAsHTML(Project project,
                      AbstractDataContainer container,
                      List<ControlError> validationErrors,
                      Writer out,
                      boolean includeProjectInfo)
                           throws CoserBusinessException,
                                  IOException

Export la liste d'erreurs dans un fichier html avec la liste des graphes si necessaire. Genere les graphes en fin de fichier avec des liens html pour voir les graphes depuis les erreurs.

Parameters:

project - project

container - data container

validationErrors - errors list

includeProjectInfo - add project info to generate persistant pdf

Throws:

CoserBusinessException

IOException

extractControlLogAsHTML

public File extractControlLogAsHTML(Project project,
                           Control control)
                             throws CoserBusinessException

Extrait les logs des modifications faites sur un control au format html.

Parameters:

project - project

control - data container

Returns:

extractedFile

Throws:

CoserBusinessException

See Also:

AbstractDataContainer.getHistoryCommands()

extractControlLogAsHTML

protected void extractControlLogAsHTML(Project project,
                           Control control,
                           Writer out)
                                throws CoserBusinessException,
                                       IOException

Extrait les logs des modifications faites sur un control au format html dans un flux donné.

Parameters:

project - project

control - data container

out - output stream

Throws:

CoserBusinessException

IOException

extractControlLogAsPDF

public void extractControlLogAsPDF(Project project,
                          Control control,
                          List<ControlError> validationErrors,
                          File pdfFile)
                            throws CoserBusinessException

Extrait les logs des modifications faites sur un control au format pdf.

Parameters:

project - project

control - data container

validationErrors -

pdfFile - output pdf file

Throws:

CoserBusinessException

See Also:

AbstractDataContainer.getHistoryCommands()

extractSelectionLogAsHTML

public File extractSelectionLogAsHTML(Project project,
                             Selection selection)
                               throws CoserBusinessException

Extrait les logs des modifications faites sur une selection au format html.

Parameters:

project - project

selection - data container

Returns:

extractedFile

Throws:

CoserBusinessException

See Also:

AbstractDataContainer.getHistoryCommands()

extractSelectionLogAsHTML

protected void extractSelectionLogAsHTML(Project project,
                             Selection selection,
                             Writer out)
                                  throws IOException,
                                         CoserBusinessException

Extrait les logs des modifications faites sur une selection au format html dans le flux donné.

Parameters:

project - project

selection - data container

out - output stream

Throws:

IOException

CoserBusinessException

See Also:

AbstractDataContainer.getHistoryCommands()

extractProjectReport

protected void extractProjectReport(Project project,
                        Writer out)
                             throws IOException

Extrait la partie "detail projet" vers le flux.

Parameters:

project - project

out - stream

Throws:

IOException

extractSelectionLogAsPDF

public void extractSelectionLogAsPDF(Project project,
                            Selection selection,
                            File pdfFile)
                              throws CoserBusinessException

Extrait les logs des modifications faites sur une selection au format pdf.

Parameters:

project - project

selection - data container

Throws:

CoserBusinessException

Since:

1.3

See Also:

AbstractDataContainer.getHistoryCommands()

extractHistoryCommandReport

protected void extractHistoryCommandReport(Project project,
                               AbstractDataContainer container,
                               Writer out)
                                    throws CoserBusinessException,
                                           IOException

Partie commune aux export qui effectue en 2 passe la recuperation des lignes d'erreur, la recuperation des données correspondant à ces lignes dans les fichiers originaux et la sortie des erreurs.

Parameters:

project - project

container - data container

out - output stream

Throws:

CoserBusinessException

IOException

getRsufiResultComChart

public File getRsufiResultComChart(Project project,
                          File resultDirectory,
                          RSufiResult rsufiResult,
                          File codeTypeEspecesFile,
                          String indicator,
                          String list,
                          String zoneDisplayName,
                          String indicatorName,
                          String unit,
                          Locale locale)
                            throws CoserBusinessException

Generate community graph for selected indicator. Used by web ui.

Parameters:

project - project

resultDirectory - result directory

rsufiResult - rsufiresult

codeTypeEspecesFile - le fichier contenant les code type espece (specifique au projet)

indicator - indicator

list - indicator's list (can be null : none selected)

zoneDisplayName - zone full name

indicatorName - indicatorName localized

unit - data unit

locale - locale

Returns:

generated graph image (temp file)

Throws:

CoserBusinessException

getRsufiResultPopChart

public File getRsufiResultPopChart(Project project,
                          File resultDirectory,
                          RSufiResult rsufiResult,
                          String species,
                          String indicator,
                          String zoneDisplayName,
                          String indicatorName,
                          String unit,
                          Locale locale)
                            throws CoserBusinessException

Generate population graph for selected species and indicator.

Parameters:

project - project

resultDirectory - result directory

rsufiResult - rsufi result

species - species

indicator - indicator

zoneDisplayName - zone full name

indicatorName - indicatorName localized

unit - data unit

locale - locale

Returns:

generated image file (temp file)

Throws:

CoserBusinessException

getRsufiResultComCharts

public Map<String,Object[]> getRsufiResultComCharts(Project project,
                                           File resultDirectory,
                                           RSufiResult rsufiResult,
                                           File codeTypeEspecesFile,
                                           Collection<String> indicators,
                                           String zoneDisplayName,
                                           org.apache.commons.collections4.map.MultiKeyMap indicatorMap,
                                           Locale locale,
                                           int width,
                                           int height)
                                             throws CoserBusinessException

Generate community graph for selected indicators. Used by web ui extraction.

Parameters:

project - project

resultDirectory - result directory

rsufiResult - rsufiresult

codeTypeEspecesFile - le fichier contenant les code type espece (specifique au projet)

indicator - indicator

zoneDisplayName - zone full name

indicatorName - indicatorName localized

unit - data unit

locale - locale

width - graph width

height - graph height

Returns:

generated graph image (temp file) and data

Throws:

CoserBusinessException

getRsufiResultPopCharts

public Map<String,Object[]> getRsufiResultPopCharts(Project project,
                                           File resultDirectory,
                                           RSufiResult rsufiResult,
                                           Collection<String> species,
                                           Collection<String> indicators,
                                           String zoneDisplayName,
                                           org.apache.commons.collections4.map.MultiKeyMap indicatorMap,
                                           Locale locale,
                                           int width,
                                           int height)
                                             throws CoserBusinessException

Generate population graph for selected species and indicator.

Parameters:

project - project

resultDirectory - result directory

rsufiResult - rsufi result

species - species

indicator - indicator

zoneDisplayName - zone full name

indicatorName - indicatorName localized

unit - data unit

locale - locale

width - graph width

height - graph height

Returns:

generated image file (temp file)

Throws:

CoserBusinessException

getRsufiResultComChartData

public File getRsufiResultComChartData(File resultDirectory,
                              RSufiResult rsufiResult,
                              String indicator,
                              String list)
                                throws CoserBusinessException

Genere un sous fichier CSV (qui contient un sous ensemble de estPopInd) et qui a servit a generer le graphique.

Parameters:

resultDirectory - result directory

rsufiResult - rsufi result

indicator - indicator

list - indicator's list (if null look for pop indicators or no list selected

Returns:

generated csv file (temp file)

Throws:

CoserBusinessException

getRsufiResultPopChartData

public File getRsufiResultPopChartData(File resultDirectory,
                              RSufiResult rsufiResult,
                              String species,
                              String indicator)
                                throws CoserBusinessException

Genere un sous fichier CSV (qui contient un sous ensemble de estPopInd) et qui a servit a generer le graphique.

Parameters:

resultDirectory - result directory

rsufiResult - rsufi result

species - species

indicator - indicator

Returns:

generated csv file (temp file)

Throws:

CoserBusinessException