fr.ifremer.isisfish.datastore

Class ResultMappedStorage

java.lang.Object

fr.ifremer.isisfish.datastore.ResultMappedStorage

All Implemented Interfaces:

ResultStorage, SimulationListener, SimulationResultGetter, SimulationResultListener

public class ResultMappedStorage
extends Object
implements SimulationResultListener, SimulationResultGetter, ResultStorage

Cette classe permet de conserver des résultats de simulation. Elle permet ensuite de les récupérer. Created: 31 aout 2012

Version:

$Revision: 3798 $ Mise a jour: $Date: 2012-10-30 11:39:32 +0100 (Tue, 30 Oct 2012) $ par : $Author: echatellier $

Author:

Benjamin Poussin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ResultMappedStorage.EntitySemanticsDecorator Convertie une entite, month, timestep en string et inversement.
protected static class	ResultMappedStorage.ResultMapped Represente un resultat Lors de la construction, si on ne passe que le RandomAccessFile et l'offset, on relie un resultat si on passe toutes les infos, on ecrit le resultat.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	enabledResult result enabled
protected org.nuiton.math.matrix.MatrixFactory	matrixFactory
protected Map<String,Map<TimeStep,ResultMappedStorage.ResultMapped>>	nameStepResults
protected long	offset
protected RandomAccessFile	raf
protected SimulationStorage	simulation
protected Map<TimeStep,Map<String,ResultMappedStorage.ResultMapped>>	stepNameResults

Constructor Summary

Constructors

Constructor and Description
ResultMappedStorage(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)
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
void	close() Close result storage.
void	delete() Delete all result for this result storage.
protected void	doAddResult(TimeStep step, String name, org.nuiton.math.matrix.MatrixND mat)
protected void	finalize()
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, Population pop, String name, org.nuiton.topia.TopiaContext tx) 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 une matrice contenant tous les pas de temps.
protected Map<TimeStep,ResultMappedStorage.ResultMapped>	getResult(String name)
protected Map<TimeStep,ResultMappedStorage.ResultMapped>	getResult(String name, Population pop)
protected Map<String,ResultMappedStorage.ResultMapped>	getResult(TimeStep step)
protected ResultMappedStorage.ResultMapped	getResult(TimeStep step, String name)
protected ResultMappedStorage.ResultMapped	getResult(TimeStep step, String name, Population pop)
List<String>	getResultName() Retourne la liste de tous les résultats.
protected org.nuiton.topia.TopiaContext	getTx(org.nuiton.topia.TopiaContext tx) Try to find better tx.
boolean	isEnabled(String name) Permet de savoir si lorsque l'on ajoutera ce resultat, il sera sauvé ou non.
protected void	storeResult(ResultMappedStorage.ResultMapped r) Methode interne pour que les deux Map soit mise a jour en meme temps C'est la seul methode qui permet d'ajouter des noms de result dans les Map

Methods inherited from class java.lang.Object

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

Field Detail

matrixFactory

protected org.nuiton.math.matrix.MatrixFactory matrixFactory

simulation

protected SimulationStorage simulation

raf

protected RandomAccessFile raf

offset

protected long offset

stepNameResults

protected Map<TimeStep,Map<String,ResultMappedStorage.ResultMapped>> stepNameResults

nameStepResults

protected Map<String,Map<TimeStep,ResultMappedStorage.ResultMapped>> nameStepResults

enabledResult

protected transient Set<String> enabledResult

result enabled

Constructor Detail

ResultMappedStorage

public ResultMappedStorage(SimulationStorage simulation)
                    throws IOException

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

Parameters:

simulation - storage to get result

Throws:

IOException

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

delete

public void delete()

Description copied from interface: ResultStorage

Delete all result for this result storage. In case of sensitivity analysis, after export, result are no longer needed and can be deleted to save disk space.

Specified by:

delete in interface ResultStorage

close

public void close()

Description copied from interface: ResultStorage

Close result storage.

Specified by:

close in interface ResultStorage

storeResult

protected void storeResult(ResultMappedStorage.ResultMapped r)

Methode interne pour que les deux Map soit mise a jour en meme temps C'est la seul methode qui permet d'ajouter des noms de result dans les Map

Parameters:

r -

getResult

protected Map<String,ResultMappedStorage.ResultMapped> getResult(TimeStep step)

getResult

protected ResultMappedStorage.ResultMapped getResult(TimeStep step,
                                         String name)

getResult

protected ResultMappedStorage.ResultMapped getResult(TimeStep step,
                                         String name,
                                         Population pop)

getResult

protected Map<TimeStep,ResultMappedStorage.ResultMapped> getResult(String name,
                                                       Population pop)

getResult

protected Map<TimeStep,ResultMappedStorage.ResultMapped> getResult(String name)

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

isEnabled

public boolean isEnabled(String name)

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

addActiveRule

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

Specified by:

addActiveRule in interface ResultStorage

Throws:

IsisFishException

getResultName

public List<String> getResultName()

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)

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,
                                        Population pop,
                                        String name,
                                        org.nuiton.topia.TopiaContext tx)

Retourne la matrice stocke pour un pas de temps

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)

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.

step - le pas de temps que l'on souhaite

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)

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)

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)

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()

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.

getTx

protected org.nuiton.topia.TopiaContext getTx(org.nuiton.topia.TopiaContext tx)

Try to find better tx. If argument is not null, return it. otherwize try to get tx in SimulationContext.

Parameters:

tx -

Returns:

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