Author: chatellier Date: 2009-02-23 10:30:42 +0000 (Mon, 23 Feb 2009) New Revision: 1860 Added: isis-fish/trunk/src/main/resources/templates/ isis-fish/trunk/src/main/resources/templates/analyseplan.ftl isis-fish/trunk/src/main/resources/templates/equation.ftl isis-fish/trunk/src/main/resources/templates/export.ftl isis-fish/trunk/src/main/resources/templates/rule.ftl isis-fish/trunk/src/main/resources/templates/script.ftl isis-fish/trunk/src/main/resources/templates/simulator.ftl Log: Begin to externalize script, analyseplan... code in ftl template. (not used for now) Added: isis-fish/trunk/src/main/resources/templates/analyseplan.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/analyseplan.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/analyseplan.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,81 @@ +package analyseplans; + +import static org.codelutin.i18n.I18n._; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import scripts.ResultName; + +import java.io.Writer; +import org.codelutin.math.matrix.*; +import org.codelutin.util.*; +import org.codelutin.topia.*; + +import fr.ifremer.isisfish.util.Doc; +import fr.ifremer.isisfish.*; +import fr.ifremer.isisfish.simulator.SimulationContext; +import fr.ifremer.isisfish.types.Date; +import fr.ifremer.isisfish.entities.*; +import fr.ifremer.isisfish.simulator.AnalysePlan; +import fr.ifremer.isisfish.simulator.AnalysePlanContext; +import fr.ifremer.isisfish.simulator.SimulationParameter; +import fr.ifremer.isisfish.datastore.SimulationStorage; +import fr.ifremer.isisfish.datastore.ResultStorage; + +/** + * ${name}.java + * + * Created: ${date} + * + * @author ${author} <${email}> + * @version $Revision: 1545 $ + * Last update: $Date: 2008-10-08 16:13:44 +0200 (mer 08 oct 2008) $ + * by : $Author: ${author} $ + */ +public class ${name} implements AnalysePlan { + + /** to use log facility, just put in your code: log.info("..."); */ + private static Log log = LogFactory.getLog(${name}.class); + + public String [] necessaryResult = { + // put here all necessary result for this rule + // example: + // ResultName.MATRIX_BIOMASS, + // ResultName.MATRIX_NET_VALUE_OF_LANDINGS_PER_STRATEGY_MET, + }; + + public String[] getNecessaryResult() { + return this.necessaryResult; + } + + /** + * Permet d''afficher a l''utilisateur une aide sur le plan. + * @return L''aide ou la description du plan + */ + public String getDescription() throws Exception { + // TODO + return _("TODO description plan"); + } + + /** + * Appelé au démarrage de la simulation, cette méthode permet d''initialiser + * des valeurs + * @param simulation La simulation pour lequel on utilise cette regle + */ + public void init(AnalysePlanContext context) throws Exception { + // TODO + } + + /** + * Call before each simulation + * @param context plan context + * @param nextSimulation storage used for next simulation + * @return true if we must do next simulation, false to stop plan + * @throws Exception + */ + public boolean next(AnalysePlanContext context, SimulationStorage nextSimulation) throws Exception { + return false; + // TODO + } +} \ No newline at end of file Added: isis-fish/trunk/src/main/resources/templates/equation.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/equation.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/equation.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,12 @@ +/** + * ${name}. + * + * Created: ${date} + * + * @author ${author} <${email}> + * @version $Revision: 1545 $ + * Last update: $Date : ${date} $ + * by : $Author: ${author} $ + */ +// put your code here + Added: isis-fish/trunk/src/main/resources/templates/export.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/export.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/export.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,59 @@ +package exports; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import java.io.Writer; + +import static org.codelutin.i18n.I18n._; +import org.codelutin.math.matrix.*; +import fr.ifremer.isisfish.util.Doc; +import fr.ifremer.isisfish.entities.*; +import fr.ifremer.isisfish.export.Export; +import fr.ifremer.isisfish.datastore.SimulationStorage; +import fr.ifremer.isisfish.datastore.ResultStorage; + +/** + * ${name}.java + * + * Created: ${date} + * + * @author ${author} <${email}> + * @version $Revision: 1545 $ + * + * Last update: $Date: ${date} $ + * by : $Author: ${author} $ + */ +public class ${name} implements Export { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + private static Log log = LogFactory.getLog(${name}.class); + + public String [] necessaryResult = { + // put here all necessary result for this rule + // example: + // ResultName.MATRIX_BIOMASS, + // ResultName.MATRIX_NET_VALUE_OF_LANDINGS_PER_STRATEGY_MET, + }; + + public String[] getNecessaryResult() { + return this.necessaryResult; + } + + public String getExportFilename() { + // remove _(...) if you don''t want translation on filename + return _("${name}"); + } + + public String getExtensionFilename() { + return ".csv"; + } + + public String getDescription() { + return _("TODO export description"); + } + + public void export(SimulationStorage simulation, Writer out) throws Exception { + // put your code here, and write export with: out.write("...") + } +} \ No newline at end of file Added: isis-fish/trunk/src/main/resources/templates/rule.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/rule.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/rule.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,93 @@ +package rules; + +import static org.codelutin.i18n.I18n._; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import scripts.ResultName; + +import java.io.Writer; + +import org.codelutin.math.matrix.*; + +import fr.ifremer.isisfish.util.Doc; +import fr.ifremer.isisfish.simulator.SimulationContext; +import fr.ifremer.isisfish.types.Date; +import fr.ifremer.isisfish.entities.*; +import fr.ifremer.isisfish.rule.AbstractRule; +import fr.ifremer.isisfish.datastore.SimulationStorage; +import fr.ifremer.isisfish.datastore.ResultStorage; + +/** + * ${name}.java + * + * Created: ${date} + * + * @author ${author} <${email}> + * @version $Revision: 1545 $ + * Last update: $Date: 2008-10-08 16:13:44 +0200 (mer 08 oct 2008) $ + * by : $Author: ${author} $ + */ +public class ${name} extends AbstractRule { + + /** to use log facility, just put in your code: log.info("..."); */ + private static Log log = LogFactory.getLog(${name}.class); + + public String [] necessaryResult = { + // put here all necessary result for this rule + // example: + // ResultName.MATRIX_BIOMASS, + // ResultName.MATRIX_NET_VALUE_OF_LANDINGS_PER_STRATEGY_MET, + }; + + public String[] getNecessaryResult() { + return this.necessaryResult; + } + + /** + * Permet d'afficher a l'utilisateur une aide sur la regle. + * @return L'aide ou la description de la regle + */ + public String getDescription() throws Exception { + // TODO + return _("TODO description rule"); + } + + /** + * Appelé au démarrage de la simulation, cette méthode permet d'initialiser + * des valeurs + * @param simulation La simulation pour lequel on utilise cette regle + */ + public void init(SimulationContext context) throws Exception { + // TODO + } + + /** + * La condition qui doit etre vrai pour faire les actions + * @param simulation La simulation pour lequel on utilise cette regle + * @return vrai si on souhaite que les actions soit faites + */ + public boolean condition(SimulationContext context, Date date, Metier metier) throws Exception { + // TODO + return false; + } + + /** + * Si la condition est vrai alors cette action est executée avant le pas + * de temps de la simulation. + * @param simulation La simulation pour lequel on utilise cette regle + */ + public void preAction(SimulationContext context, Date date, Metier metier) throws Exception { + // TODO + } + + /** + * Si la condition est vrai alors cette action est executée apres le pas + * de temps de la simulation. + * @param simulation La simulation pour lequel on utilise cette regle + */ + public void postAction(SimulationContext context, Date date, Metier metier) throws Exception { + // TODO + } +} \ No newline at end of file Added: isis-fish/trunk/src/main/resources/templates/script.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/script.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/script.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,28 @@ +package scripts; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import fr.ifremer.isisfish.util.Doc; +import fr.ifremer.isisfish.entities.*; +import org.codelutin.math.matrix.*; + +/** + * ${name}.java + * + * Created: ${date} + * + * @author ${author} <$email}> + * @version $Revision: 0 $ + * + * Last update: $Date: ${date} $ + * by : $Author: ${author} $ + */ +public class ${name} { + + /** to use log facility, just put in your code: log.info("..."); */ + private static Log log = LogFactory.getLog(${name}.class); + + // add your method here + +} \ No newline at end of file Added: isis-fish/trunk/src/main/resources/templates/simulator.ftl =================================================================== --- isis-fish/trunk/src/main/resources/templates/simulator.ftl (rev 0) +++ isis-fish/trunk/src/main/resources/templates/simulator.ftl 2009-02-23 10:30:42 UTC (rev 1860) @@ -0,0 +1,32 @@ +package simulators; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import org.codelutin.math.matrix.*; + +import fr.ifremer.isisfish.util.Doc; +import fr.ifremer.isisfish.entities.*; +import fr.ifremer.isisfish.simulator.Simulator; +import fr.ifremer.isisfish.simulator.SimulationContext; + +/** + * ${name}.java + * + * Created: ${date} + * + * @author ${author} <${email}> + * @version $Revision: 1545 $ + * + * Last update $Date ${date} $ + * by : $Author: sletellier $ + */ +public class ${name} implements Simulator { + + /** to use log facility, just put in your code: log.info("..."); */ + private static Log log = LogFactory.getLog(${name}.class); + + public void simulate(SimulationContext context) throws Exception { + // put your code here + } +} \ No newline at end of file