From 73c71aeef8dc647d407146bc8e6b57ba7c57ac42 Mon Sep 17 00:00:00 2001
From: phil3k <philip.limbeck@gmail.com>
Date: Sun, 22 Oct 2017 19:13:47 +0200
Subject: [PATCH] some more documentation

---
 src/main/java/at/datasciencelabs/EsperSelectFunction.java | 7 +++++++
 src/main/java/at/datasciencelabs/EsperStream.java         | 2 +-
 .../at/datasciencelabs/SelectEsperStreamOperator.java     | 8 ++++----
 3 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/src/main/java/at/datasciencelabs/EsperSelectFunction.java b/src/main/java/at/datasciencelabs/EsperSelectFunction.java
index 8845d0c..ffafff9 100644
--- a/src/main/java/at/datasciencelabs/EsperSelectFunction.java
+++ b/src/main/java/at/datasciencelabs/EsperSelectFunction.java
@@ -10,5 +10,12 @@
  * @param <OUT> Type of the output DataStream
  */
 public interface EsperSelectFunction<OUT> extends Function, Serializable {
+
+    /**
+     * Select by transforming an {@link EventBean} to an instance of the OUT type.
+     * @param eventBean Result event of an esper pattern
+     * @return The transformed instance
+     * @throws Exception If there is an error in the transformation.
+     */
     OUT select(EventBean eventBean) throws Exception;
 }
diff --git a/src/main/java/at/datasciencelabs/EsperStream.java b/src/main/java/at/datasciencelabs/EsperStream.java
index 76c79e9..dccdefa 100644
--- a/src/main/java/at/datasciencelabs/EsperStream.java
+++ b/src/main/java/at/datasciencelabs/EsperStream.java
@@ -37,7 +37,7 @@ public <R> SingleOutputStreamOperator<R> select(EsperSelectFunction<R> esperSele
 
         SingleOutputStreamOperator<R> patternStream;
 
-        // TODO until the typeextractor is capable of extracing non-generic parameters, the return type has to be passed in manually
+        // TODO until the type extractor is capable of extracting non-generic parameters, the return type has to be passed in manually
 
         final boolean isProcessingTime = inputStream.getExecutionEnvironment().getStreamTimeCharacteristic() == TimeCharacteristic.ProcessingTime;
         patternStream = inputStream.keyBy(keySelector).transform("SelectEsperOperator", dataStreamReturnType, new SelectEsperStreamOperator<Byte, IN, R>(inputStream.getType(), esperSelectFunction, isProcessingTime, esperQuery));
diff --git a/src/main/java/at/datasciencelabs/SelectEsperStreamOperator.java b/src/main/java/at/datasciencelabs/SelectEsperStreamOperator.java
index 2630497..92121dd 100644
--- a/src/main/java/at/datasciencelabs/SelectEsperStreamOperator.java
+++ b/src/main/java/at/datasciencelabs/SelectEsperStreamOperator.java
@@ -30,10 +30,10 @@ public class SelectEsperStreamOperator<KEY, IN, OUT> extends AbstractUdfStreamOp
     /**
      * Constructs a new operator. Requires the type of the input DataStream to register its Event Type at Esper.
      * Currently only processing time evaluation is supported.
-     * @param inputStreamType
-     * @param esperSelectFunction
-     * @param isProcessingTime
-     * @param esperQuery
+     * @param inputStreamType type of the input DataStream
+     * @param esperSelectFunction function to select from Esper's output
+     * @param isProcessingTime Flag indicating how time is interpreted (processing time vs event time)
+     * @param esperQuery The esper query
      */
     public SelectEsperStreamOperator(TypeInformation<IN> inputStreamType, EsperSelectFunction<OUT> esperSelectFunction, boolean isProcessingTime, String esperQuery) {
         super(esperSelectFunction);