fr.ifremer.isisfish.datastore
Class RuleStorage

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

All Implemented Interfaces:

Docable

public class RuleStorage
extends JavaSourceStorage
implements Docable

Class permettant de representer une regle de gestion. Une regle de gestion est un fichier Java que l'on compile si besoin. Il se trouve dans le package portant le nom de la region de cette maniere plusieurs region peuvent avoir des regles avec le meme nom mais pas le meme code.

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

Version:

$Revision: 3627 $ Last update: $Date: 2012-03-02 14:08:28 +0100 (Fri, 02 Mar 2012) $ by : $Author: echatellier $

Author:

Benjamin POUSSIN

Nested Class Summary

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

CodeSourceStorage.Location

Field Summary

static String	RULE_PATH
static String	RULE_TEMPLATE Template freemarker pour les regles.

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

RuleStorage(File rootSrc, File directory, String name) Contruit un nouveau rule storage

Method Summary

static void	checkout()
static RuleStorage	createRule(String name, CodeSourceStorage.Location location) Create new rule.
static File	getCommunityRuleDirectory() Get community VCS rule directory.
String	getDescription() Be ware this method require to instanciate a Rule, so it would be better to call as often as possible.
static List<String>	getNewRemoteRuleNames() Retourne la liste des noms de toutes les régions disponible sur le serveur VCS qui ne sont pas encore en local
Rule	getNewRuleInstance() Retourne une nouvelle instance de la regle.
static List<String>	getNewRuleNames() Retourne la liste des noms de toutes les régions disponible en local qui ne sont pas encore sur le serveur VCS
static List<String>	getRemoteRuleNames() Retourne la liste des noms de toutes les régions disponible sur le serveur VCS
static RuleStorage	getRule(String name, CodeSourceStorage.Location... location) Retourne le storage pour la regle demandée
static File	getRuleDirectory() Get context (official VCS) rule directory.
static List<String>	getRuleNames() Retourne le nom de toutes les regles existantes pour cette region

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

compile, doJavadoc, getCodeClass, getFieldDoc, getFieldDoc, getFQN, getName, getNewInstance, getParamAsString, getParameterDoc, getParameterNames, getParameterNames, getParameterType, getParameterValue, setParameterValue

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, addStorageChangeListener, checkout, commit, delete, diff, fireDataChanged, getCommunityDatabaseDirectory, getCommunityVCS, getContextDatabaseDirectory, getCurrentVCS, getCurrentVCS, 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

Methods inherited from interface fr.ifremer.isisfish.util.Docable

getFieldDoc

Field Detail

RULE_PATH

public static final String RULE_PATH

See Also:

Constant Field Values

RULE_TEMPLATE

public static final String RULE_TEMPLATE

Template freemarker pour les regles.

See Also:

Constant Field Values

Constructor Detail

RuleStorage

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

Contruit un nouveau rule storage

Parameters:

rootSrc - La region auquelle est attaché la rule

directory - le repertoire ou devrait se trouver la rule

name - le nom de la rule

Method Detail

getRuleDirectory

public static File getRuleDirectory()

Get context (official VCS) rule directory.

Returns:

context rule directory

getCommunityRuleDirectory

public static File getCommunityRuleDirectory()

Get community VCS rule directory.

Returns:

community rule directory

getRuleNames

public static List<String> getRuleNames()

Retourne le nom de toutes les regles existantes pour cette region

Returns:

all rule names found in local user database

getRule

public static RuleStorage getRule(String name,
                                  CodeSourceStorage.Location... location)

Retourne le storage pour la regle demandée

Parameters:

name - le nom de la regle souhaitée

location - location to open storage file

Returns:

Le storage pour la regle

createRule

public static RuleStorage createRule(String name,
                                     CodeSourceStorage.Location location)

Create new rule.

Parameters:

name - new rule to create

location - location to rule storage file

Returns:

new rule storage

getNewRuleInstance

public Rule getNewRuleInstance()
                        throws IsisFishException

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

Returns:

a new rule instance

Throws:

IsisFishException - if any exception while instanciation

checkout

public static void checkout()
                     throws VCSException

Throws:

VCSException

getNewRuleNames

public static List<String> getNewRuleNames()

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

Returns:

liste de noms de regions

getRemoteRuleNames

public static List<String> getRemoteRuleNames()

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

Returns:

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

getNewRemoteRuleNames

public static List<String> getNewRemoteRuleNames()

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

Returns:

liste de noms de regions

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

Overrides:

getDescription in class JavaSourceStorage

Returns:

the descript of the instanciate Rule

See Also:

Doc, Docable