Make the source controls a factory

Author: JLLeitschuh

core/src/main/java/edu/wpi/grip/core/Source.java

@@ -5,7 +5,6 @@
 import java.io.IOException;
 import java.util.Optional;
 import java.util.Properties;
-import java.util.concurrent.TimeoutException;
 
 /**
  * Base class for an input into the pipeline.
@@ -46,52 +45,4 @@ public final OutputSocket[] getOutputSockets() {
      * @see #getProperties()
      */
     public abstract void createFromProperties(EventBus eventBus, Properties properties) throws IOException;
-
-    /**
-     * Starts this source.
-     * A source whose {@link #canStopAndStart()} returns true can also be stopped and started and stopped multiple times.
-     *
-     * @return The source object that created the camera
-     * @throws IOException If the source fails to be started
-     */
-    public <T extends Source> T start(EventBus eventBus) throws IOException {
-        start();
-        eventBus.register(this);
-        return (T) this;
-    }
-
-    /**
-     * Any method that overrides this method should post a {@link edu.wpi.grip.core.events.SourceStartedEvent}
-     * to the {@link EventBus} if is successfully starts.
-     * @throws IOException If the source fails to be started
-     */
-    protected abstract void start() throws IOException;
-
-    /**
-     * Stops this source.
-     * This will stop the source publishing new socket values after this method returns.
-     * A source whose {@link #canStopAndStart()} returns true can also be stopped and started and stopped multiple times.
-     *
-     * Any method that overrides this method should post a {@link edu.wpi.grip.core.events.SourceStoppedEvent}
-     * to the {@link EventBus} if is successfully stops.
-     *
-     * @return The source that was stopped
-     * @throws TimeoutException if the thread running the source fails to stop.
-     * @throws IOException If there is a problem stopping the Source
-     */
-    public void stop() throws TimeoutException, IOException { /* no op */ }
-
-    /**
-     * Used to indicate if the source is running or stopped
-     *
-     * @return true if this source is running
-     */
-    public abstract boolean isRunning();
-
-    /**
-     * Used to flag to the UI if this source should have the start/stop button displayed
-     *
-     * @return true if this source can be restarted once created
-     */
-    public abstract boolean canStopAndStart();
 }

core/src/main/java/edu/wpi/grip/core/StopStartSource.java

@@ -0,0 +1,52 @@
+package edu.wpi.grip.core;
+
+
+import com.google.common.eventbus.EventBus;
+
+import java.io.IOException;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * A Source that can be stopped and started multiple times.
+ */
+public abstract class StopStartSource extends Source {
+
+    /**
+     * Starts this source.
+     *
+     * @return The source object that created the camera
+     * @throws IOException If the source fails to be started
+     */
+    public <T extends Source> T start(EventBus eventBus) throws IOException {
+        start();
+        eventBus.register(this);
+        return (T) this;
+    }
+
+    /**
+     * Any method that overrides this method should post a {@link edu.wpi.grip.core.events.SourceStartedEvent}
+     * to the {@link EventBus} if is successfully starts.
+     * @throws IOException If the source fails to be started
+     */
+    protected abstract void start() throws IOException;
+
+    /**
+     * Stops this source.
+     * This will stop the source publishing new socket values after this method returns.
+     *
+     * Any method that overrides this method should post a {@link edu.wpi.grip.core.events.SourceStoppedEvent}
+     * to the {@link EventBus} if is successfully stops.
+     *
+     * @return The source that was stopped
+     * @throws TimeoutException if the thread running the source fails to stop.
+     * @throws IOException If there is a problem stopping the Source
+     */
+    public abstract void stop() throws TimeoutException, IOException;
+
+    /**
+     * Used to indicate if the source is running or stopped
+     *
+     * @return true if this source is running
+     */
+    public abstract boolean isRunning();
+}

core/src/main/java/edu/wpi/grip/core/sources/CameraSource.java

@@ -8,8 +8,8 @@
 import edu.wpi.grip.core.OutputSocket;
 import edu.wpi.grip.core.SocketHint;
 import edu.wpi.grip.core.SocketHints;
-import edu.wpi.grip.core.Source;
 import edu.wpi.grip.core.events.UnexpectedThrowableEvent;
+import edu.wpi.grip.core.StopStartSource;
 import edu.wpi.grip.core.events.SourceRemovedEvent;
 import edu.wpi.grip.core.events.SourceStartedEvent;
 import edu.wpi.grip.core.events.SourceStoppedEvent;
@@ -29,7 +29,7 @@
  * Provides a way to generate a constantly updated {@link Mat} from a camera
  */
 @XStreamAlias(value = "grip:Camera")
