fr.ifremer.isisfish.datastore

Class ResultDatabaseStorage

java.lang.Object

fr.ifremer.isisfish.datastore.ResultDatabaseStorage

All Implemented Interfaces:

ResultStorage, SimulationListener, SimulationResultGetter, SimulationResultListener

public class ResultDatabaseStorage
extends Object
implements SimulationResultGetter, ResultStorage

Cette classe permet de conserver des résultats de simulation. Elle permet ensuite de les récupérer. Created: 29 sept. 2004

Version:

$Revision: 3752 $ Mise a jour: $Date: 2012-08-31 18:11:36 +0200 (Fri, 31 Aug 2012) $ par : $Author: echatellier $

Author:

Benjamin Poussin

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	availableResult contains all available result as string: String(date + ':' + name)
protected org.apache.commons.collections.map.ReferenceMap	cache cache to maintains some result.
protected org.apache.commons.collections.map.ReferenceMap	cacheContext
protected Set<String>	enabledResult result enabled
protected SimulationStorage	simulation

Constructor Summary

Constructors

Constructor and Description
ResultDatabaseStorage(SimulationStorage simulation) Les ResultStorage ne doivent pas etre instancier directement, mais recuperer a partir d'un SimulationStorage.getResultStorage()

Method Summary

Methods

Modifier and Type	Method and Description
void	addActiveRule(TimeStep step, Rule rule)
protected void	addAvailableResult(TimeStep step, String name) Ajoute un resultat comme etant disponible pour une date donnée.
void	addResult(boolean force, TimeStep step, org.nuiton.math.matrix.MatrixND mat)
void	addResult(boolean force, TimeStep step, Population pop, org.nuiton.math.matrix.MatrixND mat)
void	addResult(boolean force, TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat)
void	addResult(boolean force, TimeStep step, String name, Population pop, org.nuiton.math.matrix.MatrixND mat)
void	addResult(SimulationContext context, TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat)
void	addResult(TimeStep step, org.nuiton.math.matrix.MatrixND mat)
void	addResult(TimeStep step, Population pop, org.nuiton.math.matrix.MatrixND mat)
void	addResult(TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat)
void	addResult(TimeStep step, String name, Population pop, org.nuiton.math.matrix.MatrixND mat)
void	afterSimulation(SimulationContext context) called after simulation
void	beforeSimulation(SimulationContext context) called before simulation
protected void	doAddResult(TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat)
protected void	doAddResult(TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat, org.nuiton.topia.TopiaContext tx)
protected Set<String>	getAvailableResult() Retourne le nom de tous les resultats disponibles le nom est constitué de la date et du nom du resultat.
protected org.nuiton.math.matrix.MatrixND	getInCache(String name)
protected org.nuiton.math.matrix.MatrixND	getInCache(TimeStep step, String name)
TimeStep	getLastStep() Get last simulation date.
org.nuiton.math.matrix.MatrixND	getMatrix(Population pop, String name) Retourne une matrice contenant tous les pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(Population pop, String name, org.nuiton.topia.TopiaContext tx) Retourne une matrice contenant tous les pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(SimulationContext context, String name) Retourne une matrice contenant tous les pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(SimulationContext context, TimeStep step, String name) Retourne la matrice stocke pour un pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(String name) Retourne une matrice contenant tous les pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(String name, org.nuiton.topia.TopiaContext tx) Retourne une matrice contenant tous les pas de temps.
org.nuiton.math.matrix.MatrixND	getMatrix(TimeStep step, Population pop, String name) Retourne la matrice stocke pour un pas de temps
org.nuiton.math.matrix.MatrixND	getMatrix(TimeStep step, String name)
org.nuiton.math.matrix.MatrixND	getMatrix(TimeStep step, String name, org.nuiton.topia.TopiaContext tx) Retourne la matrice stocke pour un pas de temps.
List<String>	getResultName() Retourne la liste de tous les résultats.
protected boolean	isAvailableResult(TimeStep step, String name) Verifie si un resultat est disponible pour une date donnée.
boolean	isEnabled(String name) Permet de savoir si lorsque l'on ajoutera ce resultat, il sera sauvé ou non.
protected void	putInCache(String name, org.nuiton.math.matrix.MatrixND mat, org.nuiton.topia.TopiaContext context)
protected void	putInCache(TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat, org.nuiton.topia.TopiaContext context)
protected void	removeInCache(String name) Result can be removed from cache when computed result (from multiple step) become invalidated by new step result.

