You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by ch...@apache.org on 2015/09/10 00:31:50 UTC

[02/50] [abbrv] incubator-apex-malhar git commit: Cleaned up properties descriptions Renamed some properties Cleaned up categories Cleaned up tags Renamed some classes to improve clarity

http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/dd15161d/library/src/main/java/com/datatorrent/lib/util/BaseLineTokenizer.java
----------------------------------------------------------------------
diff --git a/library/src/main/java/com/datatorrent/lib/util/BaseLineTokenizer.java b/library/src/main/java/com/datatorrent/lib/util/BaseLineTokenizer.java
index 67a0591..5547d2b 100644
--- a/library/src/main/java/com/datatorrent/lib/util/BaseLineTokenizer.java
+++ b/library/src/main/java/com/datatorrent/lib/util/BaseLineTokenizer.java
@@ -32,11 +32,11 @@ import javax.validation.constraints.NotNull;
  * <b>data</b>: expects String<br>
  * </p>
  * @displayName Base Line Tokenizer
- * @category Algorithmic
+ * @category Stream Manipulator
  * @tags string
  * @since 0.3.2
  */
-public class BaseLineTokenizer extends BaseOperator
+public abstract class BaseLineTokenizer extends BaseOperator
 {
   /**
    * This is the input port, which receives strings.

http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/dd15161d/library/src/main/java/com/datatorrent/lib/util/BaseMatchOperator.java
----------------------------------------------------------------------
diff --git a/library/src/main/java/com/datatorrent/lib/util/BaseMatchOperator.java b/library/src/main/java/com/datatorrent/lib/util/BaseMatchOperator.java
index 60f92a6..7887df9 100644
--- a/library/src/main/java/com/datatorrent/lib/util/BaseMatchOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/util/BaseMatchOperator.java
@@ -52,14 +52,14 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
   @Pattern(regexp = "lte|lt|eq|ne|gt|gte", message = "Value has to be one of lte, lt, eq, ne, gt, gte")
   private double value = 0.0;
 
-  public enum supported_type {
+  public enum ComparatorFunction {
     LTE, LT, EQ, NEQ, GT, GTE
   };
 
-  supported_type type = supported_type.EQ;
+  ComparatorFunction comparator = ComparatorFunction.EQ;
 
   /**
-   * setter function for key
+   * The key from the input tuple whose value will be matched.
    *
    * @param key
    */
@@ -69,7 +69,7 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
   }
 
   /**
-   * getter function for key
+   * Gets the key from the input tuple whose value will be matched.
    *
    * @return key
    */
@@ -80,7 +80,7 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
   }
 
   /**
-   * setter function for value
+   * The threshold against which a comparison is done.
    *
    * @param value
    */
@@ -90,7 +90,7 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
   }
 
   /**
-   * getter function for value
+   * Gets the threshold against which a comparison is done.
    *
    * @return value
    */
