| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_71) on Tue May 17 00:28:44 UTC 2016 --> |
| <title>JsonAnalytics (Quarks v0.4.0)</title> |
| <meta name="date" content="2016-05-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonAnalytics (Quarks v0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JsonAnalytics.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?quarks/analytics/math3/json/JsonAnalytics.html" target="_top">Frames</a></li> |
| <li><a href="JsonAnalytics.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">quarks.analytics.math3.json</div> |
| <h2 title="Class JsonAnalytics" class="title">Class JsonAnalytics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>quarks.analytics.math3.json.JsonAnalytics</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JsonAnalytics</span> |
| extends java.lang.Object</pre> |
| <div class="block">Apache Common Math analytics for streams with JSON tuples.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../quarks/analytics/math3/json/JsonAnalytics.html#JsonAnalytics--">JsonAnalytics</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <K extends com.google.gson.JsonElement><br><a href="../../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/analytics/math3/json/JsonAnalytics.html#aggregate-quarks.topology.TWindow-java.lang.String-java.lang.String-quarks.analytics.math3.json.JsonUnivariateAggregate...-">aggregate</a></span>(<a href="../../../../quarks/topology/TWindow.html" title="interface in quarks.topology">TWindow</a><com.google.gson.JsonObject,K> window, |
| java.lang.String resultPartitionProperty, |
| java.lang.String valueProperty, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</code> |
| <div class="block">Aggregate against a single <code>Numeric</code> variable contained in an JSON object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <K extends com.google.gson.JsonElement><br><a href="../../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/analytics/math3/json/JsonAnalytics.html#aggregate-quarks.topology.TWindow-java.lang.String-java.lang.String-quarks.function.ToDoubleFunction-quarks.analytics.math3.json.JsonUnivariateAggregate...-">aggregate</a></span>(<a href="../../../../quarks/topology/TWindow.html" title="interface in quarks.topology">TWindow</a><com.google.gson.JsonObject,K> window, |
| java.lang.String resultPartitionProperty, |
| java.lang.String resultProperty, |
| <a href="../../../../quarks/function/ToDoubleFunction.html" title="interface in quarks.function">ToDoubleFunction</a><com.google.gson.JsonObject> valueGetter, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</code> |
| <div class="block">Aggregate against a single <code>Numeric</code> variable contained in an JSON object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <K extends com.google.gson.JsonElement><br><a href="../../../../quarks/function/BiFunction.html" title="interface in quarks.function">BiFunction</a><java.util.List<com.google.gson.JsonObject>,K,com.google.gson.JsonObject></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/analytics/math3/json/JsonAnalytics.html#aggregateList-java.lang.String-java.lang.String-quarks.function.ToDoubleFunction-quarks.analytics.math3.json.JsonUnivariateAggregate...-">aggregateList</a></span>(java.lang.String resultPartitionProperty, |
| java.lang.String resultProperty, |
| <a href="../../../../quarks/function/ToDoubleFunction.html" title="interface in quarks.function">ToDoubleFunction</a><com.google.gson.JsonObject> valueGetter, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</code> |
| <div class="block">Create a Function that aggregates against a single <code>Numeric</code> |
| variable contained in an JSON object.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JsonAnalytics--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JsonAnalytics</h4> |
| <pre>public JsonAnalytics()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="aggregate-quarks.topology.TWindow-java.lang.String-java.lang.String-quarks.analytics.math3.json.JsonUnivariateAggregate...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aggregate</h4> |
| <pre>public static <K extends com.google.gson.JsonElement> <a href="../../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject> aggregate(<a href="../../../../quarks/topology/TWindow.html" title="interface in quarks.topology">TWindow</a><com.google.gson.JsonObject,K> window, |
| java.lang.String resultPartitionProperty, |
| java.lang.String valueProperty, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</pre> |
| <div class="block">Aggregate against a single <code>Numeric</code> variable contained in an JSON object. |
| |
| The returned stream contains a tuple for each execution performed against a window partition. |
| The tuple is a <code>JsonObject</code> containing: |
| <UL> |
| <LI> Partition key of type <code>K</code> as a property with key <code>resultPartitionProperty</code>. </LI> |
| <LI> Aggregation results as a <code>JsonObject</code> as a property with key <code>valueProperty</code>. |
| This results object contains the results of all aggregations defined by <code>aggregates</code> against |
| <code>double</code> property with key <code>valueProperty</code>. |
| <BR> |
| Each <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json"><code>JsonUnivariateAggregate</code></a> declares how it represents its aggregation in this result |
| object. |
| </LI> |
| </UL> |
| <P> |
| For example if the window contains these three tuples (pseudo JSON) for |
| partition 3: |
| <BR> |
| <code>{id=3,reading=2.0}, {id=3,reading=2.6}, {id=3,reading=1.8}</code> |
| <BR> |
| the resulting aggregation for the stream returned by: |
| <BR> |
| <code>aggregate(window, "id", "reading", Statistic.MIN, Statistic.MAX)</code> |
| <BR> |
| would contain this tuple with the maximum and minimum values in the <code>reading</code> |
| JSON object: |
| <BR> |
| <code>{id=3, reading={MIN=1.8, MAX=1.8}}</code> |
| </P></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - Partition type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>window</code> - Window to aggregate over.</dd> |
| <dd><code>resultPartitionProperty</code> - Property to store the partition key in tuples on the returned stream.</dd> |
| <dd><code>valueProperty</code> - JSON property containing the value to aggregate.</dd> |
| <dd><code>aggregates</code> - Which aggregations to be performed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Stream that will contain aggregations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="aggregate-quarks.topology.TWindow-java.lang.String-java.lang.String-quarks.function.ToDoubleFunction-quarks.analytics.math3.json.JsonUnivariateAggregate...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aggregate</h4> |
| <pre>public static <K extends com.google.gson.JsonElement> <a href="../../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject> aggregate(<a href="../../../../quarks/topology/TWindow.html" title="interface in quarks.topology">TWindow</a><com.google.gson.JsonObject,K> window, |
| java.lang.String resultPartitionProperty, |
| java.lang.String resultProperty, |
| <a href="../../../../quarks/function/ToDoubleFunction.html" title="interface in quarks.function">ToDoubleFunction</a><com.google.gson.JsonObject> valueGetter, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</pre> |
| <div class="block">Aggregate against a single <code>Numeric</code> variable contained in an JSON object. |
| |
| The returned stream contains a tuple for each execution performed against a window partition. |
| The tuple is a <code>JsonObject</code> containing: |
| <UL> |
| <LI> Partition key of type <code>K</code> as a property with key <code>resultPartitionProperty</code>. </LI> |
| <LI> Aggregation results as a <code>JsonObject</code> as a property with key <code>resultProperty</code>. |
| This results object contains the results of all aggregations defined by <code>aggregates</code> against |
| value returned by <code>valueGetter</code>. |
| <BR> |
| Each <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json"><code>JsonUnivariateAggregate</code></a> declares how it represents its aggregation in this result |
| object. |
| </LI> |
| </UL></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - Partition type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>window</code> - Window to aggregate over.</dd> |
| <dd><code>resultPartitionProperty</code> - Property to store the partition key in tuples on the returned stream.</dd> |
| <dd><code>resultProperty</code> - Property to store the aggregations in tuples on the returned stream.</dd> |
| <dd><code>valueGetter</code> - How to obtain the single variable from input tuples.</dd> |
| <dd><code>aggregates</code> - Which aggregations to be performed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Stream that will contain aggregations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="aggregateList-java.lang.String-java.lang.String-quarks.function.ToDoubleFunction-quarks.analytics.math3.json.JsonUnivariateAggregate...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>aggregateList</h4> |
| <pre>public static <K extends com.google.gson.JsonElement> <a href="../../../../quarks/function/BiFunction.html" title="interface in quarks.function">BiFunction</a><java.util.List<com.google.gson.JsonObject>,K,com.google.gson.JsonObject> aggregateList(java.lang.String resultPartitionProperty, |
| java.lang.String resultProperty, |
| <a href="../../../../quarks/function/ToDoubleFunction.html" title="interface in quarks.function">ToDoubleFunction</a><com.google.gson.JsonObject> valueGetter, |
| <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json">JsonUnivariateAggregate</a>... aggregates)</pre> |
| <div class="block">Create a Function that aggregates against a single <code>Numeric</code> |
| variable contained in an JSON object. |
| |
| Calling <code>apply(List<JsonObject>)</code> on the returned <code>BiFunction</code> |
| returns a <code>JsonObject</code> containing: |
| <UL> |
| <LI> Partition key of type <code>K</code> as a property with key <code>resultPartitionProperty</code>. </LI> |
| <LI> Aggregation results as a <code>JsonObject</code> as a property with key <code>valueProperty</code>. |
| This results object contains the results of all aggregations defined by <code>aggregates</code> |
| against the value returned by <code>valueGetter</code>. |
| <BR> |
| Each <a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json"><code>JsonUnivariateAggregate</code></a> declares how it represents its aggregation in this result |
| object. |
| </LI> |
| </UL> |
| <P> |
| For example if the list contains these three tuples (pseudo JSON) for |
| partition 3: |
| <BR> |
| <code>{id=3,reading=2.0}, {id=3,reading=2.6}, {id=3,reading=1.8}</code> |
| <BR> |
| the resulting aggregation for the JsonObject returned by: |
| <BR> |
| <code>aggregateList("id", "reading", Statistic.MIN, Statistic.MAX).apply(list, 3)</code> |
| <BR> |
| would be this tuple with the maximum and minimum values in the <code>reading</code> |
| JSON object: |
| <BR> |
| <code>{id=3, reading={MIN=1.8, MAX=1.8}}</code> |
| </P></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - Partition type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resultPartitionProperty</code> - Property to store the partition key in tuples on the returned stream.</dd> |
| <dd><code>resultProperty</code> - Property to store the aggregations in the returned JsonObject.</dd> |
| <dd><code>valueGetter</code> - How to obtain the single variable from input tuples.</dd> |
| <dd><code>aggregates</code> - Which aggregations to be performed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Function that performs the aggregations.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JsonAnalytics.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../quarks/analytics/math3/json/JsonUnivariateAggregate.html" title="interface in quarks.analytics.math3.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?quarks/analytics/math3/json/JsonAnalytics.html" target="_top">Frames</a></li> |
| <li><a href="JsonAnalytics.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p> |
| </body> |
| </html> |
