Package fr.ifremer.isisfish.datastore

Class FormuleStorage

java.lang.Object

fr.ifremer.isisfish.datastore.VersionStorage

fr.ifremer.isisfish.datastore.CodeSourceStorage

fr.ifremer.isisfish.datastore.FormuleStorage

All Implemented Interfaces:

Formule

public class FormuleStorage
extends CodeSourceStorage
implements Formule

Formule storage. Created: 4 févr. 2006 16:30:59

Version:

$Revision$ Last update: $Date$ by : $Author$

Author:

poussin

Nested Class Summary

Nested classes/interfaces inherited from class fr.ifremer.isisfish.datastore.CodeSourceStorage

CodeSourceStorage.Location

Field Summary

Fields

Modifier and Type	Field	Description
protected String	category	la categorie de la formule
static final String	FORMULE_PATH
static final String	FORMULE_TEMPLATE	Template freemarker pour les formules.

Fields inherited from class fr.ifremer.isisfish.datastore.CodeSourceStorage

content, lastContentLength, lastContentUpdate, name

Fields inherited from class fr.ifremer.isisfish.datastore.VersionStorage

file, root

Constructor Summary

Constructors

Constructor	Description
FormuleStorage(File rootSrc, File directory, String category, String name, String extension)	Create new formule storage.

Method Summary

Modifier and Type	Method	Description
static void	checkout()
static FormuleStorage	createFormule(String category, String name, String extension)	creer une nouvelle formule, si la formule existait deja, elle est ecrasé
static List<String>	getCategories()	Retourne toutes les categories existantes dans les formules sauvegardées.
static List<String>	getCategories(org.nuiton.topia.TopiaContext context)	Retourne toutes les categories existantes dans les formules sauvegardées ainsi que dans le TopiaContext passé en parametre
String	getCategory()	Return formule category name.
static FormuleStorage	getCommunityFormule(String category, String name)	Retourne le storage pour la regle demandée
static File	getCommunityFormuleDirectory()	Get community VCS formule directory.
static List<FormuleStorage>	getCommunityFormules(String category)	Retourne toutes les formules sauvegardees
static FormuleStorage	getFormule(String category, String name)	Retourne le storage pour la regle demandée
static File	getFormuleDirectory()	Get official VCS formule directory.
static List<String>	getFormuleNames(String category)	Retourne toutes les formules sauvegardees
static List<FormuleStorage>	getFormules(String category)	Retourne toutes les formules sauvegardees
static List<Formule>	getFormules(org.nuiton.topia.TopiaContext context, String category)	Retourne toutes les formules sauvegardees ainsi que dans le TopiaContext passé en parametre

Methods inherited from class fr.ifremer.isisfish.datastore.CodeSourceStorage

exists, getContent, getFiles, getName, nonEmptyLocation, prepare, reload, setContent, setContent

Methods inherited from class fr.ifremer.isisfish.datastore.VersionStorage

add, checkout, commit, delete, diff, getCommunityDatabaseDirectory, getCommunityVCS, getContextDatabaseDirectory, getCurrentVCS, getCurrentVCS, getFile, getFiles, getRemoteStorageNames, getRoot, getStorageNames, getVCS, isOnRemote, isUpToDate, isVersionnableFile, registerWatcher, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.ifremer.isisfish.entities.Formule

getContent, getName

Field Details

FORMULE_PATH

public static final String FORMULE_PATH

See Also:

• Constant Field Values

FORMULE_TEMPLATE

public static final String FORMULE_TEMPLATE

Template freemarker pour les formules.

See Also:

• Constant Field Values

category

protected String category

la categorie de la formule

Constructor Details

FormuleStorage

public FormuleStorage(File rootSrc,
 File directory,
 String category,
 String name,
 String extension)

Create new formule storage.

Parameters:

rootSrc - le repertoire root de stockage des formules

directory - le repertoire des formules

category - la category de la formule

name - le nom de la formule

extension - l'extension a utiliser ".java"

Method Details

getFormuleDirectory

public static File getFormuleDirectory()

Get official VCS formule directory.

Returns:

context formule directory

getCommunityFormuleDirectory

public static File getCommunityFormuleDirectory()

Get community VCS formule directory.

Returns:

community formule directory

getCategory

public String getCategory()

Description copied from interface: Formule

Return formule category name.

Specified by:

getCategory in interface Formule

Returns:

Returns the category.

getFormules

public static List<FormuleStorage> getFormules(String category)

Retourne toutes les formules sauvegardees

Parameters:

category - la categorie des formules recherchees

Returns:

la liste de formule de la category

getCommunityFormules

public static List<FormuleStorage> getCommunityFormules(String category)

Retourne toutes les formules sauvegardees

Parameters:

category - la categorie des formules recherchees

Returns:

la liste de formule de la category

getFormuleNames

public static List<String> getFormuleNames(String category)

Retourne toutes les formules sauvegardees

Parameters:

category - la categorie des formules dont on souhiate le nom

Returns:

la liste des noms formules existantes dans une categorie

getCategories

public static List<String> getCategories(org.nuiton.topia.TopiaContext context)

Retourne toutes les categories existantes dans les formules sauvegardées ainsi que dans le TopiaContext passé en parametre

Parameters:

context - le context dans lequel il faut faire la recherche

Returns:

la liste des noms des categories existantes

getFormules

public static List<Formule> getFormules(org.nuiton.topia.TopiaContext context,
 String category)

Retourne toutes les formules sauvegardees ainsi que dans le TopiaContext passé en parametre

Parameters:

category - la categorie dans lequel il faut faire la recherche

context - le context dans lequel il faut aussi recherche en plus des formules sauvegardees en tant que model

Returns:

la liste des formules de la categorie

getCategories

public static List<String> getCategories()

Retourne toutes les categories existantes dans les formules sauvegardées.

Returns:

la liste des categories existant en tant que modele

getFormule

public static FormuleStorage getFormule(String category,
 String name)

Retourne le storage pour la regle demandée

Parameters:

name - le nom de la regle souhaitée

category - la categorie de la regle

Returns:

Le storage pour la regle

getCommunityFormule

public static FormuleStorage getCommunityFormule(String category,
 String name)

Retourne le storage pour la regle demandée

Parameters:

name - le nom de la regle souhaitée

category - la categorie de la regle

Returns:

Le storage pour la regle

createFormule

public static FormuleStorage createFormule(String category,
 String name,
 String extension)

creer une nouvelle formule, si la formule existait deja, elle est ecrasé

Parameters:

category - la category de la formule

name - le nom de la formule

extension - le script de la formule

Returns:

Le storage pour la regle

checkout

public static void checkout()
                     throws VCSException

Throws:

VCSException