Improved documentation for App Data Pub Sub operators
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/commit/6d7c4bc5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/tree/6d7c4bc5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/diff/6d7c4bc5 Branch: refs/heads/master Commit: 6d7c4bc53df4567d0d534b8416f1f67cb8d065dd Parents: d96c3d8 Author: Timothy Farkas <[email protected]> Authored: Tue Jul 28 14:16:26 2015 -0700 Committer: David Yan <[email protected]> Committed: Tue Jul 28 15:32:32 2015 -0700 ---------------------------------------------------------------------- .../com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java | 5 +++-- .../com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/6d7c4bc5/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 aa22d3f..4f80b3d 100644 --- a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java +++ b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataQuery.java @@ -28,11 +28,12 @@ import com.datatorrent.common.experimental.AppData; import com.datatorrent.common.util.PubSubMessage; /** - * This is an app data pub sub query operator. + * This is an App Data pub sub query operator. This operator is used to receive queries from + * App Data dashboards and forward queries to App Data store operators. * * @displayName App Data Pub Sub Query * @category App Data - * @tags input, appdata, query + * @tags input, appdata, query, dashboards */ public class PubSubWebSocketAppDataQuery extends PubSubWebSocketInputOperator<String> implements AppData.ConnectionInfoProvider { http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/6d7c4bc5/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 29069ba..5674d5c 100644 --- a/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java +++ b/library/src/main/java/com/datatorrent/lib/io/PubSubWebSocketAppDataResult.java @@ -27,11 +27,12 @@ import com.datatorrent.api.Context.OperatorContext; import com.datatorrent.common.experimental.AppData; import com.datatorrent.common.util.PubSubMessage.PubSubMessageType; /** - * This is an app data pub sub result operator. + * This is an app data pub sub result operator. This operator is used to send results to + * App Data dashboards produced by App Data store operators. * * @displayName App Data Pub Sub Result * @category App Data - * @tags output, appdata, result + * @tags output, appdata, result, dashboards */ @AppData.AppendQueryIdToTopic(value=true) public class PubSubWebSocketAppDataResult extends PubSubWebSocketOutputOperator<String> implements AppData.ConnectionInfoProvider
