fr.ifremer.isisfish.datastore
Class AnalysePlanStorage

java.lang.Object
  fr.ifremer.isisfish.datastore.VersionStorage
      fr.ifremer.isisfish.datastore.CodeSourceStorage
          fr.ifremer.isisfish.datastore.JavaSourceStorage
              fr.ifremer.isisfish.datastore.AnalysePlanStorage

All Implemented Interfaces:

Docable

public class AnalysePlanStorage
extends JavaSourceStorage
implements Docable

Class permettant de representer un plan d'analyse. Un plan d'analyse est un fichier Java que l'on compile si besoin.

Gere les fichiers VCS de type AnalysePlan (package analyseplans) Created: 17 août 2005 11:11:51 CEST

Version:

$Revision: 3124 $ Last update: $Date: 2010-11-29 19:14:09 +0100 (lun., 29 nov. 2010) $ by : $Author: chatellier $

Author:

Benjamin POUSSIN

Field Summary

static String	ANALYSE_PLAN_PATH
static String	ANALYSE_PLAN_TEMPLATE Template freemarker pour les plans d'analyse .

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

PARAM_PREFIX

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

content, lastContentLength, lastContentUpdate, name

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

changeListeners, file, root

Constructor Summary

protected

AnalysePlanStorage(File rootSrc, File directory, String name) Construit un nouveau AnalysePlan storage.

Method Summary

static void	checkout()
static AnalysePlanStorage	getAnalysePlan(String name) Retourne le storage pour le plan demandé.
static File	getAnalysePlanDirectory()
static List<String>	getAnalysePlanNames() Retourne le nom de toutes les plans existantes
Doc	getClassDoc() Class documentation (if any).
String	getDescription() Be ware this method require to instanciate a AnalysePlan, so it would be better to call as often as possible.
Doc	getFieldDoc(String fieldName) Field documentation (if any).
AnalysePlan	getNewAnalysePlanInstance() Retourne une nouvelle instance du plan.
static List<String>	getNewAnalysePlanNames() Retourne la liste des noms de tous les plans disponibles en local qui ne sont pas encore sur le serveur VCS.
static List<String>	getNewRemoteAnalysePlanNames() Retourne la liste des noms de tous les plans disponibles sur le serveur VCS qui ne sont pas encore en local
static String	getParamAsString(AnalysePlan plan) Recupere les parametres et leur valeur pour les retourner sous forme de chaine.
Doc	getParamDoc(String paramName)
Map<String,Class<?>>	getParameterNames() Permet de recuperer les parametres du plan.
static Map<String,Class<?>>	getParameterNames(AnalysePlan plan) Recherche par introspection tous les parametres de la classe commencant par param_
static Object	getParameterValue(AnalysePlan plan, String name) Donne la valeur d'un parametre par introspection
static List<String>	getRemoteAnalysePlanNames() Retourne la liste des noms de tous les plans disponibles sur le serveur VCS.
static void	setParameterValue(AnalysePlan plan, String name, Object value) Modifie la valeur d'un attribut pas introspection

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

compile, doJavadoc, getCodeClass, getFQN, getName, getNewInstance, getParameterDoc

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

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

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

add, addStorageChangeListener, checkout, commit, delete, fireDataChanged, getContextDatabaseCacheKey, getContextDatabaseDirectory, getFile, getFiles, getRemoteStorageNames, getRoot, getStorageNames, getVCS, isOnRemote, isUpToDate, isVersionnableFile, removeStorageChangeListener, update

Methods inherited from class java.lang.Object

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

Field Detail

ANALYSE_PLAN_PATH

public static final String ANALYSE_PLAN_PATH

See Also:

Constant Field Values

ANALYSE_PLAN_TEMPLATE

public static final String ANALYSE_PLAN_TEMPLATE

Template freemarker pour les plans d'analyse .

See Also:

Constant Field Values

Constructor Detail

AnalysePlanStorage

protected AnalysePlanStorage(File rootSrc,
                             File directory,
                             String name)

Construit un nouveau AnalysePlan storage.

Parameters:

rootSrc - repertoire root de stockage des plans

directory - le repertoire ou devrait se trouver le plan

name - le nom du plan

Method Detail

getAnalysePlanDirectory

public static File getAnalysePlanDirectory()

getAnalysePlanNames