-public class CameraSource extends Source {
+public class CameraSource extends StopStartSource {
 
     private final static String DEVICE_NUMBER_PROPERTY = "deviceNumber";
     private final static String ADDRESS_PROPERTY = "address";
@@ -227,11 +227,6 @@ public boolean isRunning() {
         }
     }
 
-    @Override
-    public boolean canStopAndStart() {
-        return true;
-    }
-
     @Subscribe
     public void onSourceRemovedEvent(SourceRemovedEvent event) throws TimeoutException {
         if (event.getSource() == this) {

core/src/main/java/edu/wpi/grip/core/sources/ImageFileSource.java

@@ -33,7 +33,6 @@ public class ImageFileSource extends Source {
     private final SocketHint<Mat> imageOutputHint = SocketHints.Inputs.createMatSocketHint("Image", true);
     private OutputSocket<Mat> outputSocket;
     private EventBus eventBus;
-    private boolean started = false;
 
     /**
      * @param eventBus The event bus for the pipeline.
@@ -84,20 +83,6 @@ public void createFromProperties(EventBus eventBus, Properties properties) throw
         this.initialize(eventBus, path);
     }
 
-    protected void start() throws IOException {
-        this.started = true;
-        loadImage(this.path);
-    }
-
-    @Override
-    public boolean isRunning() {
-        return this.started;
-    }
-
-    @Override
-    public boolean canStopAndStart() {
-        return false;
-    }
 
     /**
      * Loads the image and posts an update to the {@link EventBus}

core/src/test/java/edu/wpi/grip/core/sources/ImageFileSourceTest.java

@@ -32,7 +32,7 @@ public void setUp() throws URISyntaxException {
     public void testLoadImageToMat() throws IOException {
         // Given above setup
         // When
-        final ImageFileSource fileSource = new ImageFileSource(eventBus, this.imageFile).start(eventBus);
+        final ImageFileSource fileSource = new ImageFileSource(eventBus, this.imageFile);
         OutputSocket<Mat> outputSocket = fileSource.getOutputSockets()[0];
 
         // Then
@@ -45,7 +45,7 @@ public void testLoadImageToMat() throws IOException {
 
     @Test(expected = IOException.class)
     public void testReadInTextFile() throws IOException {
-        final ImageFileSource fileSource = new ImageFileSource(eventBus, this.textFile).start(eventBus);
+        final ImageFileSource fileSource = new ImageFileSource(eventBus, this.textFile);
         OutputSocket<Mat> outputSocket = fileSource.getOutputSockets()[0];
         assertTrue("No matrix should have been returned.", outputSocket.getValue().get().empty());
     }
@@ -54,7 +54,7 @@ public void testReadInTextFile() throws IOException {
     public void testReadInFileWithoutExtension() throws MalformedURLException, IOException {
         final File testFile = new File("temp" + File.separator +"fdkajdl3eaf");
 
-        final ImageFileSource fileSource = new ImageFileSource(eventBus, testFile).start(eventBus);
+        final ImageFileSource fileSource = new ImageFileSource(eventBus, testFile);
         OutputSocket<Mat> outputSocket = fileSource.getOutputSockets()[0];
         assertTrue("No matrix should have been returned.", outputSocket.getValue().get().empty());
     }

ui/src/main/java/edu/wpi/grip/ui/pipeline/AddSourceView.java

@@ -58,7 +58,7 @@ public AddSourceView(EventBus eventBus) {
             // Add a new source for each image .
             imageFiles.forEach(file -> {
                 try {
-                    eventBus.post(new SourceAddedEvent(new ImageFileSource(eventBus, file).start(eventBus)));
+                    eventBus.post(new SourceAddedEvent(new ImageFileSource(eventBus, file)));
                 } catch (IOException e) {
                     eventBus.post(new UnexpectedThrowableEvent(e, "Tried to create an invalid source"));
                 }

ui/src/main/java/edu/wpi/grip/ui/pipeline/SourceView.java

@@ -1,31 +1,18 @@
 package edu.wpi.grip.ui.pipeline;
 
 import com.google.common.eventbus.EventBus;
-import com.google.common.eventbus.Subscribe;
 import edu.wpi.grip.core.OutputSocket;
 import edu.wpi.grip.core.Source;
-import edu.wpi.grip.core.events.FatalErrorEvent;
 import edu.wpi.grip.core.events.SourceRemovedEvent;
-import edu.wpi.grip.core.events.SourceStartedEvent;
-import edu.wpi.grip.core.events.SourceStoppedEvent;
-import edu.wpi.grip.ui.util.DPIUtility;
-import javafx.application.Platform;
+import edu.wpi.grip.ui.pipeline.source.SourceControlsViewFactory;
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
 import javafx.fxml.FXMLLoader;
-import javafx.scene.control.ContentDisplay;
 import javafx.scene.control.Label;
-import javafx.scene.control.ToggleButton;
-import javafx.scene.control.Tooltip;
-import javafx.scene.image.Image;
-import javafx.scene.image.ImageView;
-import javafx.scene.input.MouseEvent;
 import javafx.scene.layout.HBox;
-import javafx.scene.layout.Priority;
 import javafx.scene.layout.VBox;
 
 import java.io.IOException;
-import java.util.concurrent.TimeoutException;
 
 /**
  * A JavaFX control that represents a {@link Source}.  <code>SourceView</code>s are somewhat analogous to
@@ -34,8 +21,6 @@
  */
 public class SourceView extends VBox {
 
-    private static final Image startImage = new Image(SourceView.class.getResourceAsStream("/edu/wpi/grip/ui/icons/start.png"));
-    private static final Image stopImage = new Image(SourceView.class.getResourceAsStream("/edu/wpi/grip/ui/icons/stop.png"));
 
     @FXML
     private Label name;
@@ -44,10 +29,7 @@ public class SourceView extends VBox {
     private VBox sockets;
 
     @FXML
-    private ToggleButton startStopButton;
-
-    @FXML
-    private Tooltip startStopTooltip;
+    private HBox controls;
 
     private final EventBus eventBus;
     private final Source source;
@@ -65,41 +47,9 @@ public SourceView(EventBus eventBus, Source source) {
             throw new RuntimeException(e);
         }
 
-
         this.name.setText(source.getName());
 
-        if (!source.canStopAndStart()) startStopButton.setVisible(false);
-        else {
-            HBox.setHgrow(startStopButton, Priority.NEVER);
-            startStopButton.setContentDisplay(ContentDisplay.RIGHT);
-
-            startStopButton.addEventFilter(MouseEvent.MOUSE_RELEASED, (event) -> {
-                event.consume();
-                if (!startStopButton.isSelected()) try {
-                    source.start(eventBus);
-                    // If this fails then an SourceStartedEvent will not be posted
-                } catch (IOException e) {
-                    eventBus.post(new FatalErrorEvent(e));
-                }
-                else try {
-                    source.stop();
-                    // If this fails then an SourceStoppedEvent will not be posted
-                } catch (TimeoutException | IOException e) {
-                    eventBus.post(new FatalErrorEvent(e));
-                }
-            });
-            startStopButton.selectedProperty().addListener((o, oldV, newV) -> {
-                final String stopCameraText = "Stop Camera";
-                final String startCameraText = "Start Camera";
-                final ImageView icon = newV ? new ImageView(stopImage) : new ImageView(startImage);
-                icon.setFitHeight(DPIUtility.MINI_ICON_SIZE);
-                icon.setFitWidth(DPIUtility.MINI_ICON_SIZE);
-                startStopButton.setGraphic(icon);
-                startStopTooltip.setText(newV ? stopCameraText : startCameraText);
-                startStopButton.setAccessibleText(newV ? stopCameraText : startCameraText);
-            });
-            startStopButton.setSelected(source.isRunning());
-        }
+        controls.getChildren().add(SourceControlsViewFactory.createSourceControlsView(eventBus, source));
 
         for (OutputSocket<?> socket : source.getOutputSockets()) {
             this.sockets.getChildren().add(new OutputSocketView(eventBus, socket));
@@ -125,22 +75,4 @@ public void delete() {
         this.eventBus.post(new SourceRemovedEvent(this.getSource()));
     }
 
-
-    @Subscribe
-    public void onSourceStarted(SourceStartedEvent event) {
-        if (source == event.getSource()) {
-            Platform.runLater(() -> {
-                startStopButton.setSelected(true);
-            });
-        }
-    }
-
-    @Subscribe
-    public void onSourceStopped(SourceStoppedEvent event) {
-        if (source == event.getSource()) {
-            Platform.runLater(() -> {
-                startStopButton.setSelected(false);
-            });
-        }
-    }
 }

ui/src/main/java/edu/wpi/grip/ui/pipeline/source/SourceControlsView.java

@@ -0,0 +1,7 @@
+package edu.wpi.grip.ui.pipeline.source;
+
+import javafx.scene.layout.HBox;
+
+public abstract class SourceControlsView<T> extends HBox {
+
+}

ui/src/main/java/edu/wpi/grip/ui/pipeline/source/SourceControlsViewFactory.java

@@ -0,0 +1,17 @@
+package edu.wpi.grip.ui.pipeline.source;
+
+import com.google.common.eventbus.EventBus;
+import edu.wpi.grip.core.Source;
+import edu.wpi.grip.core.StopStartSource;
+
+public class SourceControlsViewFactory {
+    private SourceControlsViewFactory() { /* no op */ }
+
+    public static <T> SourceControlsView<T> createSourceControlsView(EventBus eventBus, Source source) {
+        if (source instanceof StopStartSource) {
+            return (SourceControlsView<T>) new StopStartSourceControlsView(eventBus, (StopStartSource) source);
+        } else {
+            return new SourceControlsView() {};
+        }
+    }
+}