First commit for all classes that require implementation for streaming.

	* TODO: implement OAuthStream and StreamCommand.

3 files changed, 67 insertions, 4 deletions

diff --git a/src/mining/OAuthStream.java b/src/mining/OAuthStream.java
new file mode 100644
index 0000000..3cddb57
--- /dev/null
+++ b/src/mining/OAuthStream.java
@@ -0,0 +1,26 @@
+
+package mining;
+
+/**
+ * An implementation of a Stream using the OAuthentication method.
+ * @author Maurice Laveaux
+ */
+public class OAuthStream implements Stream {
+
+    @Override
+    public void open() {
+        
+    }
+
+    @Override
+    public void setListener(StreamListener listener) {
+        
+    }
+
+    @Override
+    public boolean isValid() {
+        
+        return false;
+    }
+    
+}
diff --git a/src/mining/Stream.java b/src/mining/Stream.java
index c9c08f0..283b4ea 100644
--- a/src/mining/Stream.java
+++ b/src/mining/Stream.java
@@ -1,9 +1,28 @@
-
 package mining;
 
 /**
- * This miner obtains data by receiving a stream from twitter.
+ * interface for all streaming classes.
+ *
+ * @author Maurice Laveaux
  */
-public class Stream {
-    
+public interface Stream {
+
+    /**
+     * Open the connection to the server.
+     */
+    public void open();
+
+    /**
+     * Set a single listener for this stream.
+     *
+     * @param listener The object that is listening.
+     */
+    public void setListener(StreamListener listener);
+
+    /**
+     * Test whether the stream is ready for streaming
+     *
+     * @return true if connection can be made, false otherwise.
+     */
+    public boolean isValid();
 }
diff --git a/src/mining/StreamListener.java b/src/mining/StreamListener.java
new file mode 100644
index 0000000..3b163eb
--- /dev/null
+++ b/src/mining/StreamListener.java
@@ -0,0 +1,18 @@
+package mining;
+
+import org.json.JSONObject;
+
+/**
+ * A callback provider to listen from streams.
+ *
+ * @author Maurice Laveaux
+ */
+public interface StreamListener {
+
+    /**
+     * This method is called by the stream when new objects are streamed in.
+     *
+     * @param data The JSON data returned.
+     */
+    public void notify(JSONObject data);
+}