fr.ifremer.coser.services

Class CommonService

java.lang.Object

fr.ifremer.coser.services.CommonService

public class CommonService
extends Object

Common methods used by others services only.

• csv import/export
• file name management
• utilities methods

Author:

chatellier

Field Summary

Fields

Modifier and Type	Field and Description
protected CoserBusinessConfig	config

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkFileHeader(File file, CoserConstants.Category category, String[] line) Check csv file header names and order depending on file category.
protected String	getDataStorageFileName(Project project, CoserConstants.Category category, String suffix) Deprecated. since 1.5, use now Project#getDataStorageFileName(Category, String)
DataStorage	getEmptyStorage(Project project, CoserConstants.Category category) Get empty storage for category (filled with just header)
Map<String,String[]>	getOriginalContent(Project project, CoserConstants.Category category, Collection<String> lines) Lit tout le fichier associé à la categorie demandé, mais ne retourne que les données correspondant au numéro de lignes demandée.
Map<String,String[]>	getOriginalFileContent(File file, Collection<String> lines) Lit le fichier demandé et sauve dans une map les lignes demandées.
String	getReportDisplayName(Project project, String species) Retourne le nom d'affichage d'une especes pour les rapports.
DataStorage	loadCSVFile(File file) Charge un fichier csv (estcomind/estpopind ...) mais sans verification.
DataStorage	loadCSVFile(File file, char separator) Charge un fichier csv (estcomind/estpopind ...) mais sans verification.
DataStorage	loadCSVFile(Project project, CoserConstants.Category category, File file) Load file as csv.
DataStorage	loadCSVFile(Project project, CoserConstants.Category category, File file, ProgressMonitor progress) Load file as csv.
DataStorage	loadCSVFile(Project project, CoserConstants.Category category, File file, ProgressMonitor progress, boolean originalLoading) Load file as csv.
void	storeData(DataStorage content, File file) Store project category data in specified file as csv.
void	storeDataWhithoutQuote(DataStorage content, File file, Map<String,String> refTaxSpecies, CoserConstants.Category category) Deprecated. since 1.4, prefer use of #storeDataWhithoutQuote(DataStorage, Writer, Map, Category)
void	storeDataWhithoutQuote(DataStorage content, Writer writer, Map<String,String> refTaxSpecies, CoserConstants.Category category) Store data without quoting every columns with "" (r specific demand).

Methods inherited from class java.lang.Object

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

Field Detail

config

protected CoserBusinessConfig config

Method Detail

loadCSVFile

public DataStorage loadCSVFile(Project project,
                      CoserConstants.Category category,
                      File file)
                        throws CoserBusinessException

Load file as csv. Check and affect data in project depending on category type.

Parameters:

project - project

category - category

file - file to load

Returns:

data storage with file content

Throws:

CoserBusinessException

loadCSVFile

public DataStorage loadCSVFile(Project project,
                      CoserConstants.Category category,
                      File file,
                      ProgressMonitor progress)
                        throws CoserBusinessException

Load file as csv. Check and affect data in project depending on category type.

Parameters:

project - project

category - category

file - file to load

progress - progress monitor (can be null)

Returns:

data storage with file content

Throws:

CoserBusinessException

loadCSVFile

public DataStorage loadCSVFile(Project project,
                      CoserConstants.Category category,
                      File file,
                      ProgressMonitor progress,
                      boolean originalLoading)
                        throws CoserBusinessException

Load file as csv. Check and affect data in project depending on category type.

Parameters:

project - project

category - category

file - file to load

progress - progress monitor (can be null)

originalLoading - dans le cas d'un reload, la colonne "line" est a prendre en compte pour les data (elle est absente dans les jeux de données originaux)

Returns:

data storage with file content

Throws:

CoserBusinessException

checkFileHeader

protected void checkFileHeader(File file,
                   CoserConstants.Category category,
                   String[] line)
                        throws CoserBusinessException

Check csv file header names and order depending on file category.

Parameters:

