Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

fr.ifremer.isisfish.datastore
Class SimulationInformation

java.lang.Object
  extended by fr.ifremer.isisfish.datastore.SimulationInformation

public class SimulationInformation
extends java.lang.Object

Cette classe permet de conserver des informations sur le deroulement d'une simulation. La plupart des informations sont automatiquement renseignees, mais l'utilisateur peut lui aussi ajouter des informations avec la methode addInformation(String).

Version:
$Revision: 2658 $ Last update: $Date: 2009-10-13 17:00:50 +0200 (mar., 13 oct. 2009) $ by : $Author: chatellier $
Author:
poussin

Field Summary
protected  java.io.File file
           
protected  java.util.Properties info
           
 
Constructor Summary
SimulationInformation(java.io.File file)
          Constructor.
 
Method Summary
 void addExportTime(java.lang.String exportName, long time)
           
 void addInformation(java.lang.String info)
          Add additional simulation information.
 void addRuleInitTime(java.lang.String ruleName, long time)
          Add rule init time.
 void addRulePostTime(java.lang.String ruleName, long time)
          Add rule post operation time.
 void addRulePreTime(java.lang.String ruleName, long time)
          Add rule pre operation time time.
protected  void addRuleTime(java.lang.String keyName, java.lang.String ruleName, long time)
          Add rule time.
 java.lang.String getException()
           
 java.util.Map<java.lang.String,java.lang.Long> getExportTime()
          Deprecated. since 3.2.0.5, use getExportTimes() instead
 long getExportTime(java.lang.String exportName)
           
protected  java.util.Map<java.lang.String,java.lang.Long> getExportTimes()
          Get all export time in map.
 java.lang.String getInfomation()
          Deprecated. since 3.2.0.5, use getInformation() instead
protected  java.lang.String getInformation()
          Get other information.
 java.lang.String getOptimizationUsage()
           
 long getRuleInitTime(java.lang.String ruleName)
          Get rule init operation time.
protected  java.util.Set<java.lang.String> getRuleNames()
          Get rules names.
 long getRulePostTime(java.lang.String ruleName)
          Get rule post operation time.
 long getRulePreTime(java.lang.String ruleName)
          Get rule pre operation time.
protected  long getRuleTime(java.lang.String prefixName, java.lang.String ruleName)
          Get rule operation time.
 java.util.Date getSimulationEnd()
          Get the date of simulation start.
 java.util.Date getSimulationStart()
          Get the date of simulation start.
 java.lang.String getStatistic()
           
 boolean hasError()
          Return true if an exception has been set.
 void setException(java.lang.Throwable eee)
           
protected  void setInfo(java.lang.String key, java.lang.String value)
           
 void setOptimizationUsage(java.lang.String v)
           
 void setSimulationEnd(java.util.Date date)
           
 void setSimulationStart(java.util.Date date)
           
 void setStatistic(java.lang.String v)
           
protected  void store()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

info

protected java.util.Properties info

file

protected java.io.File file
Constructor Detail

SimulationInformation

public SimulationInformation(java.io.File file)
Constructor. If file already exists, load his content into current instance.

Parameters:
file - simulation information output file
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

store

protected void store()

setInfo

protected void setInfo(java.lang.String key,
                       java.lang.String value)

getSimulationStart

public java.util.Date getSimulationStart()
Get the date of simulation start.

Returns:
simulation start date

setSimulationStart

public void setSimulationStart(java.util.Date date)

getSimulationEnd

public java.util.Date getSimulationEnd()
Get the date of simulation start.

Returns:
simulation end date

setSimulationEnd

public void setSimulationEnd(java.util.Date date)

addExportTime

public void addExportTime(java.lang.String exportName,
                          long time)

getExportTimes

protected java.util.Map<java.lang.String,java.lang.Long> getExportTimes()
Get all export time in map.

Returns:
a map with all export time

getExportTime

public java.util.Map<java.lang.String,java.lang.Long> getExportTime()
Deprecated. since 3.2.0.5, use getExportTimes() instead

Get all export time in map.

Returns:
a map with all export time

getExportTime

public long getExportTime(java.lang.String exportName)

addRuleTime

protected void addRuleTime(java.lang.String keyName,
                           java.lang.String ruleName,
                           long time)
Add rule time. If a time already exists for ruleName, add time to previous time. (usefull because pre/post action are called multiples time)

Parameters:
keyName - (ie RULE_TIME_INIT, RULE_TIME_PRE, RULE_TIME_POST)
ruleName - rule name
time - time to add
Since:
3.2.0.5

addRuleInitTime

public void addRuleInitTime(java.lang.String ruleName,
                            long time)
Add rule init time. If a time already exists for ruleName, add time to previous time.

Parameters:
ruleName - rule name
time - time to add
Since:
3.2.0.5

addRulePreTime

public void addRulePreTime(java.lang.String ruleName,
                           long time)
Add rule pre operation time time. If a time already exists for ruleName, add time to previous time.

Parameters:
ruleName - rule name
time - time to add
Since:
3.2.0.5

addRulePostTime

public void addRulePostTime(java.lang.String ruleName,
                            long time)
Add rule post operation time. If a time already exists for ruleName, add time to previous time.

Parameters:
ruleName - rule name
time - time to add
Since:
3.2.0.5

getRuleInitTime

public long getRuleInitTime(java.lang.String ruleName)
Get rule init operation time.

Parameters:
ruleName - rule name
Returns:
time
Since:
3.2.0.5

getRulePreTime

public long getRulePreTime(java.lang.String ruleName)
Get rule pre operation time.

Parameters:
ruleName - rule name
Returns:
time
Since:
3.2.0.5

getRulePostTime

public long getRulePostTime(java.lang.String ruleName)
Get rule post operation time.

Parameters:
ruleName - rule name
Returns:
time
Since:
3.2.0.5

getRuleTime

protected long getRuleTime(java.lang.String prefixName,
                           java.lang.String ruleName)
Get rule operation time.

Parameters:
ruleName - rule name
Since:
3.2.0.5

getRuleNames

protected java.util.Set<java.lang.String> getRuleNames()
Get rules names.

Returns:
a map with all export time

getStatistic

public java.lang.String getStatistic()

setStatistic

public void setStatistic(java.lang.String v)

getOptimizationUsage

public java.lang.String getOptimizationUsage()

setOptimizationUsage

public void setOptimizationUsage(java.lang.String v)

getException

public java.lang.String getException()

setException

public void setException(java.lang.Throwable eee)

hasError

public boolean hasError()
Return true if an exception has been set.

Returns:
true if there is an exception

getInfomation

public java.lang.String getInfomation()
Deprecated. since 3.2.0.5, use getInformation() instead

Returns:
other information

getInformation

protected java.lang.String getInformation()
Get other information.

Returns:
other information

addInformation

public void addInformation(java.lang.String info)
Add additional simulation information.

Parameters:
info - new info
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2010 CodeLutin. All Rights Reserved.