Added meta information for input and output ports
diff --git a/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApacheLogInputGenerator.java b/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApacheLogInputGenerator.java
index 255f241..a6791f5 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApacheLogInputGenerator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApacheLogInputGenerator.java
@@ -27,7 +27,7 @@
import org.slf4j.LoggerFactory;
/**
- * An implementation of input operator activation listener that simulates the apache logs.
+ * An implementation of input operator and activation listener that simulates the apache logs.
* <p>
* @displayName: Apache Log Input Generator
* @category: db
@@ -342,7 +342,10 @@
{
this.refererFile = refererFile;
}
-
+
+ /**
+ * Output port that emits a string into DAG.
+ */
public final transient DefaultOutputPort<String> output = new DefaultOutputPort<String>();
private static final Logger LOG = LoggerFactory.getLogger(ApacheLogInputGenerator.class);
}
diff --git a/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApplicationLogGenerator.java b/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApplicationLogGenerator.java
index e66aa9d..91aa484 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApplicationLogGenerator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/apachelog/ApplicationLogGenerator.java
@@ -24,7 +24,7 @@
import org.apache.hadoop.conf.Configuration;
/**
- * An implementation of Streaming Application that generates apache log file on the fly and dumps the parsed data to output.
+ * An implementation of Streaming Application that generates apache log file on the fly and dumps the parsed data to output.
*
* <p>
* @displayName: Application Log Generator
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseAppendOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseAppendOutputOperator.java
index 1f338af..d5901fa 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseAppendOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseAppendOutputOperator.java
@@ -25,7 +25,7 @@
import com.datatorrent.lib.db.AbstractStoreOutputOperator;
/**
- * A base implementation of an output operator that stores tuples in HBase columns and offers non-transactional append. Subclasses should provide implementation for appending operations. <br>
+ * A base implementation of a StoreOutputOperator operator that stores tuples in HBase columns and offers non-transactional append. Subclasses should provide implementation for appending operations. <br>
* <p>
* <br>
* This class provides a HBase output operator that can be used to store tuples
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseNonTransactionalPutOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseNonTransactionalPutOutputOperator.java
index c1e2805..5db144f 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseNonTransactionalPutOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseNonTransactionalPutOutputOperator.java
@@ -1,6 +1,6 @@
package com.datatorrent.contrib.hbase;
/**
- * @displayName: Abstract HBase NonTransactional Put Output
+ * @displayName: Abstract HBase NonTransactional Put Output
* @category: store
* @tag: output operator, put
* @deprecated
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBasePutOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBasePutOutputOperator.java
index 33d7851..10464c0 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBasePutOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBasePutOutputOperator.java
@@ -27,7 +27,7 @@
import com.datatorrent.lib.db.AbstractStoreOutputOperator;
/**
- * A base implementation of an output operator that stores tuples in HBase rows and offers non-transactional put.Subclasses should provide implementation for put operation. <br>
+ * A base implementation of a StoreOutputOperator operator that stores tuples in HBase rows and offers non-transactional put.Subclasses should provide implementation for put operation. <br>
* <p>
* <br>
* This class provides a HBase output operator that can be used to store tuples
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowAppendOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowAppendOutputOperator.java
index 3cca161..02bc604 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowAppendOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowAppendOutputOperator.java
@@ -33,7 +33,7 @@
import com.datatorrent.lib.db.AbstractAggregateTransactionableStoreOutputOperator;
/**
- * A base implementation of an output operator that stores tuples in HBase columns and provides batch append. Subclasses should provide implementation for appending operations. <br>
+ * A base implementation of an AggregateTransactionableStoreOutputOperator operator that stores tuples in HBase columns and provides batch append. Subclasses should provide implementation for appending operations. <br>
* <p>
* <br>
* This class provides a HBase output operator that can be used to store tuples
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowPutOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowPutOutputOperator.java
index 204204b..8be5df0 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowPutOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/AbstractHBaseWindowPutOutputOperator.java
@@ -34,7 +34,7 @@
import com.datatorrent.lib.db.AbstractAggregateTransactionableStoreOutputOperator;
/**
- * A base implementation of an output operator for storing tuples in HBase rows and provides a batch put.Subclasses should provide implementation for put operation. <br>
+ * A base implementation of an AggregateTransactionableStoreOutputOperator operator for storing tuples in HBase rows and provides a batch put.Subclasses should provide implementation for put operation. <br>
* <p>
* <br>
* This class provides a HBase output operator that can be used to store tuples
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseInputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseInputOperator.java
index 0bf8847..c44e4e7 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseInputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseInputOperator.java
@@ -33,7 +33,9 @@
*/
public abstract class HBaseInputOperator<T> extends HBaseOperatorBase implements InputOperator
{
-
+ /**
+ * Output port that emits tuples into the DAG.
+ */
@OutputPortFieldAnnotation(name = "outputPort")
public final transient DefaultOutputPort<T> outputPort = new DefaultOutputPort<T>();
diff --git a/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseOutputOperator.java
index c096e14..e41a42e 100644
--- a/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseOutputOperator.java
+++ b/contrib/src/main/java/com/datatorrent/contrib/hbase/HBaseOutputOperator.java
@@ -67,7 +67,10 @@
private transient long currentWindow;
private transient HBaseStatePersistenceStrategy persistenceStrategy;
-
+
+ /**
+ * Input port that takes tuples from the DAG.
+ */
@InputPortFieldAnnotation(name="inputPort")
public final transient DefaultInputPort<T> inputPort = new DefaultInputPort<T>() {
diff --git a/library/src/main/java/com/datatorrent/lib/math/Average.java b/library/src/main/java/com/datatorrent/lib/math/Average.java
index 8631b11..ca060be 100644
--- a/library/src/main/java/com/datatorrent/lib/math/Average.java
+++ b/library/src/main/java/com/datatorrent/lib/math/Average.java
@@ -44,7 +44,7 @@
public class Average<V extends Number> extends BaseNumberValueOperator<V>
{
/**
- * Input port that takes a number and computes sum and count for each tuple.
+ * Input port that takes a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<V> data = new DefaultInputPort<V>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/AverageKeyVal.java b/library/src/main/java/com/datatorrent/lib/math/AverageKeyVal.java
index 21f9af7..37f9dc7 100644
--- a/library/src/main/java/com/datatorrent/lib/math/AverageKeyVal.java
+++ b/library/src/main/java/com/datatorrent/lib/math/AverageKeyVal.java
@@ -62,7 +62,7 @@
protected HashMap<K, MutableLong> counts = new HashMap<K, MutableLong>();
/**
- * Input port that takes a key value pair. It adds the value for each key and counts the number of occurrences of each key to compute the average.
+ * Input port that takes a key value pair.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<KeyValPair<K, ? extends Number>> data = new DefaultInputPort<KeyValPair<K, ? extends Number>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/AverageMap.java b/library/src/main/java/com/datatorrent/lib/math/AverageMap.java
index cc7e1f3..eae2fcb 100644
--- a/library/src/main/java/com/datatorrent/lib/math/AverageMap.java
+++ b/library/src/main/java/com/datatorrent/lib/math/AverageMap.java
@@ -60,7 +60,7 @@
protected HashMap<K, MutableLong> counts = new HashMap<K, MutableLong>();
/**
- * Input port that takes a map. It adds the values for each key and counts the number of occurrences of each key to computes the average.
+ * Input data port that takes a map of <key,value>.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Map<K, V>> data = new DefaultInputPort<Map<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/Change.java b/library/src/main/java/com/datatorrent/lib/math/Change.java
index b3cb588..ef471e6 100644
--- a/library/src/main/java/com/datatorrent/lib/math/Change.java
+++ b/library/src/main/java/com/datatorrent/lib/math/Change.java
@@ -59,7 +59,7 @@
public class Change<V extends Number> extends BaseNumberValueOperator<V>
{
/**
- * Input port that takes a number, processes and computes percentage change with base value and emits it.
+ * Input data port that takes a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<V> data = new DefaultInputPort<V>()
@@ -79,7 +79,7 @@
};
/**
- * Input port that takes a number; It stores the value for base comparison.
+ * Input port that takes a number It stores the value for base comparison.
*/
@InputPortFieldAnnotation(name = "base")
public final transient DefaultInputPort<V> base = new DefaultInputPort<V>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java b/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java
index 13d5bb2..64ce78e 100644
--- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java
+++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java
@@ -53,7 +53,7 @@
public class ChangeAlert<V extends Number> extends BaseNumberValueOperator<V>
{
/**
- * Input port that takes in a number and computes percentage change with base value and emits it.
+ * Input port that takes in a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<V> data = new DefaultInputPort<V>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java
index 3c68a90..c09c5b8 100644
--- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java
+++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java
@@ -61,7 +61,7 @@
private HashMap<K, MutableDouble> basemap = new HashMap<K, MutableDouble>();
/**
- * Input port that takes a key value pair and computes percentage change with base value and emits it.
+ * Input data port that takes a key value pair.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<KeyValPair<K, V>> data = new DefaultInputPort<KeyValPair<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java
index e15a94c..d4f14e4 100644
--- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java
+++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java
@@ -52,7 +52,7 @@
public class ChangeAlertMap<K, V extends Number> extends BaseNumberKeyValueOperator<K, V>
{
/**
- * Input port that takes a map and computes percentage change with base value and emits it.
+ * Input data port that takes a map of <key,value>.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Map<K, V>> data = new DefaultInputPort<Map<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/ChangeKeyVal.java b/library/src/main/java/com/datatorrent/lib/math/ChangeKeyVal.java
index d830b7a..d785eb2 100644
--- a/library/src/main/java/com/datatorrent/lib/math/ChangeKeyVal.java
+++ b/library/src/main/java/com/datatorrent/lib/math/ChangeKeyVal.java
@@ -61,7 +61,7 @@
private HashMap<K, MutableDouble> basemap = new HashMap<K, MutableDouble>();
/**
- * Input port that takes key value pairs and computes percentage change and emits it.
+ * Input data port that takes key value pairs.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<KeyValPair<K, V>> data = new DefaultInputPort<KeyValPair<K, V>>()
@@ -87,7 +87,7 @@
};
/**
- * Base value port, stored in base map for comparison.
+ * Base value input port, stored in base map for comparison.
*/
@InputPortFieldAnnotation(name = "base")
public final transient DefaultInputPort<KeyValPair<K, V>> base = new DefaultInputPort<KeyValPair<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/ChangeMap.java b/library/src/main/java/com/datatorrent/lib/math/ChangeMap.java
index edca6f7..6687d3b 100644
--- a/library/src/main/java/com/datatorrent/lib/math/ChangeMap.java
+++ b/library/src/main/java/com/datatorrent/lib/math/ChangeMap.java
@@ -62,7 +62,7 @@
private HashMap<K, MutableDouble> basemap = new HashMap<K, MutableDouble>();
/**
- * Input port that takes in a map and computes percentage change with base value and emits it.
+ * Input data port that takes in a map of <key,value>.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Map<K, V>> data = new DefaultInputPort<Map<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/CountKeyVal.java b/library/src/main/java/com/datatorrent/lib/math/CountKeyVal.java
index 1ac1f30..7ec9ced 100644
--- a/library/src/main/java/com/datatorrent/lib/math/CountKeyVal.java
+++ b/library/src/main/java/com/datatorrent/lib/math/CountKeyVal.java
@@ -54,7 +54,7 @@
protected HashMap<K, MutableInt> counts = new HashMap<K, MutableInt>();
/**
- * Input port that takes key value pair. It adds the values for each key and counts the number of occurrence of each key.
+ * Input data port that takes key value pair.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<KeyValPair<K, V>> data = new DefaultInputPort<KeyValPair<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/CountMap.java b/library/src/main/java/com/datatorrent/lib/math/CountMap.java
index 8a43a59..e9894aa 100644
--- a/library/src/main/java/com/datatorrent/lib/math/CountMap.java
+++ b/library/src/main/java/com/datatorrent/lib/math/CountMap.java
@@ -55,7 +55,7 @@
protected HashMap<K, MutableInt> counts = new HashMap<K, MutableInt>();
/**
- * Input port that takes a map. It adds the values for each key and counts the number of occurrence of each key.
+ * Input port that takes a map of <key,value>.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Map<K, V>> data = new DefaultInputPort<Map<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/math/LogicalCompare.java b/library/src/main/java/com/datatorrent/lib/math/LogicalCompare.java
index ed25d12..bbafd1e 100644
--- a/library/src/main/java/com/datatorrent/lib/math/LogicalCompare.java
+++ b/library/src/main/java/com/datatorrent/lib/math/LogicalCompare.java
@@ -22,7 +22,7 @@
import com.datatorrent.common.util.Pair;
/**
- * This operator compares the two values in a given pair <T,T&rt; object which are of the comparable property, and emits the pair on appropriate port denoting the result of the comparison.
+ * This operator compares the two values in a given pair <T,T> object which are of the comparable property, and emits the pair on appropriate port denoting the result of the comparison.
* <p>
* If the first value is equal to second value, then the pair is emitted on equalTo, greaterThanEqualTo, and lessThanEqualTo ports.
* If the first value is less than second value, then the pair is emitted on notEqualTo, lessThan and lessThanEqualTo ports.
@@ -51,7 +51,7 @@
BaseOperator
{
/**
- * Input port that takes a key, value pair and compares them.
+ * Input port that takes a key, value pair for comparison.
*/
public final transient DefaultInputPort<Pair<T, T>> input = new DefaultInputPort<Pair<T, T>>()
{
diff --git a/library/src/main/java/com/datatorrent/lib/math/LogicalCompareToConstant.java b/library/src/main/java/com/datatorrent/lib/math/LogicalCompareToConstant.java
index df07778..46760cb 100644
--- a/library/src/main/java/com/datatorrent/lib/math/LogicalCompareToConstant.java
+++ b/library/src/main/java/com/datatorrent/lib/math/LogicalCompareToConstant.java
@@ -60,7 +60,7 @@
private T constant;
/**
- * Input port that takes a comparable and compares it with a constant.
+ * Input port that takes a comparable to compare it with a constant.
*/
public final transient DefaultInputPort<T> input = new DefaultInputPort<T>()
{
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigCrossOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigCrossOperator.java
index 51a4bf2..222905d 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigCrossOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigCrossOperator.java
@@ -76,18 +76,13 @@
@OperatorAnnotation(partitionable = false)
public class PigCrossOperator implements Operator
{
- /**
- * Input port 1 tuples.
- */
+
private ArrayList<Map<String, Object>> input1Tuples;
- /**
- * Input port 2 tuples.
- */
private ArrayList<Map<String, Object>> input2Tuples;
/**
- * Input port 1.
+ * Input port 1 that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport1 = new DefaultInputPort<Map<String, Object>>()
{
@@ -102,7 +97,7 @@
};
/**
- * Input port 2.
+ * Input port 2 that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport2 = new DefaultInputPort<Map<String, Object>>()
{
@@ -117,7 +112,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <String, Object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigDistinctOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigDistinctOperator.java
index 884329e..d7e5d2f 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigDistinctOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigDistinctOperator.java
@@ -77,7 +77,7 @@
HashSet<Map<String, Object>> distinctSet;
/**
- * Input port 1.
+ * Input port that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -92,7 +92,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <String, Object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport =
new DefaultOutputPort<Map<String, Object>>()
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigFilterOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigFilterOperator.java
index 96d8fab..5ac1ef9 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigFilterOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigFilterOperator.java
@@ -24,7 +24,7 @@
/**
- * A derivation of BaseOperator that implements Apache Pig filter statement semantic. <br>
+ * An implementation of BaseOperator that implements Apache Pig filter statement semantic. <br>
* <p>
* Stream rows passing condition are emitted on output port stream. <br>
* <br>
@@ -70,7 +70,7 @@
}
/**
- * Input port.
+ * Input port that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -84,7 +84,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <String, Object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
}
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigForeachOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigForeachOperator.java
index 3a56049..424533c 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigForeachOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigForeachOperator.java
@@ -27,7 +27,7 @@
/**
- * <p>A derivation of BaseOperator that implements Apache Pig ForEach Operator.</p>
+ * <p>An implementation of BaseOperator that implements Apache Pig ForEach Operator.</p>
* @displayName: Pig ForEach
* @category: pigquery
* @tag: map, string, foreach operator
@@ -50,7 +50,7 @@
}
/**
- * Input port 1.
+ * Input port that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -65,6 +65,9 @@
}
};
+ /**
+ * Output port that emits a map of <String, Object>.
+ */
public final transient DefaultOutputPort<Map<String, Object>> outport =
new DefaultOutputPort<Map<String, Object>>()
{
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigGroupOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigGroupOperator.java
index d16655d..1d3218b 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigGroupOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigGroupOperator.java
@@ -30,7 +30,7 @@
/**
- * A derivation of BaseOperator that implements Apache Pig Group operator semantic. <br>
+ * An implementation of BaseOperator that implements Apache Pig Group operator semantic. <br>
* <p>
* This operator does not support Group All semantic. <br>
* <pre>
@@ -86,7 +86,7 @@
}
/**
- * Input port.
+ * Input port that takes map of <String, Object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -98,7 +98,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <Object, List<Map<String, Object>>>.
*/
public final transient DefaultOutputPort<Map<Object, List<Map<String, Object>>>> outport =
new DefaultOutputPort<Map<Object, List<Map<String, Object>>>>()
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOperator.java
index 791c216..0d22222 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOperator.java
@@ -29,7 +29,7 @@
import com.datatorrent.lib.streamquery.condition.Condition;
/**
- * A derivation of BaseOperator that implements Pig Join(Inner) semantic on live stream.
+ * An implementation of BaseOperator that implements Pig Join(Inner) semantic on live stream.
* <p>
* <pre>
* Example
@@ -72,7 +72,7 @@
* <b>Ports : </b> <br>
* <b>inport1 : </b> expects tuple Map<String, Object>. <br>
* <b>inport2 : </b> expects tuple Map<String, Object>. <br>
- * <b>outport : </b> emits joinde tuple Map<String, Object>. <br>
+ * <b>outport : </b> emits joined tuple Map<String, Object>. <br>
* <br>
* <b> StateFull : </b> Yes, values are aggregated over application window. <br>
* <b> Partitions : </b> No, will yield worng results. <br>
@@ -112,7 +112,7 @@
}
/**
- * Input1 port.
+ * Input port 1 that takes a map of <String, Object> data on which join is to be performed.
*/
public final transient DefaultInputPort<Map<String, Object>> inport1 = new DefaultInputPort<Map<String, Object>>()
{
@@ -127,7 +127,7 @@
};
/**
- * Input2 port.
+ * Input port 2 that takes a map of <String, Object> data on which join is to be performed.
*/
public final transient DefaultInputPort<Map<String, Object>> inport2 = new DefaultInputPort<Map<String, Object>>()
{
@@ -143,7 +143,7 @@
/**
- * Output port.
+ * Output port that emits map of <String, Object> which is formed by inner join of input data.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport =
new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOuterOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOuterOperator.java
index 0983114..d8bfeaf 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOuterOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigJoinOuterOperator.java
@@ -31,13 +31,13 @@
import com.datatorrent.lib.streamquery.condition.Condition;
/**
- * A derivation of BaseOperator that implements Pig Join(Outer) semantic on live stream.
+ * An implementation of BaseOperator that implements Pig Join(Outer) semantic on live stream.
*
* <br>
* <b>Ports : </b> <br>
* <b>inport1 : </b> expects tuple Map<String, Object>. <br>
* <b>inport2 : </b> expects tuple Map<String, Object>. <br>
- * <b>outport : </b> emits joinde tuple Map<String, Object>. <br>
+ * <b>outport : </b> emits joined tuple Map<String, Object>. <br>
* <br>
* <b> StateFull : </b> Yes, values are aggregated over application window. <br>
* <b> Partitions : </b> No, will yield worng results. <br>
@@ -84,7 +84,7 @@
}
/**
- * Input1 port.
+ * Input port 1 that takes a map of <String, Object> data on which join is to be performed.
*/
public final transient DefaultInputPort<Map<String, Object>> inport1 = new DefaultInputPort<Map<String, Object>>()
{
@@ -99,7 +99,7 @@
};
/**
- * Input2 port.
+ * Input port 2 that takes a map of <String, Object> data on which join is to be performed.
*/
public final transient DefaultInputPort<Map<String, Object>> inport2 = new DefaultInputPort<Map<String, Object>>()
{
@@ -115,7 +115,7 @@
/**
- * Output port.
+ * Output port that emits map of <String, Object> which is formed by outer join of input data.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport =
new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/PigSplitOperator.java b/library/src/main/java/com/datatorrent/lib/pigquery/PigSplitOperator.java
index 773a9de..3cbfe5a 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/PigSplitOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/PigSplitOperator.java
@@ -23,7 +23,7 @@
import com.datatorrent.api.DefaultOutputPort;
/**
- * A derivation of BaseOperator that implements Pig Split operator semantic. <br>
+ * An implementation of BaseOperator that implements Pig Split operator semantic. <br>
* <p>
* Number of output ports are configured in class instance.
*
@@ -52,7 +52,7 @@
}
/**
- * Input port.
+ * Input port that checks if port is valid for emitting tuple.
*/
public final transient DefaultInputPort<T> inport = new DefaultInputPort<T>() {
@Override
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/ThreeWayPigSplit.java b/library/src/main/java/com/datatorrent/lib/pigquery/ThreeWayPigSplit.java
index 4c00087..7564a41 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/ThreeWayPigSplit.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/ThreeWayPigSplit.java
@@ -19,7 +19,7 @@
/**
* <p>
- * A derivation of BaseOperator that implements Pig split operator semantic.
+ * An implementation of BaseOperator that implements Pig split operator semantic.
* <p>
* A split into node creates multiple streams from a single stream. <br>
* This operator implements following semantic. <br>
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/generate/ArithmeticGenerate.java b/library/src/main/java/com/datatorrent/lib/pigquery/generate/ArithmeticGenerate.java
index da1a18e..0194ace 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/generate/ArithmeticGenerate.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/generate/ArithmeticGenerate.java
@@ -21,7 +21,7 @@
/**
- * A derivation of Binary Generate that implements Pig arithmetic operator generate semantic. <br>
+ * An implementation of Binary Generate that implements Pig arithmetic operator generate semantic. <br>
* <p>
* Valid opName : '+', '-', '*', '/', '%'. <br>
* see {@link com.datatorrent.lib.pigquery.generate.BinaryGenerate}.
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/generate/GenerateName.java b/library/src/main/java/com/datatorrent/lib/pigquery/generate/GenerateName.java
index 77842c9..4eb2246 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/generate/GenerateName.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/generate/GenerateName.java
@@ -19,7 +19,7 @@
/**
- * <p>A derivation of Unary Generate that generates a name and provides implementation of evaluate method.</p>
+ * <p>An implementation of Unary Generate that generates a name and provides implementation of evaluate method.</p>
*
* @displayName: Generate Name
* @category: pigquery.generate
diff --git a/library/src/main/java/com/datatorrent/lib/pigquery/generate/SumGenerate.java b/library/src/main/java/com/datatorrent/lib/pigquery/generate/SumGenerate.java
index 990a3b5..8109965 100644
--- a/library/src/main/java/com/datatorrent/lib/pigquery/generate/SumGenerate.java
+++ b/library/src/main/java/com/datatorrent/lib/pigquery/generate/SumGenerate.java
@@ -19,7 +19,7 @@
/**
- * A derivation of Binary Generate that implements sum generation index expression.
+ * An implementation of Binary Generate that implements sum generation index expression.
* <p>
* @displayName: Generate Sum
* @category: pigquery.generate
diff --git a/library/src/main/java/com/datatorrent/lib/script/JavaScriptOperator.java b/library/src/main/java/com/datatorrent/lib/script/JavaScriptOperator.java
index d2f63af..fa3ee77 100644
--- a/library/src/main/java/com/datatorrent/lib/script/JavaScriptOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/script/JavaScriptOperator.java
@@ -26,7 +26,7 @@
import javax.script.*;
/**
- * A derivation of ScriptOperator that executes JavaScript on tuples input for Map <String, Object>.
+ * An implementation of ScriptOperator that executes JavaScript on tuples input for Map <String, Object>.
*
* <p>
* Key is name of variable used in script code. Proper map values must be provided
diff --git a/library/src/main/java/com/datatorrent/lib/script/RubyOperator.java b/library/src/main/java/com/datatorrent/lib/script/RubyOperator.java
index 88985b6..86bda48 100644
--- a/library/src/main/java/com/datatorrent/lib/script/RubyOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/script/RubyOperator.java
@@ -24,7 +24,7 @@
import java.util.Map;
/**
- * A derivation of ScriptOperator that executes ruby script on tuples
+ * An implementation of ScriptOperator that executes ruby script on tuples
* <p>
* @displayName: Ruby Operator
* @category: script
diff --git a/library/src/main/java/com/datatorrent/lib/script/ScriptOperator.java b/library/src/main/java/com/datatorrent/lib/script/ScriptOperator.java
index 61bb630..ecf3c27 100644
--- a/library/src/main/java/com/datatorrent/lib/script/ScriptOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/script/ScriptOperator.java
@@ -26,7 +26,7 @@
import javax.validation.constraints.NotNull;
/**
- * A base derivation of a BaseOperator for language script operator. Subclasses should provide the
+ * A base implementation of a BaseOperator for language script operator. Subclasses should provide the
implementation of getting the bindings and process method.
* Interface for language script operator.
* <p>
@@ -37,6 +37,9 @@
*/
public abstract class ScriptOperator extends BaseOperator
{
+ /**
+ * Input inBindings port that takes in a map of <String, Object>.
+ */
@InputPortFieldAnnotation(name = "inBindings", optional = true)
public final transient DefaultInputPort<Map<String, Object>> inBindings = new DefaultInputPort<Map<String, Object>>()
{
@@ -47,8 +50,16 @@
}
};
+
+ /**
+ * Output outBindings port that emits a map of <String, Object>.
+ */
@OutputPortFieldAnnotation(name = "outBindings", optional = true)
public final transient DefaultOutputPort<Map<String, Object>> outBindings = new DefaultOutputPort<Map<String, Object>>();
+
+ /**
+ * Output result port that emits an object as the result.
+ */
@OutputPortFieldAnnotation(name = "result", optional = true)
public final transient DefaultOutputPort<Object> result = new DefaultOutputPort<Object>();
protected boolean isPassThru = true;
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputation.java b/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputation.java
index d8f7315..28ed5ef 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputation.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputation.java
@@ -52,7 +52,10 @@
{
this.unifier = unifier;
}
-
+
+ /**
+ * Output port that emits an aggregate of events.
+ */
public final transient DefaultOutputPort<AGGREGATE> output = new DefaultOutputPort<AGGREGATE>()
{
@Override
@@ -66,7 +69,10 @@
}
}
};
-
+
+ /**
+ * Input data port that takes an event.
+ */
public final transient DefaultInputPort<EVENT> data = new DefaultInputPort<EVENT>()
{
@Override
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputationUnifierImpl.java b/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputationUnifierImpl.java
index 8030e60..2e36bea 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputationUnifierImpl.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/DimensionsComputationUnifierImpl.java
@@ -40,7 +40,10 @@
private DimensionsComputation.Aggregator<EVENT, AGGREGATE>[] aggregators;
@Nonnull
private final Map<AGGREGATE, AGGREGATE> aggregates;
-
+
+ /**
+ * Output port that emits an aggregate of events.
+ */
public final transient DefaultOutputPort<AGGREGATE> output = new DefaultOutputPort<AGGREGATE>();
public DimensionsComputationUnifierImpl()
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java b/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java
index 225a23d..8dc6dd9 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java
@@ -26,7 +26,7 @@
import com.datatorrent.api.DefaultOutputPort;
/**
- * A derivation of BaseOperator that computes median of incoming data. <br>
+ * An implementation of BaseOperator that computes median of incoming data. <br>
* <br>
* <b>Input Port(s) : </b><br>
* <b>data : </b> Data values input port. <br>
@@ -48,7 +48,7 @@
private ArrayList<Double> values;
/**
- * Input data port.
+ * Input data port that takes a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Number> data = new DefaultInputPort<Number>()
@@ -64,7 +64,7 @@
};
/**
- * Output port
+ * Output port that emits median of incoming data.
*/
@OutputPortFieldAnnotation(name = "median")
public final transient DefaultOutputPort<Number> median = new DefaultOutputPort<Number>();
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java b/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java
index 44e40df..8350d28 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java
@@ -26,7 +26,7 @@
import com.datatorrent.api.annotation.OutputPortFieldAnnotation;
/**
- * A derivation of BaseOperator that calculates most frequent number occurring in incoming data. <br>
+ * An implementation of BaseOperator that calculates most frequent value occurring in incoming data. <br>
* <br>
* <b>Input Port(s) : </b><br>
* <b>data : </b> Data values input port. <br>
@@ -50,7 +50,7 @@
*/
HashMap<V, Integer> values = new HashMap<V, Integer>();
/**
- * Input data port.
+ * Input data port that takes comparable values.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<V> data = new DefaultInputPort<V>()
@@ -71,7 +71,7 @@
};
/**
- * Output port
+ * Output port that emits most frequent value in incoming data.
*/
@OutputPortFieldAnnotation(name = "mean")
public final transient DefaultOutputPort<V> mode = new DefaultOutputPort<V>();
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java b/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java
index 9084e55..dd324ed 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java
@@ -25,7 +25,7 @@
import com.datatorrent.api.annotation.OutputPortFieldAnnotation;
/**
- * A derivation of BaseOperator that computes variance and standard deviation over incoming data. <br>
+ * An implementation of BaseOperator that computes variance and standard deviation over incoming data. <br>
* <br>
* <b>Input Port(s) : </b><br>
* <b>data : </b> Data values input port. <br>
@@ -48,7 +48,7 @@
private ArrayList<Double> values = new ArrayList<Double>();
/**
- * Input data port.
+ * Input data port that takes in a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<Number> data = new DefaultInputPort<Number>()
@@ -64,13 +64,13 @@
};
/**
- * Variance output port
+ * Variance output port.
*/
@OutputPortFieldAnnotation(name = "variance", optional=true)
public final transient DefaultOutputPort<Number> variance = new DefaultOutputPort<Number>();
/**
- * Standard deviation output port
+ * Standard deviation output port.
*/
@OutputPortFieldAnnotation(name = "standardDeviation")
public final transient DefaultOutputPort<Number> standardDeviation = new DefaultOutputPort<Number>();
diff --git a/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java b/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java
index 94492f0..d4cf0e6 100644
--- a/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java
@@ -24,7 +24,7 @@
import com.datatorrent.lib.util.BaseNumberValueOperator;
/**
- * A derivation of BaseOperator that computes weighted mean of incoming data. <br>
+ * An implementation of BaseOperator that computes weighted mean of incoming data. <br>
* <br>
* <b>Input Port(s) : </b><br>
* <b>data : </b> Data values input port. <br>
@@ -54,7 +54,7 @@
private double currentWeight;
/**
- * Input data port.
+ * Input data port that takes a number.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<V> data = new DefaultInputPort<V>()
@@ -71,7 +71,7 @@
};
/**
- * Input weight port.
+ * Input weight port that takes a number.
*/
@InputPortFieldAnnotation(name = "weight")
public final transient DefaultInputPort<V> weight = new DefaultInputPort<V>()
@@ -87,7 +87,7 @@
};
/**
- * Output port
+ * Output port that emits weighted mean.
*/
@OutputPortFieldAnnotation(name = "mean")
public final transient DefaultOutputPort<V> mean = new DefaultOutputPort<V>();
diff --git a/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java b/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java
index e8b92ee..2d66cfc 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java
@@ -56,7 +56,7 @@
private int size = 0;
/**
- * Input port.
+ * Input port that takes data to be added to a collection.
*/
public final transient DefaultInputPort<T> input = new DefaultInputPort<T>()
{
@@ -76,7 +76,7 @@
};
/**
- * Collection output port.
+ * Output port that emits a collection.
*/
public final transient DefaultOutputPort<Collection<T>> output = new DefaultOutputPort<Collection<T>>();
diff --git a/library/src/main/java/com/datatorrent/lib/stream/ArrayListAggregator.java b/library/src/main/java/com/datatorrent/lib/stream/ArrayListAggregator.java
index 5665a57..ec2fd38 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/ArrayListAggregator.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/ArrayListAggregator.java
@@ -20,7 +20,7 @@
/**
*
- * A derivation of AbstractAggregator that creates an ArrayList tuple from incoming tuples.
+ * An implementation of AbstractAggregator that creates an ArrayList tuple from incoming tuples.
* <p>
* The size of the ArrayList before it is emitted is determined by property \"size\". If size == 0
* then the ArrayList (if not empty) is emitted in the endWindow call. Is size is specified then the ArrayList is emitted as soon as the size is
diff --git a/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java b/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java
index 8539512..8dc33a6 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java
@@ -24,7 +24,7 @@
import java.util.ArrayList;
/**
- * A derivation of BaseKeyOperator that breaks up an ArrayList tuple into Objects.
+ * An implementation of BaseKeyOperator that breaks up an ArrayList tuple into Objects.
* <p>
* Takes in an ArrayList and emits each item in the array; mainly used for
* breaking up an ArrayList tuple into Objects. <br>
@@ -42,7 +42,7 @@
public class ArrayListToItem<K> extends BaseKeyOperator<K>
{
/**
- * Input array list port.
+ * Input data port that takes an arraylist.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<ArrayList<K>> data = new DefaultInputPort<ArrayList<K>>()
@@ -60,7 +60,7 @@
};
/**
- * Output array item port.
+ * Output port that emits an array item.
*/
@OutputPortFieldAnnotation(name = "item")
public final transient DefaultOutputPort<K> item = new DefaultOutputPort<K>();
diff --git a/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java b/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java
index 230a13b..5e0a8ff 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java
@@ -29,8 +29,8 @@
/**
* <p>
- * An implementation of operator that Aggregates <key,value&rt; input from five ports of different types into
- * <key,array list map&rt; for each key. <br>
+ * An implementation of operator that Aggregates <key,value> input from five ports of different types into
+ * <key,array list map> for each key. <br>
* <p>
* Operator emits key/array list map at end window, this end window operator. <br>
* <br>
@@ -142,7 +142,7 @@
this, 4);
/**
- * Key/array values map output port.
+ * Output port that emits a hashmap of <key,arraylist>.
*/
@OutputPortFieldAnnotation(name = "out")
public final transient DefaultOutputPort<HashMap<K, ArrayList<Object>>> out = new DefaultOutputPort<HashMap<K, ArrayList<Object>>>();
diff --git a/library/src/main/java/com/datatorrent/lib/stream/Counter.java b/library/src/main/java/com/datatorrent/lib/stream/Counter.java
index debbb24..399d6f2 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/Counter.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/Counter.java
@@ -39,6 +39,9 @@
*/
public class Counter implements Operator, Unifier<Integer>
{
+ /**
+ * Input port that takes objects to be counted in each window.
+ */
public final transient DefaultInputPort<Object> input = new DefaultInputPort<Object>()
{
@Override
@@ -48,6 +51,10 @@
}
};
+
+ /**
+ * Output port that takes emits count in each window.
+ */
public final transient DefaultOutputPort<Integer> output = new DefaultOutputPort<Integer>()
{
@Override
diff --git a/library/src/main/java/com/datatorrent/lib/stream/DevNull.java b/library/src/main/java/com/datatorrent/lib/stream/DevNull.java
index 33a97a0..ac35845 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/DevNull.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/DevNull.java
@@ -21,7 +21,7 @@
import com.datatorrent.api.annotation.Stateless;
/**
- * A derivation of BaseOperator that terminates a stream and does not affect the tuple.
+ * An implementation of BaseOperator that terminates a stream and does not affect the tuple.
* <p>
* Useful if you want to have a stream for monitoring purpose etc. In future STRAM may simply support a
* virtual stream and make this operator redundant<br>
diff --git a/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java b/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java
index f19e3fa..ce06449 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java
@@ -25,7 +25,7 @@
import org.slf4j.LoggerFactory;
/**
- * A derivation of BaseOperator that is used for logging by counting the tuple and then drops it.
+ * An implementation of BaseOperator that is used for logging by counting the tuple and then drops it.
* <p>
* Increments a count and writes the net number (rate) to console. Useful to benchmark other
* modules.<br>
@@ -45,6 +45,9 @@
*/
public class DevNullCounter<K> extends BaseOperator
{
+ /**
+ * Input port that takes objects to be counted in each window.
+ */
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<K> data = new DefaultInputPort<K>()
{
diff --git a/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java b/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java
index b51e98d..e9d75ec 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java
@@ -26,10 +26,10 @@
import java.util.Map;
/**
- * A derivation of BaseKeyValueOperator that breaks a HashMap tuple into objects.
+ * An implementation of BaseKeyValueOperator that breaks a HashMap tuple into objects.
* <p>
* Takes a HashMap and emits its keys, keyvals, vals; used for breaking up a
- * HashMap tuple into objects (keys, vals, or <key,val&rt; pairs)
+ * HashMap tuple into objects (keys, vals, or <key,val> pairs)
* <p>
* This is a pass through operator<br>
* <br>
@@ -51,7 +51,7 @@
public class HashMapToKeyValPair<K, V> extends BaseKeyValueOperator<K, V>
{
/**
- * Input key/vale map port.
+ * Input port that takes a hashmap of <key,value&rt;.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<HashMap<K, V>> data = new DefaultInputPort<HashMap<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java b/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java
index 11607d3..9ba59ff 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java
@@ -32,7 +32,7 @@
import com.datatorrent.common.util.DTThrowable;
/**
- * A derivation of BaseOperator that takes a json byte stream and emits a HashMap of key values.
+ * An implementation of BaseOperator that takes a json byte stream and emits a HashMap of key values.
* <p>
* This is a pass through operator<br>
* <br>
diff --git a/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java b/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java
index b219bbd..499c345 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java
@@ -25,7 +25,7 @@
import java.util.HashMap;
/**
- * A derivation of BaseKeyValueOperator that converts Key Value Pair to a HashMap tuple.
+ * An implementation of BaseKeyValueOperator that converts Key Value Pair to a HashMap tuple.
* <p>
* Takes a KeyValPair and emits a HashMap(1), Used for for converting KeyValPair
* to a HashMap(1) tuple
@@ -45,7 +45,7 @@
public class KeyValPairToHashMap<K, V> extends BaseKeyValueOperator<K, V>
{
/**
- * key/value input port.
+ * Input port that takes a key value pair.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<KeyValPair<K, V>> keyval = new DefaultInputPort<KeyValPair<K, V>>()
diff --git a/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java b/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java
index 03dbf08..61e8af7 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java
@@ -24,7 +24,7 @@
/**
* <p>
- * A derivation of BaseKeyValueOperator that creates a HashMap tuple from incoming tuples.
+ * An implementation of BaseKeyValueOperator that creates a HashMap tuple from incoming tuples.
* <p>
* If keys[] are set, then each incoming tuple is the value of the key (in-order) till all keys get a value.
* Once all keys are assigned values, the tuple (HashMap) is emitted, the
diff --git a/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java b/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java
index 4112aa3..c0d2b47 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java
@@ -23,7 +23,7 @@
import com.datatorrent.lib.util.BaseKeyOperator;
/**
- * A derivation of BaseKeyValueOperator that duplicates an input stream as is into two output streams.
+ * An implementation of BaseKeyValueOperator that duplicates an input stream as is into two output streams.
* <p>
* Duplication is needed to allow separation of listeners into two streams with different properties (for example
* inline vs in-rack)<p>
@@ -43,7 +43,7 @@
public class StreamDuplicater<K> extends BaseKeyOperator<K>
{
/**
- * Input port.
+ * Input data port.
*/
@InputPortFieldAnnotation(name = "data")
public final transient DefaultInputPort<K> data = new DefaultInputPort<K>()
@@ -60,13 +60,13 @@
};
/**
- * Output port 1.
+ * Output port 1 that emits duplicate of input stream.
*/
@OutputPortFieldAnnotation(name = "out1")
public final transient DefaultOutputPort<K> out1 = new DefaultOutputPort<K>();
/**
- * Output port 2.
+ * Output port 2 that emits duplicate of input stream.
*/
@OutputPortFieldAnnotation(name = "out2")
public final transient DefaultOutputPort<K> out2 = new DefaultOutputPort<K>();
diff --git a/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java b/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java
index a3561f4..12b503b 100644
--- a/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java
+++ b/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java
@@ -23,7 +23,7 @@
import com.datatorrent.api.annotation.Stateless;
/**
- * A derivation of BaseOperator that merges two streams with identical schema and emits the tuples to the output port in order.
+ * An implementation of BaseOperator that merges two streams with identical schema and emits the tuples to the output port in order.
*
* <p>
* This is a pass through operator<br>
@@ -41,7 +41,7 @@
public class StreamMerger<K> extends BaseOperator
{
/**
- * Data port 1.
+ * Data input port 1.
*/
@InputPortFieldAnnotation(name = "data1")
public final transient DefaultInputPort<K> data1 = new DefaultInputPort<K>()
@@ -57,7 +57,7 @@
};
/**
- * Data port 2.
+ * Data input port 2.
*/
@InputPortFieldAnnotation(name = "data2")
public final transient DefaultInputPort<K> data2 = new DefaultInputPort<K>()
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java
index 1da842c..1d8bfc2 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java
@@ -76,6 +76,10 @@
protected String statement;
protected ArrayList<InputSchema> inputSchemas = new ArrayList<InputSchema>(5);
protected transient ArrayList<Object> bindings;
+
+ /**
+ * Input bindings port that takes an arraylist of objects.
+ */
@InputPortFieldAnnotation(name = "bindings", optional = true)
public final transient DefaultInputPort<ArrayList<Object>> bindingsPort = new DefaultInputPort<ArrayList<Object>>()
{
@@ -86,6 +90,10 @@
}
};
+
+ /**
+ * Input port in1 that takes a hashmap of <string,object>.
+ */
@InputPortFieldAnnotation(name = "in1")
public final transient DefaultInputPort<HashMap<String, Object>> in1 = new DefaultInputPort<HashMap<String, Object>>()
{
@@ -96,6 +104,10 @@
}
};
+
+ /**
+ * Input port in2 that takes a hashmap of <string,object>.
+ */
@InputPortFieldAnnotation(name = "in2", optional = true)
public final transient DefaultInputPort<HashMap<String, Object>> in2 = new DefaultInputPort<HashMap<String, Object>>()
{
@@ -106,6 +118,10 @@
}
};
+
+ /**
+ * Input port in3 that takes a hashmap of <string,object>.
+ */
@InputPortFieldAnnotation(name = "in3", optional = true)
public final transient DefaultInputPort<HashMap<String, Object>> in3 = new DefaultInputPort<HashMap<String, Object>>()
{
@@ -116,6 +132,10 @@
}
};
+
+ /**
+ * Input port in4 that takes a hashmap of <string,object>.
+ */
@InputPortFieldAnnotation(name = "in4", optional = true)
public final transient DefaultInputPort<HashMap<String, Object>> in4 = new DefaultInputPort<HashMap<String, Object>>()
{
@@ -126,6 +146,10 @@
}
};
+
+ /**
+ * Input port in5 that takes a hashmap of <string,object>.
+ */
@InputPortFieldAnnotation(name = "in5", optional = true)
public final transient DefaultInputPort<HashMap<String, Object>> in5 = new DefaultInputPort<HashMap<String, Object>>()
{
@@ -136,6 +160,10 @@
}
};
+
+ /**
+ * Output result port that emits a hashmap of <string,object>.
+ */
@OutputPortFieldAnnotation(name = "result", optional = true)
public final transient DefaultOutputPort<HashMap<String, Object>> result = new DefaultOutputPort<HashMap<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java
index 38d38e2..a28e443 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java
@@ -23,7 +23,7 @@
import com.datatorrent.lib.streamquery.condition.Condition;
/**
- * A derivation of BaseOperator that provides sql delete query semantic on live data stream. <br>
+ * An implementation of BaseOperator that provides sql delete query semantic on live data stream. <br>
* <p>
* Stream rows passing condition are emitted on output port stream. <br>
* <br>
@@ -62,7 +62,7 @@
}
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -77,7 +77,7 @@
};
/**
- * Output port.
+ * Output port emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
}
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java
index d9cfd86..404834b 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java
@@ -25,7 +25,7 @@
import java.util.Map;
/**
- * A derivation of AbstractSqlStreamOperator that provides embedded derby sql input operator.
+ * An implementation of AbstractSqlStreamOperator that provides embedded derby sql input operator.
* <p>
* @displayName: Derby Sql Stream
* @category: streamquery
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java
index 96db114..1413248 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java
@@ -31,7 +31,7 @@
import com.datatorrent.lib.streamquery.index.ColumnIndex;
/**
- * A derivation of BaseOperator that provides sql group by querying semantics on live data stream. <br>
+ * An implementation of BaseOperator that provides sql group by querying semantics on live data stream. <br>
* <p>
* Stream rows satisfying given select condition are processed by group by
* column names and aggregate column function. <br>
@@ -112,7 +112,7 @@
}
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -127,7 +127,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java
index 002b900..b2ae776 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java
@@ -81,7 +81,7 @@
protected ArrayList<Map<String, Object>> table2;
/**
- * Input port 1.
+ * Input port 1 that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport1 = new DefaultInputPort<Map<String, Object>>() {
@Override
@@ -98,7 +98,7 @@
};
/**
- * Input port 2.
+ * Input port 2 that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport2 = new DefaultInputPort<Map<String, Object>>() {
@Override
@@ -115,7 +115,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport =
new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java
index b591362..99710ef 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java
@@ -125,7 +125,7 @@
}
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>() {
@Override
@@ -136,7 +136,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>()
{
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/SelectFunctionOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/SelectFunctionOperator.java
index 830cc59..bd97877 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/SelectFunctionOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/SelectFunctionOperator.java
@@ -57,7 +57,7 @@
private ArrayList<FunctionIndex> functions = new ArrayList<FunctionIndex>();
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -106,7 +106,7 @@
}
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/SelectOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/SelectOperator.java
index 76028fc..4f21ed5 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/SelectOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/SelectOperator.java
@@ -26,7 +26,7 @@
import com.datatorrent.lib.streamquery.index.Index;
/**
- * A derivation of BaseOperator that provides sql select query semantics on live data stream. <br>
+ * An implementation of that provides sql select query semantics on live data stream. <br>
* <p>
* Stream rows passing condition are emitted on output port stream. <br>
* <br>
@@ -78,7 +78,7 @@
}
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>()
{
@@ -101,7 +101,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
}
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/SelectTopOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/SelectTopOperator.java
index b32747e..b14e0f6 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/SelectTopOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/SelectTopOperator.java
@@ -38,7 +38,7 @@
private boolean isPercentage = false;
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>() {
@Override
@@ -104,7 +104,7 @@
}
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
}
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/UpdateOperator.java b/library/src/main/java/com/datatorrent/lib/streamquery/UpdateOperator.java
index cd5fae5..0d3a22b 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/UpdateOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/UpdateOperator.java
@@ -24,7 +24,7 @@
import com.datatorrent.lib.streamquery.condition.Condition;
/**
- * A derivation of BaseOperator that provides sql update query semantic on live data stream. <br>
+ * An implementation of BaseOperator that provides sql update query semantic on live data stream. <br>
* <p>
* Stream rows passing condition are emitted on output port stream. <br>
* <br>
@@ -65,7 +65,7 @@
}
/**
- * Input port.
+ * Input port that takes a map of <string,object>.
*/
public final transient DefaultInputPort<Map<String, Object>> inport = new DefaultInputPort<Map<String, Object>>() {
@Override
@@ -89,7 +89,7 @@
};
/**
- * Output port.
+ * Output port that emits a map of <string,object>.
*/
public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>();
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/condition/EqualValueCondition.java b/library/src/main/java/com/datatorrent/lib/streamquery/condition/EqualValueCondition.java
index 697f0b7..9158949 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/condition/EqualValueCondition.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/condition/EqualValueCondition.java
@@ -20,7 +20,7 @@
/**
- * A derivation of Condition that implements condition on column equality.
+ * An implementation of condition on column equality.
* <p>
* A valid row must have all key/value map in column name/value map.
*
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/condition/InCondition.java b/library/src/main/java/com/datatorrent/lib/streamquery/condition/InCondition.java
index 6920af1..22aae62 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/condition/InCondition.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/condition/InCondition.java
@@ -22,7 +22,7 @@
import javax.validation.constraints.NotNull;
/**
- * A derivation of Condition that implements a condition class to check if a column value is in a given set of values.
+ * An implementation of condition class to check if a column value is in a given set of values.
* <p>
* <br>
* <b>Properties : </b> <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/condition/JoinColumnEqualCondition.java b/library/src/main/java/com/datatorrent/lib/streamquery/condition/JoinColumnEqualCondition.java
index 81863e6..16cd24d 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/condition/JoinColumnEqualCondition.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/condition/JoinColumnEqualCondition.java
@@ -22,7 +22,7 @@
/**
- * A derivation of Condition that implements equal join condition class.
+ * An implementation of equal join condition class.
* <p>
* This compares values of given keys in both row data.
* <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/condition/LikeCondition.java b/library/src/main/java/com/datatorrent/lib/streamquery/condition/LikeCondition.java
index 3435e1d..0217624 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/condition/LikeCondition.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/condition/LikeCondition.java
@@ -23,7 +23,7 @@
/**
- * A derivation of Condition that implements condition class to filter rows for which given column name value matches given regular expression. <br>
+ * An implementation of condition class to filter rows for which given column name value matches given regular expression. <br>
*<p>
*<b> Properties : </b> <br>
*<b> column : < /b> Column to be matched with regular expression. <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/function/AverageFunction.java b/library/src/main/java/com/datatorrent/lib/streamquery/function/AverageFunction.java
index 3e214a7..6f8c878 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/function/AverageFunction.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/function/AverageFunction.java
@@ -23,7 +23,7 @@
import org.apache.commons.lang.StringUtils;
/**
- * A derivation of function index that implements average function semantics. <br>
+ * An implementation of function index that implements average function semantics. <br>
* <p>
* e.g : sql => SELECT AVG(column_name) FROM table_name. <br>
* <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/function/CountFunction.java b/library/src/main/java/com/datatorrent/lib/streamquery/function/CountFunction.java
index 877d8f5..48d7243 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/function/CountFunction.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/function/CountFunction.java
@@ -23,7 +23,7 @@
import org.apache.commons.lang.StringUtils;
/**
- * A derivation of function index that implements sql count function semantic. <br>
+ * An implementation of function index that implements sql count function semantic. <br>
* <p>
* Counts number of values of given column and returns count of non null values in column.
* e.g : sql => SELECT COUNT(column_name) FROM table_name. <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/function/FirstLastFunction.java b/library/src/main/java/com/datatorrent/lib/streamquery/function/FirstLastFunction.java
index 8443e6e..758cd23 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/function/FirstLastFunction.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/function/FirstLastFunction.java
@@ -23,7 +23,7 @@
import org.apache.commons.lang.StringUtils;
/**
- * A derivation of function index that implements sql first,last function semantic. <br>
+ * An implementation of function index that implements sql first,last function semantic. <br>
* <p>
* e.g : sql => SELECT FIRST/LAST(column_name) FROM table_name. <br>
* <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/function/MaxMinFunction.java b/library/src/main/java/com/datatorrent/lib/streamquery/function/MaxMinFunction.java
index 53ed8df..3745e00 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/function/MaxMinFunction.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/function/MaxMinFunction.java
@@ -23,7 +23,7 @@
import org.apache.commons.lang.StringUtils;
/**
- * A derivation of function index that implements sql max and sql min function semantic. <br>
+ * An implementation of function index that implements sql max and sql min function semantic. <br>
* <p>
* e.g : sql => SELECT MAX/MIN(column_name) FROM table_name. <br>
* <br>
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/function/SumFunction.java b/library/src/main/java/com/datatorrent/lib/streamquery/function/SumFunction.java
index f428d76..fcd7095 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/function/SumFunction.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/function/SumFunction.java
@@ -8,7 +8,7 @@
/**
- * <p> A derivation of function index that implements sql sum function. </p>
+ * <p> An implementation of sql sum function. </p>
* <p>
* @displayName: Sum Function
* @category: streamquery/function
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/index/MidIndex.java b/library/src/main/java/com/datatorrent/lib/streamquery/index/MidIndex.java
index 6a79532..1060547 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/index/MidIndex.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/index/MidIndex.java
@@ -5,7 +5,7 @@
import javax.validation.constraints.NotNull;
/**
- * <p>A derivation of Column Index that implements filter method based on mid index. </p>
+ * <p>An implementation of Column Index that implements filter method based on mid index. </p>
* <p>
* @displayName: Mid Index
* @category: streamquery/index
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/index/NegateExpression.java b/library/src/main/java/com/datatorrent/lib/streamquery/index/NegateExpression.java
index 59b0a65..5099f73 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/index/NegateExpression.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/index/NegateExpression.java
@@ -21,7 +21,7 @@
/**
- * An derivation of Unary Expression that implements filter method using negate metric sql semantic on column value.
+ * An implementation of Unary Expression that implements filter method using negate metric sql semantic on column value.
* <p>
* @displayName: Negate Expression
* @category: streamquery/index
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/index/RoundDoubleIndex.java b/library/src/main/java/com/datatorrent/lib/streamquery/index/RoundDoubleIndex.java
index 83252a4..15acd4b 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/index/RoundDoubleIndex.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/index/RoundDoubleIndex.java
@@ -5,7 +5,7 @@
import javax.validation.constraints.NotNull;
/**
- * <p>A derivation of column index that implements filter method using Round Double Index. </p>
+ * <p>An implementation of column index that implements filter method using Round Double Index. </p>
* <p>
* @displayName: Round Double Index
* @category: streamquery/index
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/index/StringCaseIndex.java b/library/src/main/java/com/datatorrent/lib/streamquery/index/StringCaseIndex.java
index 7159bdc..e5a0420 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/index/StringCaseIndex.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/index/StringCaseIndex.java
@@ -5,7 +5,7 @@
import javax.validation.constraints.NotNull;
/**
- * <p>A derivation of Column Index that implements filter method using case of a string index. </p>
+ * <p>An implementation of Column Index that implements filter method using case of a string index. </p>
* <p>
* @displayName: String Case Index
* @category: streamquery/index
diff --git a/library/src/main/java/com/datatorrent/lib/streamquery/index/StringLenIndex.java b/library/src/main/java/com/datatorrent/lib/streamquery/index/StringLenIndex.java
index e5c9133..a705677 100644
--- a/library/src/main/java/com/datatorrent/lib/streamquery/index/StringLenIndex.java
+++ b/library/src/main/java/com/datatorrent/lib/streamquery/index/StringLenIndex.java
@@ -5,7 +5,7 @@
import javax.validation.constraints.NotNull;
/**
- * <p>A derivation of Column Index that implements filter method using length of a string Index. </p>
+ * <p>An implementation of Column Index that implements filter method using length of a string Index. </p>
* <p>
* @displayName: String Length Index
* @category: streamquery/index
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/CompareFilterTuples.java b/library/src/main/java/com/datatorrent/lib/testbench/CompareFilterTuples.java
index dd7cf96..7e7673d 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/CompareFilterTuples.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/CompareFilterTuples.java
@@ -50,7 +50,9 @@
// Collected result tuples
private Map<k, Integer> result;
- // input port
+ /**
+ * Input port that takes a map of integer values.
+ */
public final transient DefaultInputPort<Map<k, Integer>> inport = new DefaultInputPort<Map<k, Integer>>() {
@Override
public void process(Map<k, Integer> map) {
@@ -66,8 +68,14 @@
}
};
- //out port
+ /**
+ * Output port that emits a map of integer values.
+ */
public final transient DefaultOutputPort<Map<k, Integer>> outport = new DefaultOutputPort<Map<k, Integer>>();
+
+ /**
+ * Output redis port that emits a map of <integer,string> values.
+ */
public final transient DefaultOutputPort<Map<Integer, String>> redisport = new DefaultOutputPort<Map<Integer, String>>();
@Override
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/CountOccurance.java b/library/src/main/java/com/datatorrent/lib/testbench/CountOccurance.java
index ba88ace..ba5160f 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/CountOccurance.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/CountOccurance.java
@@ -64,10 +64,20 @@
collect = new HashMap<k, Integer>();
}
- // out port
+ /**
+ * Output port that emits a map of integer values.
+ */
public final transient DefaultOutputPort<Map<k, Integer>> outport = new DefaultOutputPort<Map<k, Integer>>();
+
+ /**
+ * Output dimensions port that emits a map of <string,object> values.
+ */
public final transient DefaultOutputPort<Map<String, Object>> dimensionOut = new DefaultOutputPort<Map<String, Object>>();
- public final transient DefaultOutputPort<Map<String,Integer>> total = new DefaultOutputPort<Map<String,Integer>>();
+
+ /**
+ * Output total port that emits a map of <string,integer> count values.
+ */
+ public final transient DefaultOutputPort<Map<String,Integer>> total = new DefaultOutputPort<Map<String,Integer>>();
@Override
public void endWindow()
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/EventClassifier.java b/library/src/main/java/com/datatorrent/lib/testbench/EventClassifier.java
index 4e6fa4b..ffd01b2 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/EventClassifier.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/EventClassifier.java
@@ -26,7 +26,7 @@
import java.util.Random;
/**
- * A derivation of BaseOperator that creates a load with pair of keys by taking in an input stream event and adding to incoming keys
+ * An implementation of BaseOperator that creates a load with pair of keys by taking in an input stream event and adding to incoming keys
* to create a new tuple that is emitted on output port data.
* <p>
* Takes a input stream event and adds to incoming keys to create a new tuple that is emitted on output port data.
@@ -116,6 +116,10 @@
}
}
};
+
+ /**
+ * Output data port that emits a hashmap of <string,double>.
+ */
public final transient DefaultOutputPort<HashMap<String, Double>> data = new DefaultOutputPort<HashMap<String, Double>>();
;
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/EventClassifierNumberToHashDouble.java b/library/src/main/java/com/datatorrent/lib/testbench/EventClassifierNumberToHashDouble.java
index a4c47e4..bf369d6 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/EventClassifierNumberToHashDouble.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/EventClassifierNumberToHashDouble.java
@@ -24,8 +24,8 @@
import javax.validation.constraints.NotNull;
/**
- * A derivation of BaseOperator that creates a load with pair of keys by taking in an input stream event and adding to incoming keys
- * to create a new tuple of Hashmap <String,Double&rt; that is emitted on output port data.
+ * An implementation of BaseOperator that creates a load with pair of keys by taking in an input stream event and adding to incoming keys
+ * to create a new tuple of Hashmap <String,Double> that is emitted on output port data.
* <p>
* Takes a in stream event and adds to incoming keys to create a new tuple that is emitted on output port data. The aim is to create a load with pair of keys<p>
* <br>
@@ -76,6 +76,10 @@
}
}
};
+
+ /**
+ * Output data port that emits a hashmap of <string,double>.
+ */
public final transient DefaultOutputPort<HashMap<String, Double>> data = new DefaultOutputPort<HashMap<String, Double>>();
@NotNull
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/EventGenerator.java b/library/src/main/java/com/datatorrent/lib/testbench/EventGenerator.java
index 9866b0d..e8e95ab 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/EventGenerator.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/EventGenerator.java
@@ -69,8 +69,20 @@
public class EventGenerator implements InputOperator
{
private static final Logger LOG = LoggerFactory.getLogger(EventGenerator.class);
+
+ /**
+ * Output string port that emits string data.
+ */
public final transient DefaultOutputPort<String> string_data = new DefaultOutputPort<String>();
+
+ /**
+ * Output hash data port that emits a hashmap of <string,double>.
+ */
public final transient DefaultOutputPort<HashMap<String, Double>> hash_data = new DefaultOutputPort<HashMap<String, Double>>();
+
+ /**
+ * Output count port that emits a hashmap of <string,number> which contains per window count of throughput.
+ */
public final transient DefaultOutputPort<HashMap<String, Number>> count = new DefaultOutputPort<HashMap<String, Number>>();
public static final String OPORT_COUNT_TUPLE_AVERAGE = "avg";
public static final String OPORT_COUNT_TUPLE_COUNT = "count";
diff --git a/library/src/main/java/com/datatorrent/lib/testbench/EventIncrementer.java b/library/src/main/java/com/datatorrent/lib/testbench/EventIncrementer.java
index 54be232..95ed6f4 100644
--- a/library/src/main/java/com/datatorrent/lib/testbench/EventIncrementer.java
+++ b/library/src/main/java/com/datatorrent/lib/testbench/EventIncrementer.java
@@ -58,6 +58,9 @@
*/
public class EventIncrementer extends BaseOperator
{
+ /**
+ * Input seed port that takes a hashmap of <string,arraylist of integers> which provides seed data for setting up the incrementer data to work on.
+ */
public final transient DefaultInputPort<HashMap<String, ArrayList<Integer>>> seed = new DefaultInputPort<HashMap<String, ArrayList<Integer>>>()
{
@Override
@@ -83,6 +86,10 @@
}
}
};
+
+ /**
+ * Input increment port that takes a hashmap of <string,hashmap of <string,number>> which provides small random increments to the seed data.
+ */
public final transient DefaultInputPort<HashMap<String, HashMap<String, Integer>>> increment = new DefaultInputPort<HashMap<String, HashMap<String, Integer>>>()
{
@Override
@@ -117,7 +124,15 @@
}
}
};
+
+ /**
+ * Output data port that emits a hashmap of <string,string> which is the addition of seed and increment.
+ */
public final transient DefaultOutputPort<HashMap<String, String>> data = new DefaultOutputPort<HashMap<String, String>>();
+
+ /**
+ * Output count port that emits a hashmap of <string,integer> which contains number of processed tuples per window.
+ */
public final transient DefaultOutputPort<HashMap<String, Integer>> count = new DefaultOutputPort<HashMap<String, Integer>>();
public static final String OPORT_COUNT_TUPLE_COUNT = "count";
HashMap<String, ArrayList<KeyValPair<String, Double>>> vmap = new HashMap<String, ArrayList<KeyValPair<String, Double>>>();