file - file

category - category

line - header line to ckeck

Throws:

CoserBusinessException

getEmptyStorage

public DataStorage getEmptyStorage(Project project,
                          CoserConstants.Category category)

Get empty storage for category (filled with just header)

Parameters:

project - project

category - category

Returns:

initialized storage

storeData

public void storeData(DataStorage content,
             File file)
               throws CoserBusinessException

Store project category data in specified file as csv.

Parameters:

content - content to save

file - file to save to

Throws:

CoserBusinessException

storeDataWhithoutQuote

public void storeDataWhithoutQuote(DataStorage content,
                          File file,
                          Map<String,String> refTaxSpecies,
                          CoserConstants.Category category)
                            throws CoserBusinessException

Deprecated. since 1.4, prefer use of #storeDataWhithoutQuote(DataStorage, Writer, Map, Category)

Store data without quoting every columns with "" (r specific demand).

Parameters:

content - content to save

file - file to save to

project - project used only to get species output field (can be null)

category - category used to replace species output field if needed (can be null)

Throws:

CoserBusinessException

storeDataWhithoutQuote

public void storeDataWhithoutQuote(DataStorage content,
                          Writer writer,
                          Map<String,String> refTaxSpecies,
                          CoserConstants.Category category)
                            throws CoserBusinessException

Store data without quoting every columns with "" (r specific demand).

Parameters:

content - content to save

file - file to save to

project - project used only to get species output field (can be null)

category - category used to replace species output field if needed (can be null)

Throws:

CoserBusinessException

Since:

1.4

getOriginalFileContent

public Map<String,String[]> getOriginalFileContent(File file,
                                          Collection<String> lines)
                                            throws CoserBusinessException

Lit le fichier demandé et sauve dans une map les lignes demandées.

Parameters:

file - file to read

lines - lines to save content

Returns:

saved content

Throws:

CoserBusinessException

loadCSVFile

public DataStorage loadCSVFile(File file)
                        throws CoserBusinessException

Charge un fichier csv (estcomind/estpopind ...) mais sans verification. C'est a peu pret le meme code qu'au dessus, sauf que le storage est simplement retourné et que les séparateurs ne sont pas les même.

Parameters:

file - file to load

Returns:

data storage with file content

Throws:

CoserBusinessException

loadCSVFile

public DataStorage loadCSVFile(File file,
                      char separator)
                        throws CoserBusinessException

Charge un fichier csv (estcomind/estpopind ...) mais sans verification. C'est a peu pret le meme code qu'au dessus, sauf que le storage est simplement retourné et que les séparateurs ne sont pas les même.

Parameters:

file - file to load

separator - separator to use to load file

Returns:

data storage with file content

Throws:

CoserBusinessException

getDataStorageFileName

@Deprecated
protected String getDataStorageFileName(Project project,
                                       CoserConstants.Category category,
                                       String suffix)

Deprecated. since 1.5, use now Project#getDataStorageFileName(Category, String)

Retourne le nom de stockage d'un fichier de données suivant la categories de fichier demandé. Les fichiers sont stockés avec leurs noms originaux (sauf les fichiers de réference) donc il n'est pas fixe.

Parameters:

project - project (containing originals file names)

category - category to get file name

suffix - suffix to add into file name

Returns:

storage file name

getOriginalContent

public Map<String,String[]> getOriginalContent(Project project,
                                      CoserConstants.Category category,
                                      Collection<String> lines)
                                        throws CoserBusinessException

Lit tout le fichier associé à la categorie demandé, mais ne retourne que les données correspondant au numéro de lignes demandée. Le contenu retourné ne contient pas le numéro de ligne.

Parameters:

project - project

category - category

lines - lines to get content

Returns:

content for lines

Throws:

CoserBusinessException

getReportDisplayName

public String getReportDisplayName(Project project,
                          String species)

Retourne le nom d'affichage d'une especes pour les rapports.

Parameters:

project - project

species - species code

Returns:

species display name