fr.ifremer.isisfish.datastore

Class ResultInfoStorage

java.lang.Object

fr.ifremer.isisfish.datastore.VersionStorage

fr.ifremer.isisfish.datastore.CodeSourceStorage

fr.ifremer.isisfish.datastore.JavaSourceStorage

fr.ifremer.isisfish.datastore.ResultInfoStorage

public class ResultInfoStorage
extends JavaSourceStorage

This class define a result name.

Since:

4.4

Author:

Eric Chatellier

Nested Class Summary

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

CodeSourceStorage.Location

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESULT_INFO_PATH
static String	RESULT_INFO_TEMPLATE Template freemarker pour les noms de resultats.
protected static Map<String,ResultInfoStorage>	resultInfosCache Instance cache.
protected static Set<StorageChangeListener>	storageListeners

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

file, root

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResultInfoStorage(File rootSrc, File directory, String name) Contruit un nouveau resultInfo storage

Method Summary

Modifier and Type	Method and Description
static void	addStorageListener(StorageChangeListener storageListener)
static void	checkout()
static ResultInfoStorage	createResultInfo(String name, CodeSourceStorage.Location location) Create new result name.
static File	getCommunityResultInfoDirectory() Get community VCS resultInfo directory.
String	getDescription() Be ware this method require to instanciate a resultInfo, so it would be better to call as often as possible.
static List<String>	getNewRemoteResultInfoNames() Retourne la liste des noms de toutes les régions disponible sur le serveur VCS qui ne sont pas encore en local
static List<String>	getNewResultInfoNames() Retourne la liste des noms de toutes les resultats disponibles en local qui ne sont pas encore sur le serveur VCS
String	getPackage() Get package name where script should be declared.
static List<String>	getRemoteResultInfoNames() Retourne la liste des noms de toutes les régions disponible sur le serveur VCS
static ResultInfoStorage	getResultInfo(String name, CodeSourceStorage.Location... location) Retourne le storage pour le resultat demandé
static File	getResultInfoDirectory() Get context (official VCS) resultInfo directory.
static List<String>	getResultInfoNames() Retourne le nom de toutes les resultats existants pour cette region
static void	registerWatcher()

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

compile, doJavadoc, getCodeClass, 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, 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

Field Detail

RESULT_INFO_PATH

public static final String RESULT_INFO_PATH

See Also:

Constant Field Values

RESULT_INFO_TEMPLATE

public static final String RESULT_INFO_TEMPLATE

Template freemarker pour les noms de resultats.

See Also:

Constant Field Values

resultInfosCache

protected static Map<String,ResultInfoStorage> resultInfosCache

Instance cache.

storageListeners

protected static Set<StorageChangeListener> storageListeners

Constructor Detail

ResultInfoStorage

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

Contruit un nouveau resultInfo storage

Parameters:

rootSrc - La region auquelle est attaché le resultats

directory - le repertoire ou devrait se trouver le resultat

name - le nom du resultat

Method Detail

addStorageListener

public static void addStorageListener(StorageChangeListener storageListener)

registerWatcher

public static void registerWatcher()

getPackage

public String getPackage()

Description copied from class: JavaSourceStorage

Get package name where script should be declared.

Specified by:

getPackage in class JavaSourceStorage

Returns:

package declaration

getResultInfoDirectory

public static File getResultInfoDirectory()

Get context (official VCS) resultInfo directory.

Returns:

context resultInfo directory

getCommunityResultInfoDirectory

public static File getCommunityResultInfoDirectory()

Get community VCS resultInfo directory.

Returns:

community resultInfo directory

getResultInfoNames

public static List<String> getResultInfoNames()

Retourne le nom de toutes les resultats existants pour cette region

Returns:

all result names found in local user database

getResultInfo

public static ResultInfoStorage getResultInfo(String name,
                                              CodeSourceStorage.Location... location)

Retourne le storage pour le resultat demandé

Parameters:

name - le nom du resultat souhaité

location - location to open storage file

Returns:

Le storage pour le resultat

createResultInfo

public static ResultInfoStorage createResultInfo(String name,
                                                 CodeSourceStorage.Location location)

Create new result name.

Parameters:

name - new result name to create

location - location to result name storage file

Returns:

new rule storage

checkout

public static void checkout()
                     throws VCSException

Throws:

VCSException

getNewResultInfoNames

public static List<String> getNewResultInfoNames()

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

Returns:

liste de noms de resultats

getRemoteResultInfoNames

public static List<String> getRemoteResultInfoNames()

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.

getNewRemoteResultInfoNames

public static List<String> getNewRemoteResultInfoNames()

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 resultInfo, so it would be better to call as often as possible.

Overrides:

getDescription in class JavaSourceStorage

Returns:

the description of the instanciate Rule

See Also:

Doc