Methods inherited from class java.lang.Object

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

Field Detail

simulation

protected SimulationStorage simulation

cacheContext

protected transient org.apache.commons.collections.map.ReferenceMap cacheContext

cache

protected transient org.apache.commons.collections.map.ReferenceMap cache

cache to maintains some result. key: String(date + ':' + name), value: matrix TODO: cache will be more efficient if it keep at min the number of result by year

availableResult

protected transient Set<String> availableResult

contains all available result as string: String(date + ':' + name)

enabledResult

protected transient Set<String> enabledResult

result enabled

Constructor Detail

ResultDatabaseStorage

public ResultDatabaseStorage(SimulationStorage simulation)

Les ResultStorage ne doivent pas etre instancier directement, mais recuperer a partir d'un SimulationStorage.getResultStorage()

Parameters:

simulation - storage to get result

Method Detail

putInCache

protected void putInCache(TimeStep step,
              String name,
              org.nuiton.math.matrix.MatrixND mat,
              org.nuiton.topia.TopiaContext context)

putInCache

protected void putInCache(String name,
              org.nuiton.math.matrix.MatrixND mat,
              org.nuiton.topia.TopiaContext context)

removeInCache

protected void removeInCache(String name)

Result can be removed from cache when computed result (from multiple step) become invalidated by new step result.

Parameters:

name - result name to remove

getInCache

protected org.nuiton.math.matrix.MatrixND getInCache(TimeStep step,
                                         String name)

getInCache

protected org.nuiton.math.matrix.MatrixND getInCache(String name)

getAvailableResult

protected Set<String> getAvailableResult()

Retourne le nom de tous les resultats disponibles le nom est constitué de la date et du nom du resultat.

Returns:

available results

isAvailableResult

protected boolean isAvailableResult(TimeStep step,
                        String name)

Verifie si un resultat est disponible pour une date donnée.

Parameters:

step -

name -

Returns:

true if result is available

addAvailableResult

protected void addAvailableResult(TimeStep step,
                      String name)

Ajoute un resultat comme etant disponible pour une date donnée.

Parameters:

step -

name -

isEnabled

public boolean isEnabled(String name)

Description copied from interface: ResultStorage

Permet de savoir si lorsque l'on ajoutera ce resultat, il sera sauvé ou non. Check for result name returned by :

• Export.getNecessaryResult()
• Export.getNecessaryResult()
• Rule.getNecessaryResult()
• SimulationPlan.getNecessaryResult()

Specified by:

isEnabled in interface ResultStorage

Parameters:

name - result name

Returns:

true if result is enabled

addResult

