fr.ifremer.isisfish.datastore
Class ScriptStorage

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

All Implemented Interfaces:

Docable

public class ScriptStorage
extends JavaSourceStorage
implements Docable

Gestion des fichers CVS de type scripts (appartenant au module scripts). Created: 18 août 2005 15:07:36 CEST

Version:

$Revision: 2938 $ Last update: $Date: 2010-01-22 16:42:09 +0100 (ven., 22 janv. 2010) $ by : $Author: chatellier $

Author:

Grégoire DESSARD

Field Summary

static String	SCRIPT_PATH
static String	SCRIPT_TEMPLATE Template freemarker pour les scripts.

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

ScriptStorage(File rootSrc, File directory, String name) Constructeur

Method Summary

static void	checkout()
Doc	getClassDoc() Class documentation (if any).
String	getDescription() Be ware this method require to instanciate a Rule, so it would be better to call as often as possible.
Doc	getFieldDoc(String fieldName) Field documentation (if any).
static List<String>	getNewRemoteScriptNames() Retourne la liste des noms de toutes les régions disponible sur le serveur CVS qui ne sont pas encore en local
Object	getNewScriptInstance() Retourne une nouvelle instance de la regle.
static List<String>	getNewScriptNames() Retourne la liste des noms de toutes les régions disponible en local qui ne sont pas encore sur le serveur CVS
static List<String>	getRemoteScriptNames() Retourne la liste des noms de toutes les régions disponible sur le serveur CVS
static ScriptStorage	getScript(String name) Retourne le storage pour la regle demandée
static File	getScriptDirectory()
static List<String>	getScriptNames() Retourne la liste des noms de toutes les régions disponible en local

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

SCRIPT_PATH

public static final String SCRIPT_PATH

See Also:

Constant Field Values

SCRIPT_TEMPLATE

public static final String SCRIPT_TEMPLATE

Template freemarker pour les scripts.

See Also:

Constant Field Values

Constructor Detail

ScriptStorage

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

Constructeur

Parameters:

rootSrc - le repertoire root de stockage

directory - le repertoire des scripts

name - le nom du script

Method Detail

getScriptDirectory

public static File getScriptDirectory()

getNewScriptInstance

public Object getNewScriptInstance()
                            throws IsisFishException

Retourne une nouvelle instance de la regle. Compile le fichier si besoin

Returns:

une nouvelle instance

Throws:

IsisFishException

getScript

public static ScriptStorage getScript(String name)

Retourne le storage pour la regle demandée

Parameters:

name - le nom de la regle souhaitée

Returns:

Le storage pour la regle

checkout

public static void checkout()
                     throws VCSException

Throws:

VCSException

getScriptNames

public static List<String> getScriptNames()

Retourne la liste des noms de toutes les régions disponible en local

Returns:

la liste des noms de toutes les régions disponible en local

getNewScriptNames

public static List<String> getNewScriptNames()

Retourne la liste des noms de toutes les régions disponible en local qui ne sont pas encore sur le serveur CVS

Returns:

liste de noms de regions

getRemoteScriptNames

public static List<String> getRemoteScriptNames()

Retourne la liste des noms de toutes les régions disponible sur le serveur CVS

Returns:

la liste des noms de toutes les régions disponible sur le serveur CVS. Si le serveur n'est pas disponible la liste retournée est vide.

getNewRemoteScriptNames

public static List<String> getNewRemoteScriptNames()

Retourne la liste des noms de toutes les régions disponible sur le serveur CVS qui ne sont pas encore en local

Returns:

liste de noms de regions

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 rule 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 Rule class

See Also:

DocHelper, Doc, Docable

getDescription

public String getDescription()

Be ware this method require to instanciate a Rule, 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