Author: heiko.braun(a)jboss.com Date: 2008-07-03 16:29:27 -0400 (Thu, 03 Jul 2008) New Revision: 112 Modified: sam/trunk/SAM.iws sam/trunk/src/main/java/org/jboss/sam/simulation/EventSimulation.java sam/trunk/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java Log: Update EventSimulation javadoc Modified: sam/trunk/SAM.iws =================================================================== --- sam/trunk/SAM.iws 2008-07-03 20:09:31 UTC (rev 111) +++ sam/trunk/SAM.iws 2008-07-03 20:29:27 UTC (rev 112) @@ -17,28 +17,9 @@ </component> <component name="ChangeListManager"> <list default="true" name="Default" comment=""> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/EventSourceEntity.java" afterPath="" /> - <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/EventSink.java" afterPath="" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/resources/sim" afterPath="" /> - <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/main/java/org/jboss/sam/internal/stream/InVMDispatcher.java" afterPath="$PROJECT_DIR$/src/main/java/org/jboss/sam/internal/stream/InVMDispatcher.java" /> - <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/ChartGenerationHandler.java" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim/EventSourceEntity.java" afterPath="" /> - <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/src/test/resources/simulation" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim" afterPath="" /> - <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/main/java/org/jboss/sam/StreamInput.java" afterPath="$PROJECT_DIR$/src/main/java/org/jboss/sam/StreamInput.java" /> - <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SensorEventMessage.java" afterPath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SensorEventMessage.java" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim/SensorEventMessage.java" afterPath="" /> <change type="MODIFICATION" beforePath="$PROJECT_DIR$/SAM.iws" afterPath="$PROJECT_DIR$/SAM.iws" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim/EventSink.java" afterPath="" /> - <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/test/resources/simulation/esper-cfg.xml" afterPath="$PROJECT_DIR$/src/test/resources/simulation/esper-cfg.xml" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/EventProcessorEntity.java" afterPath="" /> - <change type="MODIFICATION" beforePath="$PROJECT_DIR$/sam-trunk.iml" afterPath="$PROJECT_DIR$/sam-trunk.iml" /> - <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SensorMessageFactory.java" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim/EventProcessorEntity.java" afterPath="" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/resources/sim/esper-cfg.xml" afterPath="" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/sim/SimulationMain.java" afterPath="" /> - <change type="DELETED" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java" afterPath="" /> + <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java" afterPath="$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java" /> + <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/EventSimulation.java" afterPath="$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/EventSimulation.java" /> </list> </component> <component name="ChangeListSynchronizer" /> @@ -180,10 +161,21 @@ </component> <component name="FileEditorManager"> <leaf> - <file leaf-file-name="SimulationMain.java" pinned="false" current="true" current-in-tab="true"> + <file leaf-file-name="EventSimulation.java" pinned="false" current="true" current-in-tab="true"> + <entry file="file://$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/EventSimulation.java"> + <provider selected="true" editor-type-id="text-editor"> + <state line="57" column="28" selection-start="2531" selection-end="2531" vertical-scroll-proportion="0.5041322"> + <folding> + <element signature="imports" expanded="true" /> + </folding> + </state> + </provider> + </entry> + </file> + <file leaf-file-name="SimulationMain.java" pinned="false" current="false" current-in-tab="false"> <entry file="file://$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java"> <provider selected="true" editor-type-id="text-editor"> - <state line="52" column="70" selection-start="2013" selection-end="2013" vertical-scroll-proportion="0.60566705"> + <state line="42" column="61" selection-start="1521" selection-end="1576" vertical-scroll-proportion="0.38134593"> <folding /> </state> </provider> @@ -532,79 +524,7 @@ <option name="myItemId" value="SAM.ipr" /> <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" /> </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="sam-trunk" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewModuleNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java/org/jboss/sam" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java/org/jboss/sam/internal" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java/org/jboss/sam/internal/stream" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> </PATH> - <PATH> - <PATH_ELEMENT> - <option name="myItemId" value="SAM.ipr" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="sam-trunk" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewModuleNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java/org/jboss/sam" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - <PATH_ELEMENT> - <option name="myItemId" value="PsiDirectory:$PROJECT_DIR$/src/main/java/org/jboss/sam/internal" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" /> - </PATH_ELEMENT> - </PATH> - <PATH> - <PATH_ELEMENT> - <option name="myItemId" value="SAM.ipr" /> - <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" /> - </PATH_ELEMENT> - </PATH> </subPane> </component> <component name="ProjectReloadState"> @@ -1014,15 +934,6 @@ </state> </provider> </entry> - <entry file="file://$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/EventSimulation.java"> - <provider selected="true" editor-type-id="text-editor"> - <state line="70" column="58" selection-start="2819" selection-end="2819" vertical-scroll-proportion="0.2026538"> - <folding> - <element signature="imports" expanded="true" /> - </folding> - </state> - </provider> - </entry> <entry file="file://$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/Measurement.java"> <provider selected="true" editor-type-id="text-editor"> <state line="27" column="37" selection-start="1160" selection-end="1160" vertical-scroll-proportion="0.16043426"> @@ -1057,11 +968,20 @@ </entry> <entry file="file://$PROJECT_DIR$/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java"> <provider selected="true" editor-type-id="text-editor"> - <state line="52" column="70" selection-start="2013" selection-end="2013" vertical-scroll-proportion="0.60566705"> + <state line="42" column="61" selection-start="1521" selection-end="1576" vertical-scroll-proportion="0.38134593"> <folding /> </state> </provider> </entry> + <entry file="file://$PROJECT_DIR$/src/main/java/org/jboss/sam/simulation/EventSimulation.java"> + <provider selected="true" editor-type-id="text-editor"> + <state line="57" column="28" selection-start="2531" selection-end="2531" vertical-scroll-proportion="0.5041322"> + <folding> + <element signature="imports" expanded="true" /> + </folding> + </state> + </provider> + </entry> </component> </project> Modified: sam/trunk/src/main/java/org/jboss/sam/simulation/EventSimulation.java =================================================================== --- sam/trunk/src/main/java/org/jboss/sam/simulation/EventSimulation.java 2008-07-03 20:09:31 UTC (rev 111) +++ sam/trunk/src/main/java/org/jboss/sam/simulation/EventSimulation.java 2008-07-03 20:29:27 UTC (rev 112) @@ -39,6 +39,27 @@ import java.util.UUID; /** + * Simulations are created from global configuration, + * which will be available to any simulation entity and a URL to + * {@link #bootstrap(java.util.Properties, java.net.URL)} the {@link org.jboss.sam.EventProcessor}: + * <p> + * + * <b>Event sources</b><br> + * {@link org.jboss.sam.simulation.EventSourceEntity}'s drive the whole simulation by creating and dispatching + * typed event messages. They need to be added to a simulation ({@link #addSource(EventSourceEntity)}) + * in order to emit events to the event processor. + * <p> + * + * <b>Event sinks</b><br> + * {@link org.jboss.sam.simulation.EventSinkEntity}'s processes event messages that have been forwarded + * from an event processor. They need to be added ({@link #addSink(EventSinkEntity)}) to a simualtion + * and bound to a processing statement ({@link #bindStatement(String, EventSinkEntity)}) + * <p> + * + * <b>Shared context</b><br> + * The {@link org.jboss.sam.simulation.SimulationContext} is shared between all simulation + * entities and acts as a blackboard where any entity can read and write simulation data and configuration. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class EventSimulation extends SimulationProcess @@ -210,7 +231,7 @@ } } - public static EventSimulation createSimulation(Properties config, URL bootstrap) + public static EventSimulation bootstrap(Properties config, URL bootstrap) { return new EventSimulation(config, bootstrap); } Modified: sam/trunk/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java =================================================================== --- sam/trunk/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java 2008-07-03 20:09:31 UTC (rev 111) +++ sam/trunk/src/test/java/org/jboss/test/sam/simulation/SimulationMain.java 2008-07-03 20:29:27 UTC (rev 112) @@ -40,7 +40,7 @@ config.put(EventSimulation.TOTAL_SIM_TIME, 60.00); // init - EventSimulation simulation = EventSimulation.createSimulation ( + EventSimulation simulation = EventSimulation.bootstrap( config, Thread.currentThread().getContextClassLoader().getResource("simulation/esper-cfg.xml") );