@@ -102,7 +102,7 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
   public boolean compareValue(double value)
   {
     boolean ret;
-    switch (type) {
+    switch (comparator) {
       case LT:
         ret = value < this.value;
         break;
@@ -128,13 +128,13 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
     return ret;
   }
 
-  public supported_type getType()
+  public ComparatorFunction getType()
   {
-    return type;
+    return comparator;
   }
 
   /**
-   * Setter function for compare type. Allowed values are lte, lt, eq, ne, gt,
+   * Setter function for compare comparator. Allowed values are lte, lt, eq, ne, gt,
    * gte
    * <p>
    * *
@@ -159,33 +159,51 @@ public class BaseMatchOperator<K, V> extends BaseKeyValueOperator<K, V>
     }
   }
 
+  /**
+   * Gets the comparator function used.
+   * @return The comparator function used.
+   */
+  public ComparatorFunction getComparator()
+  {
+    return comparator;
+  }
+
+  /**
+   * The comparator function used.
+   * @param comparator The comparator used.
+   */
+  public void setComparator(ComparatorFunction comparator)
+  {
+    this.comparator = comparator;
+  }
+
   public void setTypeLT()
   {
-    type = supported_type.LT;
+    comparator = ComparatorFunction.LT;
   }
 
   public void setTypeLTE()
   {
-    type = supported_type.LTE;
+    comparator = ComparatorFunction.LTE;
   }
 
   public void setTypeEQ()
   {
-    type = supported_type.EQ;
+    comparator = ComparatorFunction.EQ;
   }
 
   public void setTypeNEQ()
   {
-    type = supported_type.NEQ;
+    comparator = ComparatorFunction.NEQ;
   }
 
   public void setTypeGT()
   {
-    type = supported_type.GT;
+    comparator = ComparatorFunction.GT;
   }
 
   public void setTypeGTE()
   {
-    type = supported_type.GTE;
+    comparator = ComparatorFunction.GTE;
   }
 }

http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/dd15161d/library/src/main/java/com/datatorrent/lib/util/JavaScriptFilterOperator.java
----------------------------------------------------------------------
diff --git a/library/src/main/java/com/datatorrent/lib/util/JavaScriptFilterOperator.java b/library/src/main/java/com/datatorrent/lib/util/JavaScriptFilterOperator.java
index 29d0ed2..67a08f5 100644
--- a/library/src/main/java/com/datatorrent/lib/util/JavaScriptFilterOperator.java
+++ b/library/src/main/java/com/datatorrent/lib/util/JavaScriptFilterOperator.java
@@ -28,8 +28,8 @@ import com.datatorrent.api.Context.OperatorContext;
  * This operator consumes tuples.&nbsp;If the tuples satisfy a specified Java Script filtering function, then they are emitted.
  * <p></p>
  * @displayName Java Script Filter
- * @category Algorithmic
- * @tags filter
+ * @category Rules and Alerts
+ * @tags filter, javascript
  * @since 0.3.4
  */
 public class JavaScriptFilterOperator extends FilterOperator
@@ -65,7 +65,7 @@ public class JavaScriptFilterOperator extends FilterOperator
    * Enter the JavaScript to setup the environment.
    * @param script
    */
-  
+
   public void setSetupScript(String script)
   {
     setupScript = script;

http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/dd15161d/library/src/test/java/com/datatorrent/lib/algo/LeastFrequentKeyTest.java
----------------------------------------------------------------------
diff --git a/library/src/test/java/com/datatorrent/lib/algo/LeastFrequentKeyTest.java b/library/src/test/java/com/datatorrent/lib/algo/LeastFrequentKeyTest.java
index 030721b..97be408 100644
--- a/library/src/test/java/com/datatorrent/lib/algo/LeastFrequentKeyTest.java
+++ b/library/src/test/java/com/datatorrent/lib/algo/LeastFrequentKeyTest.java
@@ -25,7 +25,7 @@ import com.datatorrent.lib.testbench.CountAndLastTupleTestSink;
 
 /**
  *
- * Functional tests for {@link com.datatorrent.lib.algo.LeastFrequentKey}<p>
+ * Functional tests for {@link com.datatorrent.lib.algo.LeastFrequentValue}<p>
  *
  */
 public class LeastFrequentKeyTest
@@ -37,7 +37,7 @@ public class LeastFrequentKeyTest
   @Test
   public void testNodeProcessing() throws Exception
   {
-    LeastFrequentKey<String> oper = new LeastFrequentKey<String>();
+    LeastFrequentValue<String> oper = new LeastFrequentValue<String>();
     CountAndLastTupleTestSink matchSink = new CountAndLastTupleTestSink();
     CountAndLastTupleTestSink listSink = new CountAndLastTupleTestSink();
     oper.least.setSink(matchSink);

http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/dd15161d/library/src/test/java/com/datatorrent/lib/algo/MostFrequentKeyTest.java
----------------------------------------------------------------------
diff --git a/library/src/test/java/com/datatorrent/lib/algo/MostFrequentKeyTest.java b/library/src/test/java/com/datatorrent/lib/algo/MostFrequentKeyTest.java
index a78fb90..9061f17 100644
--- a/library/src/test/java/com/datatorrent/lib/algo/MostFrequentKeyTest.java
+++ b/library/src/test/java/com/datatorrent/lib/algo/MostFrequentKeyTest.java
@@ -26,7 +26,7 @@ import com.datatorrent.lib.testbench.CountAndLastTupleTestSink;
 
 /**
  *
- * Functional tests for {@link com.datatorrent.lib.algo.MostFrequentKey}<p>
+ * Functional tests for {@link com.datatorrent.lib.algo.MostFrequentValue}<p>
  *
  */
 public class MostFrequentKeyTest
@@ -38,7 +38,7 @@ public class MostFrequentKeyTest
   @Test
   public void testNodeProcessing() throws Exception
   {
-    MostFrequentKey<String> oper = new MostFrequentKey<String>();
+    MostFrequentValue<String> oper = new MostFrequentValue<String>();
     CountAndLastTupleTestSink matchSink = new CountAndLastTupleTestSink();
     CountAndLastTupleTestSink listSink = new CountAndLastTupleTestSink();
     oper.most.setSink(matchSink);