http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/contrib/src/main/java/com/datatorrent/contrib/splunk/SplunkTcpOutputOperator.java ---------------------------------------------------------------------- diff --git a/contrib/src/main/java/com/datatorrent/contrib/splunk/SplunkTcpOutputOperator.java b/contrib/src/main/java/com/datatorrent/contrib/splunk/SplunkTcpOutputOperator.java index 0f57062..ee59aa7 100644 --- a/contrib/src/main/java/com/datatorrent/contrib/splunk/SplunkTcpOutputOperator.java +++ b/contrib/src/main/java/com/datatorrent/contrib/splunk/SplunkTcpOutputOperator.java @@ -27,8 +27,8 @@ import java.net.Socket; * The output operator for Splunk, which writes to a TCP port on which splunk server is configured. * <p></p> * @displayName Splunk TCP Output - * @category Database - * @tags output operator + * @category Output + * @tags splunk * @since 1.0.4 */ public class SplunkTcpOutputOperator<T> extends AbstractStoreOutputOperator<T, SplunkStore> {
http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/contrib/src/main/java/com/datatorrent/contrib/sqlite/SqliteStreamOperator.java ---------------------------------------------------------------------- diff --git a/contrib/src/main/java/com/datatorrent/contrib/sqlite/SqliteStreamOperator.java b/contrib/src/main/java/com/datatorrent/contrib/sqlite/SqliteStreamOperator.java index e7b4502..1bb12c6 100644 --- a/contrib/src/main/java/com/datatorrent/contrib/sqlite/SqliteStreamOperator.java +++ b/contrib/src/main/java/com/datatorrent/contrib/sqlite/SqliteStreamOperator.java @@ -32,8 +32,8 @@ import org.slf4j.LoggerFactory; * This is an SQLite input operator. * <p></p> * @displayName Sqlite Stream - * @category Database - * @tags input operator + * @category Input + * @tags sqlite * @since 0.3.2 */ public class SqliteStreamOperator extends AbstractSqlStreamOperator http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/algo/FilterKeysHashMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/algo/FilterKeysHashMap.java b/library/src/main/java/com/datatorrent/lib/algo/FilterKeysHashMap.java index 16559a3..8d34519 100644 --- a/library/src/main/java/com/datatorrent/lib/algo/FilterKeysHashMap.java +++ b/library/src/main/java/com/datatorrent/lib/algo/FilterKeysHashMap.java @@ -52,7 +52,7 @@ import com.datatorrent.lib.util.BaseKeyOperator; * </p> * * @displayName Filter Keyval Pairs By Key HashMap - * @category Algorithmic + * @category Stream Manipulators * @tags filter, key value * * @since 0.3.2 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/algo/FirstMatchMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/algo/FirstMatchMap.java b/library/src/main/java/com/datatorrent/lib/algo/FirstMatchMap.java index d2d97af..bc7ee66 100644 --- a/library/src/main/java/com/datatorrent/lib/algo/FirstMatchMap.java +++ b/library/src/main/java/com/datatorrent/lib/algo/FirstMatchMap.java @@ -56,7 +56,7 @@ import com.datatorrent.lib.util.BaseMatchOperator; * </p> * * @displayName Emit First Match (Number) - * @category Algorithmic + * @category Rules and Alerts * @tags filter, key value, numeric * * @since 0.3.2 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/algo/FirstTillMatch.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/algo/FirstTillMatch.java b/library/src/main/java/com/datatorrent/lib/algo/FirstTillMatch.java index a0fcfad..13bec8c 100644 --- a/library/src/main/java/com/datatorrent/lib/algo/FirstTillMatch.java +++ b/library/src/main/java/com/datatorrent/lib/algo/FirstTillMatch.java @@ -54,7 +54,7 @@ import com.datatorrent.lib.util.BaseMatchOperator; * </p> * * @displayName Emit Keyval Pairs Until Match (Number) - * @category Algorithmic + * @category Rules and Alerts * @tags filter, key value, numeric * * @since 0.3.2 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/algo/MatchMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/algo/MatchMap.java b/library/src/main/java/com/datatorrent/lib/algo/MatchMap.java index aafaa61..5d04e80 100644 --- a/library/src/main/java/com/datatorrent/lib/algo/MatchMap.java +++ b/library/src/main/java/com/datatorrent/lib/algo/MatchMap.java @@ -58,7 +58,7 @@ import com.datatorrent.lib.util.UnifierHashMap; * </p> * * @displayName Emit Matching Keval Pairs (Number) - * @category Algorithmic + * @category Rules and Alerts * @tags filter, key value, numeric * * @since 0.3.2 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/algo/UniqueValueCount.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/algo/UniqueValueCount.java b/library/src/main/java/com/datatorrent/lib/algo/UniqueValueCount.java index b5900f0..02959d2 100644 --- a/library/src/main/java/com/datatorrent/lib/algo/UniqueValueCount.java +++ b/library/src/main/java/com/datatorrent/lib/algo/UniqueValueCount.java @@ -47,7 +47,7 @@ import com.datatorrent.api.annotation.Stateless; * * @param <K>Type of Key objects</K> * @displayName Unique Values Per Key - * @category Algorithmic + * @category Stream Manipulators * @tags count, key value * @since 0.3.5 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerMap.java b/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerMap.java index 5496763..9bd71d1 100644 --- a/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerMap.java +++ b/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerMap.java @@ -32,8 +32,8 @@ import org.slf4j.LoggerFactory; * This operator accepts a list of Map<String,Object> objects, and serves the data under the {@link SnapshotSchema}. * Each Map represents a row in the table, and the full list of maps represents a table. * @displayName App Data Snapshot Map Server - * @category App Data - * @tags appdata, snapshot, map + * @category DT View Integration + * @tags app data, snapshot, map */ public class AppDataSnapshotServerMap extends AbstractAppDataSnapshotServer<Map<String, Object>> { http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerPOJO.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerPOJO.java b/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerPOJO.java index 7f397ab..df8a6ea 100644 --- a/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerPOJO.java +++ b/library/src/main/java/com/datatorrent/lib/appdata/snapshot/AppDataSnapshotServerPOJO.java @@ -30,7 +30,7 @@ import com.datatorrent.lib.appdata.gpo.GPOUtils; * This operator accepts a list of POJOs, and serves the data under the {@link SnapshotSchema}. * Each POJO represents a row in the table, and the full list of POJOs represents a table. * @displayName App Data Snapshot POJO Server - * @category Output + * @category DT View Integration * @tags app data, snapshot, pojo */ @Evolving http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableKeyValueStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableKeyValueStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableKeyValueStoreOutputOperator.java index 965ed4d..7fc846a 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableKeyValueStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableKeyValueStoreOutputOperator.java @@ -22,7 +22,7 @@ package com.datatorrent.lib.db; * A concrete operator should be created from this skeleton implementation. * <p></p> * @displayName Abstract Aggregate Transactionable Store Output - * @category Store + * @category Output * @tags transactional, output operator, key value * * @param <T> The tuple type. http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableStoreOutputOperator.java index 5128bca..1608215 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractAggregateTransactionableStoreOutputOperator.java @@ -22,7 +22,7 @@ package com.datatorrent.lib.db; * Subclasses should implement that method which stores the aggregate state of the operator in the store. * <p></p> * @displayName Abstract Aggregate Transactionable Store Output - * @category Store + * @category Output * @tags transactional, output operator * * @param <T> The tuple type. http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractBatchTransactionableStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractBatchTransactionableStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractBatchTransactionableStoreOutputOperator.java index fb9f392..2f67ca4 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractBatchTransactionableStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractBatchTransactionableStoreOutputOperator.java @@ -24,7 +24,7 @@ import com.google.common.collect.Lists; * All the writes to the store over an application window are sent in one batch. * <p></p> * @displayName Abstract Batch Transactionable Store Output - * @category Store + * @category Output * @tags transactional, output operator * * @param <T> The tuple type. http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractKeyValueStoreInputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractKeyValueStoreInputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractKeyValueStoreInputOperator.java index 178dfb5..786ba4c 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractKeyValueStoreInputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractKeyValueStoreInputOperator.java @@ -24,8 +24,8 @@ import java.util.*; * The default behavior is to get all the values using the keys from the store for each window. Subclasses are free to override this behavior. * </p> * @displayName Abstract Key Value Store Input - * @category Store - * @tags input operator, key value + * @category Input + * @tags key value * * @param <T> The tuple type. * @param <S> The store type. http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableKeyValueStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableKeyValueStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableKeyValueStoreOutputOperator.java index dfc8ed1..e13ec64 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableKeyValueStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableKeyValueStoreOutputOperator.java @@ -24,8 +24,8 @@ package com.datatorrent.lib.db; * come and commit the transaction at end window. * </p> * @displayName Abstract Pass Through Transactionable Key Value Store Output - * @category Store - * @tags output operator, key value, transactional + * @category Outupt + * @tags key value, transactional * * @param <T> The tuple type * @param <S> The store type http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableStoreOutputOperator.java index d7a933a..b0827dc 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractPassThruTransactionableStoreOutputOperator.java @@ -24,8 +24,8 @@ package com.datatorrent.lib.db; * come and commit the transaction at end window. * </p> * @displayName Abstract Pass Through Transactionable Store Output - * @category Store - * @tags transactional, output operator + * @category Output + * @tags transactional * * @param <T> The tuple type * @param <S> The store type http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractStoreInputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractStoreInputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractStoreInputOperator.java index cfa8440..86844f4 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractStoreInputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractStoreInputOperator.java @@ -26,8 +26,7 @@ import com.datatorrent.api.InputOperator; * A concrete operator should be created from this skeleton implementation. * <p></p> * @displayName Abstract Store Input - * @category Store - * @tags input operator + * @category Input * * @param <T> The tuple type * @param <S> The store type http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractStoreOutputOperator.java index 291d780..18f5659 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractStoreOutputOperator.java @@ -29,8 +29,7 @@ import com.datatorrent.api.annotation.InputPortFieldAnnotation; * A concrete operator should be created from this skeleton implementation. * <p></p> * @displayName Abstract Store Output - * @category Store - * @tags output operator + * @category Output * * @param <T> The tuple type * @param <S> The store type http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/AbstractTransactionableStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/AbstractTransactionableStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/AbstractTransactionableStoreOutputOperator.java index ee1a0c6..35997c6 100644 --- a/library/src/main/java/com/datatorrent/lib/db/AbstractTransactionableStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/AbstractTransactionableStoreOutputOperator.java @@ -33,8 +33,8 @@ import com.datatorrent.api.annotation.InputPortFieldAnnotation; * For non-idempotent operations (incrementing values in the store, etc). * <p></p> * @displayName Abstract Transactionable Store Output - * @category Store - * @tags transactional, output operator + * @category Output + * @tags transactional * * @param <T> The type of the tuple * @param <S> The store type http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/cache/AbstractDBLookupCacheBackedOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/cache/AbstractDBLookupCacheBackedOperator.java b/library/src/main/java/com/datatorrent/lib/db/cache/AbstractDBLookupCacheBackedOperator.java index 9e18fd8..9446267 100644 --- a/library/src/main/java/com/datatorrent/lib/db/cache/AbstractDBLookupCacheBackedOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/cache/AbstractDBLookupCacheBackedOperator.java @@ -43,7 +43,7 @@ import com.datatorrent.lib.util.KeyValPair; * </ul> * </p> * @displayName Abstract DB Lookup Cache Backed - * @category Database + * @category Input * @tags cache, key value * * @param <T> type of tuples http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcNonTransactionableOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcNonTransactionableOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcNonTransactionableOutputOperator.java index eb4a1ea..61ad18b 100644 --- a/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcNonTransactionableOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcNonTransactionableOutputOperator.java @@ -28,8 +28,8 @@ import com.datatorrent.lib.db.AbstractStoreOutputOperator; * Subclasses should implement the method which provides the insertion command. * <p></p> * @displayName Abstract JDBC Non Transactionable Output - * @category Database - * @tags output operator + * @category Output + * @tags jdbc * * @param <T> The kind of tuples that are being processed * @since 1.0.4 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcTransactionableOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcTransactionableOutputOperator.java b/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcTransactionableOutputOperator.java index 72255b7..0fcedd4 100644 --- a/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcTransactionableOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/jdbc/AbstractJdbcTransactionableOutputOperator.java @@ -46,8 +46,8 @@ import com.datatorrent.lib.db.AbstractPassThruTransactionableStoreOutputOperator * only when all the updates are executed, the transaction is committed in the end window call. * </p> * @displayName Abstract JDBC Transactionable Output - * @category Database - * @tags output operator, transactional + * @category Output + * @tags transactional * * @param <T> type of tuple * @since 0.9.4 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/db/jdbc/JDBCLookupCacheBackedOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/db/jdbc/JDBCLookupCacheBackedOperator.java b/library/src/main/java/com/datatorrent/lib/db/jdbc/JDBCLookupCacheBackedOperator.java index aeb3bf7..8f16f61 100644 --- a/library/src/main/java/com/datatorrent/lib/db/jdbc/JDBCLookupCacheBackedOperator.java +++ b/library/src/main/java/com/datatorrent/lib/db/jdbc/JDBCLookupCacheBackedOperator.java @@ -35,7 +35,7 @@ import com.datatorrent.lib.db.cache.AbstractDBLookupCacheBackedOperator; * Subclasses should implement the methods which are required to insert and retrieve data from the database. * <p></p> * @displayName JDBC Lookup Cache Backed - * @category Database + * @category Input * @tags cache, key value * * @param <T> type of input tuples </T> http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/io/AbstractFTPInputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/io/AbstractFTPInputOperator.java b/library/src/main/java/com/datatorrent/lib/io/AbstractFTPInputOperator.java index 4ca6b0d..6118f2b 100644 --- a/library/src/main/java/com/datatorrent/lib/io/AbstractFTPInputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/io/AbstractFTPInputOperator.java @@ -49,7 +49,7 @@ import com.datatorrent.lib.io.fs.AbstractFileInputOperator; * @param <T> type of tuple. * @displayName FTP Directory Input * @category Input - * @tags ftp, input operator + * @tags ftp * * @since 2.0.0 */ @@ -170,6 +170,10 @@ public abstract class AbstractFTPInputOperator<T> extends AbstractFileInputOpera /** * An {@link AbstractFTPInputOperator} that splits file into lines and emits them. + * + * @displayName FTP String Input + * @category Input + * @tags ftp */ public static class FTPStringInputOperator extends AbstractFTPInputOperator<String> { http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/io/AbstractKeyValueStoreOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/io/AbstractKeyValueStoreOutputOperator.java b/library/src/main/java/com/datatorrent/lib/io/AbstractKeyValueStoreOutputOperator.java index f1e8ba5..8cdf004 100644 --- a/library/src/main/java/com/datatorrent/lib/io/AbstractKeyValueStoreOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/io/AbstractKeyValueStoreOutputOperator.java @@ -33,9 +33,9 @@ import com.datatorrent.lib.util.KeyValPair; * Subclasses must implement the methods used to retrieve data from and put data into the store, * they must also implement the methods which handle transactions. * <p></p> - * @displayName Abstract Keyval Store Input - * @category Store - * @tags key value, input operator + * @displayName Abstract Keyval Store Output + * @category Output + * @tags key value * * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java index 4f80b3d..81fb076 100644 --- a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java +++ b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java @@ -32,8 +32,8 @@ import com.datatorrent.common.util.PubSubMessage; * App Data dashboards and forward queries to App Data store operators. * * @displayName App Data Pub Sub Query - * @category App Data - * @tags input, appdata, query, dashboards + * @category DT View Integration + * @tags input, app data, query */ public class PubSubWebSocketAppDataQuery extends PubSubWebSocketInputOperator<String> implements AppData.ConnectionInfoProvider { http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java index 5674d5c..12496a9 100644 --- a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java +++ b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java @@ -31,8 +31,8 @@ import com.datatorrent.common.util.PubSubMessage.PubSubMessageType; * App Data dashboards produced by App Data store operators. * * @displayName App Data Pub Sub Result - * @category App Data - * @tags output, appdata, result, dashboards + * @category DT View Integration + * @tags output, app data, result */ @AppData.AppendQueryIdToTopic(value=true) public class PubSubWebSocketAppDataResult extends PubSubWebSocketOutputOperator<String> implements AppData.ConnectionInfoProvider http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/io/block/FSSliceReader.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/io/block/FSSliceReader.java b/library/src/main/java/com/datatorrent/lib/io/block/FSSliceReader.java index 6dd7dd9..44bf135 100644 --- a/library/src/main/java/com/datatorrent/lib/io/block/FSSliceReader.java +++ b/library/src/main/java/com/datatorrent/lib/io/block/FSSliceReader.java @@ -24,6 +24,9 @@ import com.datatorrent.netlet.util.Slice; /** * An {@link AbstractFSBlockReader} which emits fixed-size byte-arrays wrapped in {@link Slice}.<br/> * + * @category Input + * @tags fs + * * @since 2.1.0 */ @StatsListener.DataQueueSize http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseMapOutputOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseMapOutputOperator.java b/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseMapOutputOperator.java index 0bab0af..ba84d44 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseMapOutputOperator.java +++ b/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseMapOutputOperator.java @@ -48,8 +48,8 @@ import org.slf4j.LoggerFactory; * <b>groupMap</b>: defines the mapping from the group ids to the names <br> * </p> * @displayName Apache Log Parse Map - * @category Logs - * @tags apache, regex + * @category Tuple Converters + * @tags apache, parse * * @since 0.9.4 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseOperator.java b/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseOperator.java index f925ad2..a75c018 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseOperator.java +++ b/library/src/main/java/com/datatorrent/lib/logs/ApacheLogParseOperator.java @@ -49,8 +49,8 @@ import com.datatorrent.api.annotation.Stateless; * <b>Properties</b>: none<br> * </p> * @displayName Apache Log Parse - * @category Logs - * @tags apache + * @category Tuple Converters + * @tags apache, parse * * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/ApacheVirtualLogParseOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/ApacheVirtualLogParseOperator.java b/library/src/main/java/com/datatorrent/lib/logs/ApacheVirtualLogParseOperator.java index 2f28e56..2ec7044 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/ApacheVirtualLogParseOperator.java +++ b/library/src/main/java/com/datatorrent/lib/logs/ApacheVirtualLogParseOperator.java @@ -38,8 +38,8 @@ import java.util.regex.Pattern; * More output ports in this operator. * </p> * @displayName Apache Virtual Log Parse - * @category Logs - * @tags apache + * @category Tuple Converters + * @tags apache, parse * * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/DimensionAggregationUnifier.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/DimensionAggregationUnifier.java b/library/src/main/java/com/datatorrent/lib/logs/DimensionAggregationUnifier.java index ae0eeaa..90bc843 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/DimensionAggregationUnifier.java +++ b/library/src/main/java/com/datatorrent/lib/logs/DimensionAggregationUnifier.java @@ -30,8 +30,8 @@ import com.datatorrent.api.Operator; * A Map from Strings to aggregated DimensionObjects is emitted by the unifier. * <p></p> * @displayName Dimension Aggregation Unifier - * @category Logs - * @tags aggregation, unifier + * @category Stats and Aggregations + * @tags aggregation, unifier, dimensions * * @since 0.9.0 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenArrayList.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenArrayList.java b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenArrayList.java index a43e461..1934e17 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenArrayList.java +++ b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenArrayList.java @@ -44,8 +44,8 @@ import java.util.HashMap; * <br> * </p> * @displayName Filtered Line To Token ArrayList - * @category Logs - * @tags string + * @category Tuple Converters + * @tags filter, arraylist, string * * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenHashMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenHashMap.java b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenHashMap.java index d367ab4..6fabe73 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenHashMap.java +++ b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineToTokenHashMap.java @@ -46,8 +46,8 @@ import java.util.HashMap; * <br> * </p> * @displayName Filtered Line To Token HashMap - * @category Logs - * @tags string + * @category Tuple Converters + * @tags filter, hashmap, string * * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/FilteredLineTokenizerKeyVal.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineTokenizerKeyVal.java b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineTokenizerKeyVal.java index 2f341ba..7bb43a1 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/FilteredLineTokenizerKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/logs/FilteredLineTokenizerKeyVal.java @@ -43,8 +43,8 @@ import java.util.HashMap; * </p> * * @displayName Filtered Line Tokenizer Key Value - * @category Logs - * @tags string, key value + * @category Tuple Converters + * @tags string, key value, string * * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/LineToTokenArrayList.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/LineToTokenArrayList.java b/library/src/main/java/com/datatorrent/lib/logs/LineToTokenArrayList.java index 68653e7..6d4efa4 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/LineToTokenArrayList.java +++ b/library/src/main/java/com/datatorrent/lib/logs/LineToTokenArrayList.java @@ -47,8 +47,8 @@ import com.datatorrent.lib.util.UnifierArrayList; * <b>splittokenby</b>: The characters used to split a token into key,val1,val2,.... If not specified the value is set to null. Default is "", i.e. tokens are not split<br> * </p> * @displayName Line To Token (ArrayList) - * @category Logs - * @tags string + * @category Tuple Converters + * @tags string, arraylist * * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/LineToTokenHashMap.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/LineToTokenHashMap.java b/library/src/main/java/com/datatorrent/lib/logs/LineToTokenHashMap.java index 30832b4..f5510b3 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/LineToTokenHashMap.java +++ b/library/src/main/java/com/datatorrent/lib/logs/LineToTokenHashMap.java @@ -45,8 +45,8 @@ import com.datatorrent.lib.util.UnifierHashMap; * </p> * * @displayName Line To Token (HashMap) - * @category Logs - * @tags string + * @category Tuple Converters + * @tags string, hashmap * * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/LineTokenizer.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/LineTokenizer.java b/library/src/main/java/com/datatorrent/lib/logs/LineTokenizer.java index 12005ad..c5c554a 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/LineTokenizer.java +++ b/library/src/main/java/com/datatorrent/lib/logs/LineTokenizer.java @@ -38,7 +38,7 @@ import com.datatorrent.lib.util.BaseLineTokenizer; * <br> * </p> * @displayName Line Tokenizer - * @category Logs + * @category Tuple Converters * @tags string * * @since 0.3.3 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/LineTokenizerKeyVal.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/LineTokenizerKeyVal.java b/library/src/main/java/com/datatorrent/lib/logs/LineTokenizerKeyVal.java index 0648855..6ef66a3 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/LineTokenizerKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/logs/LineTokenizerKeyVal.java @@ -45,7 +45,7 @@ import java.util.HashMap; * <br> * </p> * @displayName Line Tokenizer Key Value - * @category Logs + * @category Tuple Converters * @tags string, key value * * @since 0.3.2 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/MultiWindowDimensionAggregation.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/MultiWindowDimensionAggregation.java b/library/src/main/java/com/datatorrent/lib/logs/MultiWindowDimensionAggregation.java index 4db5476..ab7bbaf 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/MultiWindowDimensionAggregation.java +++ b/library/src/main/java/com/datatorrent/lib/logs/MultiWindowDimensionAggregation.java @@ -38,7 +38,7 @@ import com.datatorrent.lib.util.KeyValPair; * This class aggregates the value of given dimension across windows. * <p></p> * @displayName Multi Window Dimension Aggregation - * @category Logs + * @category Stats and Aggregations * @tags aggregation * * @since 0.3.4 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/logs/RegexMatchMapOperator.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/logs/RegexMatchMapOperator.java b/library/src/main/java/com/datatorrent/lib/logs/RegexMatchMapOperator.java index 33d71c8..a6556a5 100644 --- a/library/src/main/java/com/datatorrent/lib/logs/RegexMatchMapOperator.java +++ b/library/src/main/java/com/datatorrent/lib/logs/RegexMatchMapOperator.java @@ -68,7 +68,7 @@ import org.slf4j.LoggerFactory; * <b>regex</b>: defines the regex <br> * * @displayName Regex Match Map - * @category Logs + * @category Tuple Converters * @tags regex * * @since 1.0.5 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java ---------------------------------------------------------------------- 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 4486de2..d5b96b7 100644 --- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java +++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlert.java @@ -44,7 +44,7 @@ import com.datatorrent.lib.util.KeyValPair; * <b>Specific run time checks</b>: None<br> * <br> * @displayName Change Alert - * @category Math + * @category Rules and Alerts * @tags change, key value, numeric, percentage * @since 0.3.3 */ @@ -80,13 +80,13 @@ public class ChangeAlert<V extends Number> extends BaseNumberValueOperator<V> baseValue = tval; } }; - - + + /** * Output port which emits a key value pair. */ public final transient DefaultOutputPort<KeyValPair<V, Double>> alert = new DefaultOutputPort<KeyValPair<V, Double>>(); - + /** * baseValue is a state full field. It is retained across windows */ @@ -96,7 +96,7 @@ public class ChangeAlert<V extends Number> extends BaseNumberValueOperator<V> /** * getter function for threshold value - * + * * @return threshold value */ @Min(1) http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java ---------------------------------------------------------------------- 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 896153d..e5a6e5f 100644 --- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertKeyVal.java @@ -44,7 +44,7 @@ import com.datatorrent.lib.util.KeyValPair; * <b>inverse</b>: if set to true the key in the filter will block tuple<br> * <b>filterBy</b>: List of keys to filter on<br> * @displayName Change Alert Key Value - * @category Math + * @category Rules and Alerts * @tags change, key value, numeric, percentage * @since 0.3.3 */ @@ -93,7 +93,7 @@ public class ChangeAlertKeyVal<K, V extends Number> extends val.setValue(tval); } }; - + /** * Key,Percent Change output port. */ @@ -107,7 +107,7 @@ public class ChangeAlertKeyVal<K, V extends Number> extends /** * getter function for threshold value - * + * * @return threshold value */ @Min(1) http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java ---------------------------------------------------------------------- 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 24e1662..63f9680 100644 --- a/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java +++ b/library/src/main/java/com/datatorrent/lib/math/ChangeAlertMap.java @@ -43,7 +43,7 @@ import com.datatorrent.lib.util.BaseNumberKeyValueOperator; * <b>inverse</b>: if set to true the key in the filter will block tuple<br> * <b>filterBy</b>: List of keys to filter on<br> * @displayName Change Alert Map - * @category Math + * @category Rules and Alerts * @tags change, key value, numeric, percentage, map * @since 0.3.2 */ @@ -51,7 +51,7 @@ public class ChangeAlertMap<K, V extends Number> extends BaseNumberKeyValueOpera { /** * Input data port that takes a map of <key,value>. - */ + */ public final transient DefaultInputPort<Map<K, V>> data = new DefaultInputPort<Map<K, V>>() { /** @@ -89,7 +89,7 @@ public class ChangeAlertMap<K, V extends Number> extends BaseNumberKeyValueOpera // Default "pass through" unifier works as tuple is emitted as pass through /** - * Output port which emits a hashmap of key, percentage change. + * Output port which emits a hashmap of key, percentage change. */ public final transient DefaultOutputPort<HashMap<K, HashMap<V,Double>>> alert = new DefaultOutputPort<HashMap<K, HashMap<V,Double>>>(); http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindow.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindow.java b/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindow.java index 0eb5d15..3bed755 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindow.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindow.java @@ -33,9 +33,9 @@ import com.datatorrent.api.DefaultInputPort; * <b>S</b> is the state object kept in the sliding window <br> * <b>windowSize</b>: Number of streaming window in this sliding window<br> * <br> - * + * * @displayName Abstract Sliding Window - * @category Multi-Window + * @category Stats and Aggregations * @tags sliding window, state * @since 0.3.3 */ @@ -54,14 +54,14 @@ public abstract class AbstractSlidingWindow<T, S> extends BaseOperator }; protected ArrayList<S> states = null; - + protected S lastExpiredWindowState = null; - + protected int currentCursor = -1; @Min(2) int windowSize = 2; - + /** * getter function for n (number of previous window states * @@ -86,7 +86,7 @@ public abstract class AbstractSlidingWindow<T, S> extends BaseOperator abstract protected void processDataTuple(T tuple); /** - * Implement this method to create the state object needs to be kept in the sliding window + * Implement this method to create the state object needs to be kept in the sliding window * * @return the state of current streaming window */ @@ -95,9 +95,9 @@ public abstract class AbstractSlidingWindow<T, S> extends BaseOperator /** * Get the Streaming window state in it's coming the order start from 0 * - * @param i - * 0 the state of the first coming streaming window - * -1 the state of the last expired streaming window + * @param i + * 0 the state of the first coming streaming window + * -1 the state of the last expired streaming window * @return State of the streaming window * @throws ArrayIndexOutOfBoundsException if i >= sliding window size */ @@ -125,11 +125,11 @@ public abstract class AbstractSlidingWindow<T, S> extends BaseOperator { // move currentCursor 1 position currentCursor = (currentCursor + 1) % windowSize; - // expire the state at the first position which is the state of the streaming window moving out of the current application window + // expire the state at the first position which is the state of the streaming window moving out of the current application window lastExpiredWindowState = states.get(currentCursor); - + states.set(currentCursor, createWindowState()); - + } /** http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindowKeyVal.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindowKeyVal.java b/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindowKeyVal.java index 9d1d9ae..9eb3c6e 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindowKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/AbstractSlidingWindowKeyVal.java @@ -44,7 +44,7 @@ import com.datatorrent.lib.util.KeyValPair; * <b>windowSize i.e. N</b>: Number of windows to keep state on<br> * <br> * @displayName Abstract Sliding Window Key Value - * @category Multi-Window + * @category Stats and Aggregations * @tags sliding window, numeric, key value, average * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowRangeKeyVal.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowRangeKeyVal.java b/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowRangeKeyVal.java index e6dd6ee..ead1cee 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowRangeKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowRangeKeyVal.java @@ -45,7 +45,7 @@ import com.datatorrent.lib.util.KeyValPair; * <br> * * @displayName Multi Window Range Key Value - * @category Multi-Window + * @category Stats and Aggregations * @tags key value, range, numeric * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowSumKeyVal.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowSumKeyVal.java b/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowSumKeyVal.java index 114c2fc..89448e9 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowSumKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/MultiWindowSumKeyVal.java @@ -43,7 +43,7 @@ import javax.validation.constraints.Min; * window.<br> * <br> * @displayName Multi Window Sum Key Value - * @category Multi-Window + * @category Stats and Aggregations * @tags key value, sum, numeric * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverage.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverage.java b/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverage.java index 0c47781..2100a04 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverage.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverage.java @@ -39,7 +39,7 @@ import com.datatorrent.lib.util.KeyValPair; * <b>windowSize</b>: Number of windows to keep state on<br> * <br> * @displayName Simple Moving Average - * @category Multi-Window + * @category Stats and Aggregations * @tags key value, numeric, average * @since 0.3.3 */ @@ -72,7 +72,7 @@ public class SimpleMovingAverage<K, V extends Number> extends /** * Create the list if key doesn't exist. Add value to buffer and increment * counter. - * + * * @param tuple */ @Override @@ -95,7 +95,7 @@ public class SimpleMovingAverage<K, V extends Number> extends /** * Calculate average and emit in appropriate port. - * + * * @param key * @param obj */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverageObject.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverageObject.java b/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverageObject.java index 99451e3..5702b39 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverageObject.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/SimpleMovingAverageObject.java @@ -21,9 +21,9 @@ import org.apache.commons.lang.mutable.MutableInt; /** * Provides information needed to calculate simple moving average. - * + * * @displayName Simple Moving Average Object - * @category Multi-Window + * @category Stats and Aggregations * @tags average, sum, count * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/multiwindow/SortedMovingWindow.java ---------------------------------------------------------------------- diff --git a/library/src/main/java/com/datatorrent/lib/multiwindow/SortedMovingWindow.java b/library/src/main/java/com/datatorrent/lib/multiwindow/SortedMovingWindow.java index e296205..84388e4 100644 --- a/library/src/main/java/com/datatorrent/lib/multiwindow/SortedMovingWindow.java +++ b/library/src/main/java/com/datatorrent/lib/multiwindow/SortedMovingWindow.java @@ -46,7 +46,7 @@ import com.google.common.base.Function; * <p></p> * * @displayName Sorted Moving Window - * @category Multi-Window + * @category Stats and Aggregations * @tags sort, list, function, sliding window * @since 0.9.2 */ @@ -56,13 +56,13 @@ public class SortedMovingWindow<T, K> extends AbstractSlidingWindow<T, List<T>> * Output port to emit sorted output. */ public transient DefaultOutputPort<T> outputPort = new DefaultOutputPort<T>(); - + /** * Output port to emit error output. */ @OutputPortFieldAnnotation(error = true) public transient DefaultOutputPort<T> errorOutput = new DefaultOutputPort<T>(); - + private Map<K, PriorityQueue<T>> sortedListInSlidingWin = new HashMap<K, PriorityQueue<T>>(); private List<T> tuplesInCurrentStreamWindow = new LinkedList<T>(); @@ -84,7 +84,7 @@ public class SortedMovingWindow<T, K> extends AbstractSlidingWindow<T, List<T>> } sortedList.add(tuple); } - + @Override public List<T> createWindowState() @@ -123,7 +123,7 @@ public class SortedMovingWindow<T, K> extends AbstractSlidingWindow<T, List<T>> // If the expiring tuple is less than the first element of the sorted list. No more tuples to emit break; } else { - // Emit the element in sorted list if it's less than the expiring tuple + // Emit the element in sorted list if it's less than the expiring tuple outputPort.emit(minElemInSortedList); // remove the element from the sorted list iterator.remove(); http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java ---------------------------------------------------------------------- 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 c146d35..bc26dbd 100644 --- a/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java +++ b/library/src/main/java/com/datatorrent/lib/statistics/MedianOperator.java @@ -36,7 +36,7 @@ import com.datatorrent.api.annotation.OperatorAnnotation; * <b>Partitions : No</b>, no will yield wrong results. <br> * <br>+ * @displayName Median - * @category Statistics + * @category Stats and Aggregations * @tags median operator, number * @since 0.3.4 */ @@ -44,7 +44,7 @@ import com.datatorrent.api.annotation.OperatorAnnotation; public class MedianOperator extends BaseOperator { private ArrayList<Double> values; - + /** * Input data port that takes a number. */ @@ -59,12 +59,12 @@ public class MedianOperator extends BaseOperator values.add(tuple.doubleValue()); } }; - + /** * Output port that emits median of incoming data. */ public final transient DefaultOutputPort<Number> median = new DefaultOutputPort<Number>(); - + @Override public void beginWindow(long arg0) { @@ -79,8 +79,8 @@ public class MedianOperator extends BaseOperator median.emit(values.get(0)); return; } - - // median value + + // median value Collections.sort(values); int medianIndex = values.size() / 2; if (values.size() %2 == 0) { http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java ---------------------------------------------------------------------- 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 fcc8534..4b5136d 100644 --- a/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java +++ b/library/src/main/java/com/datatorrent/lib/statistics/ModeOperator.java @@ -36,7 +36,7 @@ import com.datatorrent.api.annotation.OperatorAnnotation; * <b>Partitions : No</b>, no will yeild wrong results. <br> * <br> * @displayName Mode - * @category Statistics + * @category Stats and Aggregations * @tags numeric, integer, count * @since 0.3.4 */ @@ -66,12 +66,12 @@ public class ModeOperator<V extends Comparable<?>> extends BaseOperator } } }; - + /** * Output port that emits most frequent value in incoming data. */ public final transient DefaultOutputPort<V> mode = new DefaultOutputPort<V>(); - + /** * Emit mode value. */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java ---------------------------------------------------------------------- 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 f792c3a..6038a3a 100644 --- a/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java +++ b/library/src/main/java/com/datatorrent/lib/statistics/StandardDeviation.java @@ -37,15 +37,15 @@ import com.datatorrent.api.annotation.OutputPortFieldAnnotation; * <b>Partitions : No</b>, no will yield wrong results. <br> * <br> * @displayName Standard Deviation - * @category Statistics - * @tags numeric, math, calculation, sum, count + * @category Stats and Aggregations + * @tags numeric, math, calculation, sum, count * @since 0.3.4 */ @OperatorAnnotation(partitionable = false) public class StandardDeviation extends BaseOperator { private ArrayList<Double> values = new ArrayList<Double>(); - + /** * Input data port that takes in a number. */ @@ -60,18 +60,18 @@ public class StandardDeviation extends BaseOperator values.add(tuple.doubleValue()); } }; - + /** * Variance output port. */ @OutputPortFieldAnnotation(optional=true) public final transient DefaultOutputPort<Number> variance = new DefaultOutputPort<Number>(); - + /** * Standard deviation output port. */ public final transient DefaultOutputPort<Number> standardDeviation = new DefaultOutputPort<Number>(); - + /** * End window. */ @@ -80,15 +80,15 @@ public class StandardDeviation extends BaseOperator { // no values. if (values.size() == 0) return; - + // get mean first. double mean = 0.0; for (Double value : values) { mean += value; } mean = mean/values.size(); - - // get variance + + // get variance double outVal = 0.0; for (Double value : values) { outVal += (value-mean)*(value-mean); @@ -97,10 +97,10 @@ public class StandardDeviation extends BaseOperator if (variance.isConnected()) { variance.emit(outVal); } - + // get standard deviation standardDeviation.emit(Math.sqrt(outVal)); - + values = new ArrayList<Double>(); } } http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java ---------------------------------------------------------------------- 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 2e1d830..b1ff2e4 100644 --- a/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java +++ b/library/src/main/java/com/datatorrent/lib/statistics/WeightedMeanOperator.java @@ -36,7 +36,7 @@ import com.datatorrent.lib.util.BaseNumberValueOperator; * <b>Partitions : No</b>, no will yeild wrong results. <br> * <br> * @displayName Weighted Mean - * @category Statistics + * @category Stats and Aggregations * @tags numeric, math, calculation, sum, count, mean operator, average * @since 0.3.4 */ @@ -45,13 +45,13 @@ public class WeightedMeanOperator<V extends Number> extends BaseNumberValueOper { // aggregate weighted sum private double weightedSum; - + // aggregate weighted count private double weightedCount; - + // current input weight private double currentWeight; - + /** * Input data port that takes a number. */ @@ -67,7 +67,7 @@ public class WeightedMeanOperator<V extends Number> extends BaseNumberValueOper weightedCount += currentWeight; } }; - + /** * Input weight port that takes a number. */ @@ -82,14 +82,14 @@ public class WeightedMeanOperator<V extends Number> extends BaseNumberValueOper if (tuple.doubleValue() != 0.0) currentWeight = tuple.doubleValue(); } }; - + /** * Output port that emits weighted mean. */ public final transient DefaultOutputPort<V> mean = new DefaultOutputPort<V>(); - + @Override - public void setup(OperatorContext arg0) + public void setup(OperatorContext arg0) { currentWeight = 1.0; } http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java ---------------------------------------------------------------------- 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 b0eac35..e607110 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java +++ b/library/src/main/java/com/datatorrent/lib/stream/AbstractAggregator.java @@ -26,9 +26,9 @@ import com.datatorrent.api.Operator; import com.datatorrent.api.annotation.OperatorAnnotation; /** - * - * A base implementation of an operator that aggregates tuples. Subclasses should provide the - implementation to get a new collection of a given size. + * + * A base implementation of an operator that aggregates tuples. Subclasses should provide the + implementation to get a new collection of a given size. * <p> * If size of collection is 0 then all tuples till end window are aggregated, otherwise collection is emitted as * soon as collection size reaches to given size. <br> @@ -36,7 +36,7 @@ import com.datatorrent.api.annotation.OperatorAnnotation; * <b>StateFull : Yes </b>, values are collected over application window. <br> * <b>Partitions : No</b>, will yield wrong results. * @displayName Abstract Aggregator - * @category Stream + * @category Stream Manipulators * @tags aggregate * @param <T> * Aggregate tuple type. @@ -82,12 +82,12 @@ public abstract class AbstractAggregator<T> implements Operator /** * Set the size of the collection. - * + * * If set to zero, the collection collects all the tuples within a window and * emits the collection as 1 output tuple at the end of the window. If set to * positive value, it collects the collection as soon as the size of the * collection reaches the size. - * + * * @param size * the size to set */ @@ -98,7 +98,7 @@ public abstract class AbstractAggregator<T> implements Operator /** * Size of collection. - * + * * @return size of collection */ @Min(0) @@ -109,7 +109,7 @@ public abstract class AbstractAggregator<T> implements Operator /** * Abstract method to get collection of given size. - * + * * @param size * @return collection */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/ArrayListAggregator.java ---------------------------------------------------------------------- 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 d9152c7..f3c5d55 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 @@ import java.util.Collection; /** * - * An implementation 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 @@ -35,7 +35,7 @@ import java.util.Collection; * If 0, the ArrayList is emitted in endWindow call. Default value is 0, </br> * <br> * @displayName Array List Aggregator - * @category Stream + * @category Stream Manipulators * @tags list, aggregate, collection * @param <T> Type of elements in the collection.<br> * @since 0.3.3 http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java ---------------------------------------------------------------------- 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 b0a5835..83605e8 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java +++ b/library/src/main/java/com/datatorrent/lib/stream/ArrayListToItem.java @@ -22,7 +22,7 @@ import com.datatorrent.lib.util.BaseKeyOperator; import java.util.ArrayList; /** - * An implementation 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> @@ -30,9 +30,9 @@ import java.util.ArrayList; * <br> * <b>Ports</b>:<br> * <b>data</b>: expects ArrayList<K>br> <b>item</b>: emits K<br> - * + * * @displayName Array List To Item - * @category Stream + * @category Stream Manipulators * @tags arraylist, clone * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java ---------------------------------------------------------------------- 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 e137d0d..9e84204 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java +++ b/library/src/main/java/com/datatorrent/lib/stream/ConsolidatorKeyVal.java @@ -40,7 +40,7 @@ import com.datatorrent.lib.util.KeyValPair; * <b>Input(s) : </b> 5 max input ports, 3 are optional. <br> * <br> * @displayName Consolidator Key Value - * @category Stream + * @category Stream Manipulators * @tags arraylist, key value * @since 0.3.3 */ @@ -66,7 +66,7 @@ public class ConsolidatorKeyVal<K, V1, V2, V3, V4, V5> implements Operator * <p> * Class operates on <K,V> pair, stores value in given number position in * list. <br> - * + * * @param <V> * value type. */ @@ -80,7 +80,7 @@ public class ConsolidatorKeyVal<K, V1, V2, V3, V4, V5> implements Operator /** * Constructor - * + * * @param oper * Connected operator. * @param num @@ -145,7 +145,7 @@ public class ConsolidatorKeyVal<K, V1, V2, V3, V4, V5> implements Operator /** * Get array list object for given key - * + * * @param k key * @return array list for key. */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/Counter.java ---------------------------------------------------------------------- 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 dc2e5cd..c3ed4ef 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/Counter.java +++ b/library/src/main/java/com/datatorrent/lib/stream/Counter.java @@ -33,7 +33,7 @@ import com.datatorrent.api.Operator.Unifier; * <b>output</b>: emits Integer<br> * <br> * @displayName Counter - * @category Stream + * @category Stream Manipulators * @tags integer, object, count * @since 0.3.3 */ @@ -51,7 +51,7 @@ public class Counter implements Operator, Unifier<Integer> } }; - + /** * Output port that takes emits count in each window. */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/DevNull.java ---------------------------------------------------------------------- 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 c98a5e3..b7f0c6d 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/DevNull.java +++ b/library/src/main/java/com/datatorrent/lib/stream/DevNull.java @@ -20,7 +20,7 @@ import com.datatorrent.api.DefaultInputPort; import com.datatorrent.api.annotation.Stateless; /** - * An implementation 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> @@ -29,7 +29,7 @@ import com.datatorrent.api.annotation.Stateless; * <b>data</b>: expects K<br> * <br> * @displayName Dev Null - * @category Stream + * @category Stream Manipulators * @tags debug, terminate * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java ---------------------------------------------------------------------- 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 51215b3..94a8f20 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java +++ b/library/src/main/java/com/datatorrent/lib/stream/DevNullCounter.java @@ -24,7 +24,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An implementation 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> @@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory; * Results are written to the log<br> * <br> * @displayName Dev Null Counter - * @category Stream + * @category Stream Manipulators * @tags count * @since 0.3.3 */ @@ -52,7 +52,7 @@ public class DevNullCounter<K> extends BaseOperator /** * Process each tuple. Expects upstream node to compute number of tuples in * that window and send it as an int<br> - * + * * @param tuple */ @Override @@ -74,7 +74,7 @@ public class DevNullCounter<K> extends BaseOperator /** * getter function for debug state - * + * * @return debug state */ public boolean getDebug() @@ -84,7 +84,7 @@ public class DevNullCounter<K> extends BaseOperator /** * setter function for debug state - * + * * @param i * sets debug to i */ @@ -103,7 +103,7 @@ public class DevNullCounter<K> extends BaseOperator /** * Sets up all the config parameters. Assumes checking is done and has passed - * + * * @param context */ @Override http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java ---------------------------------------------------------------------- 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 4a5e3fc..7713fa0 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java +++ b/library/src/main/java/com/datatorrent/lib/stream/HashMapToKeyValPair.java @@ -25,7 +25,7 @@ import java.util.HashMap; import java.util.Map; /** - * An implementation 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> pairs) @@ -42,7 +42,7 @@ import java.util.Map; * <b>val</b>: emits V<br> * <br> * @displayName Hash Map To Key Value Pair - * @category Stream + * @category Tuple Converters * @tags hashmap, key value * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java ---------------------------------------------------------------------- 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 edf3ea3..3f6106c 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java +++ b/library/src/main/java/com/datatorrent/lib/stream/JsonByteArrayOperator.java @@ -30,7 +30,7 @@ import com.datatorrent.api.DefaultOutputPort; import com.datatorrent.netlet.util.DTThrowable; /** - * An implementation 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> @@ -43,7 +43,7 @@ import com.datatorrent.netlet.util.DTThrowable; *    eg: key: "agentinfo.os.name", value: "Ubuntu" <br> * <br> * @displayName JSON Byte Array - * @category Stream + * @category Tuple Converters * @tags json, byte array * @since 0.9.4 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java ---------------------------------------------------------------------- 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 2f9aec8..41a3997 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java +++ b/library/src/main/java/com/datatorrent/lib/stream/KeyValPairToHashMap.java @@ -23,7 +23,7 @@ import com.datatorrent.lib.util.KeyValPair; import java.util.HashMap; /** - * An implementation 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 @@ -35,7 +35,7 @@ import java.util.HashMap; * <b>map</b>: emits HashMap<K,V><br> * <br> * @displayName Key Value Pair To HashMap - * @category Stream + * @category Tuple Converters * @tags key value * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java ---------------------------------------------------------------------- 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 24ca24b..2582cdf 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java +++ b/library/src/main/java/com/datatorrent/lib/stream/RoundRobinHashMap.java @@ -22,7 +22,7 @@ import java.util.HashMap; /** * <p> - * An implementation 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 @@ -40,7 +40,7 @@ import java.util.HashMap; * <b>Properties</b>:<br> * <b>keys[]</b>: Set of keys to insert in the output tuple</b> * @displayName Round Robin HashMap - * @category Stream + * @category Tuple Converters * @tags key value, hashmap * @since 0.3.3 */ @@ -91,7 +91,7 @@ public class RoundRobinHashMap<K, V> extends BaseKeyValueOperator<K, V> /** * Keys for round robin asspociation, set by application. - * + * * @param keys */ public void setKeys(K[] keys) http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java ---------------------------------------------------------------------- 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 23e94fd..8a69a08 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java +++ b/library/src/main/java/com/datatorrent/lib/stream/StreamDuplicater.java @@ -21,7 +21,7 @@ import com.datatorrent.api.annotation.Stateless; import com.datatorrent.lib.util.BaseKeyOperator; /** - * An implementation 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> @@ -33,7 +33,7 @@ import com.datatorrent.lib.util.BaseKeyOperator; * <b>out2</b>: emits <K><br> * <br> * @displayName Stream duplicator - * @category Stream + * @category Stream Manipulators * @tags duplicate * @since 0.3.2 */ @@ -60,7 +60,7 @@ public class StreamDuplicater<K> extends BaseKeyOperator<K> * Output port 1 that emits duplicate of input stream. */ public final transient DefaultOutputPort<K> out1 = new DefaultOutputPort<K>(); - + /** * Output port 2 that emits duplicate of input stream. */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java ---------------------------------------------------------------------- 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 c7782f0..3c113bf 100644 --- a/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java +++ b/library/src/main/java/com/datatorrent/lib/stream/StreamMerger.java @@ -21,8 +21,8 @@ import com.datatorrent.api.DefaultOutputPort; import com.datatorrent.api.annotation.Stateless; /** - * An implementation 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> * <b>Ports</b>:<br> @@ -31,7 +31,7 @@ import com.datatorrent.api.annotation.Stateless; * <b>out</b>: emits K<br> * <br> * @displayName Stream Merger - * @category Stream + * @category Stream Manipulators * @tags merge * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java ---------------------------------------------------------------------- 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 4a1d7de..860fb39 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/AbstractSqlStreamOperator.java @@ -25,13 +25,13 @@ import java.util.ArrayList; import java.util.HashMap; /** - * A base implementation of a BaseOperator that is a sql stream operator. Subclasses should provide the - implementation of how to process the tuples. + * A base implementation of a BaseOperator that is a sql stream operator. Subclasses should provide the + implementation of how to process the tuples. * <p> - * Abstract sql db input operator. + * Abstract sql db input operator. * <p> * @displayName Abstract Sql Stream - * @category Streamquery + * @category Stream Manipulators * @tags sql operator * @since 0.3.2 */ @@ -76,7 +76,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator 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. */ @@ -90,7 +90,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Input port in1 that takes a hashmap of <string,object>. */ @@ -103,7 +103,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Input port in2 that takes a hashmap of <string,object>. */ @@ -117,7 +117,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Input port in3 that takes a hashmap of <string,object>. */ @@ -131,7 +131,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Input port in4 that takes a hashmap of <string,object>. */ @@ -145,7 +145,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Input port in5 that takes a hashmap of <string,object>. */ @@ -159,7 +159,7 @@ public abstract class AbstractSqlStreamOperator extends BaseOperator } }; - + /** * Output result port that emits a hashmap of <string,object>. */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java ---------------------------------------------------------------------- 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 e2cdcc3..8685d99 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/DeleteOperator.java @@ -41,7 +41,7 @@ import com.datatorrent.lib.streamquery.condition.Condition; * <b> columns : </b> Column names/aggregate functions for select. <br> * <br> * @displayName Delete - * @category Streamquery + * @category Stream Manipulators * @tags sql delete operator * @since 0.3.3 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java ---------------------------------------------------------------------- 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 6331a49..0087234 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/DerbySqlStreamOperator.java @@ -25,10 +25,10 @@ import java.util.List; import java.util.Map; /** - * An implementation 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 + * @category Stream Manipulators * @tags sql, in-memory, input operator * @since 0.3.2 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java ---------------------------------------------------------------------- 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 586338a..f7fc27a 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/GroupByHavingOperator.java @@ -55,7 +55,7 @@ import com.datatorrent.lib.streamquery.index.ColumnIndex; * <b> havingConditions : </b> Having filter conditions for aggregate(s). <br> * <br> * @displayName GroupBy Having Operator - * @category Streamquery + * @category Stream Manipulators * @tags sql, groupby operator, condition, index * @since 0.3.4 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java ---------------------------------------------------------------------- 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 128bc12..15b6422 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/InnerJoinOperator.java @@ -47,7 +47,7 @@ import com.datatorrent.lib.streamquery.index.Index; * <b> table2Columns : </b> Columns to be selected from table2. <br> * <br> * @displayName Inner join - * @category Streamquery + * @category Stream Manipulators * @tags sql, inner join operator * * @since 0.3.3 @@ -98,7 +98,7 @@ public class InnerJoinOperator implements Operator } } }; - + /** * Input port 2 that takes a map of <string,object>. */ @@ -115,13 +115,13 @@ public class InnerJoinOperator implements Operator } } }; - + /** * Output port that emits a map of <string,object>. */ - public final transient DefaultOutputPort<Map<String, Object>> outport = + public final transient DefaultOutputPort<Map<String, Object>> outport = new DefaultOutputPort<Map<String, Object>>(); - + @Override public void setup(OperatorContext arg0) { @@ -155,6 +155,7 @@ public class InnerJoinOperator implements Operator } /** + * Pick the supported condition. Currently only equal join is supported. * @param set joinCondition */ public void setJoinCondition(Condition joinCondition) http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/b7ba5212/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java ---------------------------------------------------------------------- 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 791cac4..552f527 100644 --- a/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java +++ b/library/src/main/java/com/datatorrent/lib/streamquery/OrderByOperator.java @@ -38,9 +38,9 @@ import com.datatorrent.api.Operator.Unifier; * <b> outport : </b> Output hash map(row) port, emits HashMap<String,Object><br> * <br> * <b> Properties : </b> <br> - * <b> oredrByRules : </b>List of order by rules for tuples. + * <b> orderByRules : </b>List of order by rules for tuples. * @displayName OrderBy - * @category Streamquery + * @category Stream Manipulators * @tags orderby operator * @since 0.3.5 */ @@ -49,13 +49,13 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> /** * Order by rules. */ - ArrayList<OrderByRule<?>> oredrByRules = new ArrayList<OrderByRule<?>>(); + ArrayList<OrderByRule<?>> orderByRules = new ArrayList<OrderByRule<?>>(); /** * Descending flag. */ private boolean isDescending; - + /** * collected rows. */ @@ -66,7 +66,7 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> */ public void addOrderByRule(OrderByRule<?> rule) { - oredrByRules.add(rule); + orderByRules.add(rule); } /** @@ -100,8 +100,8 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> @Override public void endWindow() { - for (int i=0; i < oredrByRules.size(); i++) { - rows = oredrByRules.get(i).sort(rows); + for (int i=0; i < orderByRules.size(); i++) { + rows = orderByRules.get(i).sort(rows); } if (isDescending) { for (int i=0; i < rows.size(); i++) outport.emit(rows.get(i)); @@ -114,16 +114,16 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> public void setup(OperatorContext arg0) { // TODO Auto-generated method stub - + } @Override public void teardown() { // TODO Auto-generated method stub - + } - + /** * Input port that takes a map of <string,object>. */ @@ -134,7 +134,7 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> rows.add(tuple); } }; - + /** * Output port that emits a map of <string,object>. */ @@ -143,11 +143,28 @@ public class OrderByOperator implements Operator, Unifier<Map<String, Object>> @Override public Unifier<Map<String, Object>> getUnifier() { OrderByOperator unifier = new OrderByOperator(); - for (int i=0; i < oredrByRules.size(); i++) { - unifier.addOrderByRule(oredrByRules.get(i)); + for (int i=0; i < getOrderByRules().size(); i++) { + unifier.addOrderByRule(getOrderByRules().get(i)); } unifier.setDescending(isDescending); return unifier; } }; + + /** + * @return the orderByRules + */ + public ArrayList<OrderByRule<?>> getOrderByRules() + { + return orderByRules; + } + + /** + * The order by rules used to order incoming tuples. + * @param oredrByRules the orderByRules to set + */ + public void setOrderByRules(ArrayList<OrderByRule<?>> oredrByRules) + { + this.orderByRules = oredrByRules; + } }