public void addResult(TimeStep step,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(TimeStep step,
             Population pop,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(boolean force,
             TimeStep step,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(boolean force,
             TimeStep step,
             Population pop,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(TimeStep step,
             String name,
             Population pop,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(TimeStep step,
             String name,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(boolean force,
             TimeStep step,
             String name,
             Population pop,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

addResult

public void addResult(boolean force,
             TimeStep step,
             String name,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface ResultStorage

Throws:

IsisFishException

doAddResult

protected void doAddResult(TimeStep step,
               String name,
               org.nuiton.math.matrix.MatrixND mat)
                    throws IsisFishException

Throws:

IsisFishException

doAddResult

protected void doAddResult(TimeStep step,
               String name,
               org.nuiton.math.matrix.MatrixND mat,
               org.nuiton.topia.TopiaContext tx)
                    throws IsisFishException

Throws:

IsisFishException

addActiveRule

public void addActiveRule(TimeStep step,
                 Rule rule)
                   throws IsisFishException

Specified by:

addActiveRule in interface ResultStorage

Throws:

IsisFishException

getResultName

public List<String> getResultName()

Description copied from interface: ResultStorage

Retourne la liste de tous les résultats. Si le résultat est categorisé par une population alors le nom de la population est automatiquement ajouté au nom du résultat.

Specified by:

getResultName in interface ResultStorage

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(TimeStep step,
                                        Population pop,
                                        String name)

Description copied from interface: ResultStorage

Retourne la matrice stocke pour un pas de temps

Specified by:

getMatrix in interface ResultStorage

Parameters:

step - le pas de temps que l'on souhaite

pop - la population pour lequelle on souhaite le resultat

name - le nom des resultats dont on veut la matrice

Returns:

La matrice demandée ou null si aucune matrice ne correspond a la demande.

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(TimeStep step,
                                        String name)

Specified by:

getMatrix in interface ResultStorage

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(TimeStep step,
                                        String name,
                                        org.nuiton.topia.TopiaContext tx)

Description copied from interface: ResultStorage

Retourne la matrice stocke pour un pas de temps.

Specified by:

getMatrix in interface ResultStorage

Parameters:

step - le pas de temps que l'on souhaite

name - le nom des resultats dont on veut la matrice

tx - TopiaContext a utiliser pour recuperer les resultats et donc les semantiques

Returns:

La matrice demandée ou null si aucune matrice ne correspond a la demande.

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(Population pop,
                                        String name)

Description copied from interface: ResultStorage

Retourne une matrice contenant tous les pas de temps.

Specified by:

getMatrix in interface ResultStorage

Parameters:

pop - la population pour lequel on souhaite la matrice

name - le nom des resultats dont on veut une matrice globale.

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(Population pop,
                                        String name,
                                        org.nuiton.topia.TopiaContext tx)

Description copied from interface: ResultStorage

Retourne une matrice contenant tous les pas de temps.

Specified by:

getMatrix in interface ResultStorage

Parameters:

pop - la population pour lequel on souhaite la matrice

name - le nom des resultats dont on veut une matrice globale.

tx - la transaction a utiliser

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(String name)

Description copied from interface: ResultStorage

Retourne une matrice contenant tous les pas de temps.

Specified by:

getMatrix in interface ResultStorage

Parameters:

name - le nom des resultats dont on veut une matrice globale.

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(String name,
                                        org.nuiton.topia.TopiaContext tx)

Description copied from interface: ResultStorage

Retourne une matrice contenant tous les pas de temps.

Specified by:

getMatrix in interface ResultStorage

Parameters:

name - le nom des resultats dont on veut une matrice globale.

tx - TopiaContext a utiliser pour recuperer les resultats et donc les semantiques

getLastStep

public TimeStep getLastStep()

Description copied from interface: ResultStorage

Get last simulation date.

Specified by:

getLastStep in interface ResultStorage

Returns:

last simulation date

addResult

public void addResult(SimulationContext context,
             TimeStep step,
             String name,
             org.nuiton.math.matrix.MatrixND mat)
               throws IsisFishException

Specified by:

addResult in interface SimulationResultListener

Throws:

IsisFishException

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(SimulationContext context,
                                        TimeStep step,
                                        String name)

Description copied from interface: SimulationResultGetter

Retourne la matrice stocke pour un pas de temps.

Specified by:

getMatrix in interface SimulationResultGetter

step - le pas de temps que l'on souhaite

name - le nom des resultats dont on veut la matrice

Returns:

La matrice demandée ou null si aucune matrice ne correspond a la demande.

getMatrix

public org.nuiton.math.matrix.MatrixND getMatrix(SimulationContext context,
                                        String name)

Description copied from interface: SimulationResultGetter

Retourne une matrice contenant tous les pas de temps.

Specified by:

getMatrix in interface SimulationResultGetter

name - le nom des resultats dont on veut une matrice globale.

afterSimulation

public void afterSimulation(SimulationContext context)

Description copied from interface: SimulationListener

called after simulation

Specified by:

afterSimulation in interface SimulationListener

beforeSimulation

public void beforeSimulation(SimulationContext context)

Description copied from interface: SimulationListener

called before simulation

Specified by:

beforeSimulation in interface SimulationListener