public static List<String> getAnalysePlanNames()

Retourne le nom de toutes les plans existantes

Returns:

les noms de tous les plans existant en local

getAnalysePlan

public static AnalysePlanStorage getAnalysePlan(String name)

Retourne le storage pour le plan demandé.

Parameters:

name - le nom du plan souhaité

Returns:

Le storage pour le plan

getNewAnalysePlanInstance

public AnalysePlan getNewAnalysePlanInstance()
                                      throws IsisFishException

Retourne une nouvelle instance du plan. Compile le fichier si besoin

Returns:

retourne une nouvelle instance du plan

Throws:

IsisFishException - s'il y a un probleme d'instanciation

getParameterNames

public Map<String,Class<?>> getParameterNames()
                                       throws IsisFishException

Permet de recuperer les parametres du plan.

Returns:

Une map contenant le nom du parametre et son type

Throws:

IsisFishException - s'il est impossible de retourner une map convenable

getParameterNames

public static Map<String,Class<?>> getParameterNames(AnalysePlan plan)

Recherche par introspection tous les parametres de la classe commencant par param_

Parameters:

plan - le plan dont on souhaite les infos de parametre

Returns:

retourne le nom et le type des parametres du plan

getParameterValue

public static Object getParameterValue(AnalysePlan plan,
                                       String name)
                                throws IsisFishException

Donne la valeur d'un parametre par introspection

Parameters:

name - le nom du parametre

plan - le plan dont on souhaite la valeur du parametre

Returns:

la valeur courante du parametre

Throws:

IsisFishException - s'il y a un probleme pour recuperer la valeur

setParameterValue

public static void setParameterValue(AnalysePlan plan,
                                     String name,
                                     Object value)
                              throws IsisFishException

Modifie la valeur d'un attribut pas introspection

Parameters:

name - le nom de l'attribut

value - la valeur de l'attribut

plan - le plan dont on souhaite modifier la valeur de parametre

Throws:

IsisFishException - s'il y a un probleme

getParamAsString

public static String getParamAsString(AnalysePlan plan)
                               throws IsisFishException

Recupere les parametres et leur valeur pour les retourner sous forme de chaine. Pour pouvoir par exemple les afficher a l'utilisateur

Parameters:

plan - le plan dont on souhaite la valeur du parametre en string

Returns:

la valeur sous forme de string

Throws:

IsisFishException

checkout

public static void checkout()
                     throws VCSException

Throws:

VCSException

getNewAnalysePlanNames

public static List<String> getNewAnalysePlanNames()

Retourne la liste des noms de tous les plans disponibles en local qui ne sont pas encore sur le serveur VCS.

Returns:

liste de noms de plans

getRemoteAnalysePlanNames

public static List<String> getRemoteAnalysePlanNames()

Retourne la liste des noms de tous les plans disponibles sur le serveur VCS.

Returns:

la liste des noms de tous les plans disponibles sur le serveur VCS. Si le serveur n'est pas disponible la liste retournée est vide.

getNewRemoteAnalysePlanNames

public static List<String> getNewRemoteAnalysePlanNames()
                                                 throws VCSException

Retourne la liste des noms de tous les plans disponibles sur le serveur VCS qui ne sont pas encore en local

Returns:

liste de noms de regions

Throws:

VCSException

getClassDoc

public Doc getClassDoc()

Description copied from interface: Docable

Class documentation (if any).

Specified by:

getClassDoc in interface Docable

Returns:

the @Doc of the underlied AnalysePlan class

See Also:

DocHelper, Doc, Docable

getFieldDoc

public Doc getFieldDoc(String fieldName)

Description copied from interface: Docable

Field documentation (if any).

Specified by:

getFieldDoc in interface Docable

Parameters:

fieldName - name of the field to inspect

Returns:

the @Doc of the given field of the underlied AnalysePlan class

See Also:

DocHelper, Doc, Docable

getParamDoc

public Doc getParamDoc(String paramName)

Parameters:

paramName - the name of the param to inspect

Returns:

the doc associated with the param, (says the field PARAM_PREFIX+fieldName)

getDescription

public String getDescription()

Be ware this method require to instanciate a AnalysePlan, so it would be better to call as often as possible.

Specified by:

getDescription in interface Docable

Returns:

the descript of the instanciate AnalysePlan

See Also:

Doc, Docable