Repository: incubator-edgent-website Updated Branches: refs/heads/asf-site 116b42740 -> 4797e2dac
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/recipes/recipe_hello_edgent.html ---------------------------------------------------------------------- diff --git a/content/recipes/recipe_hello_edgent.html b/content/recipes/recipe_hello_edgent.html index 8521aec..6c85be0 100644 --- a/content/recipes/recipe_hello_edgent.html +++ b/content/recipes/recipe_hello_edgent.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span> @@ -632,7 +632,7 @@ $('#toc').on('click', 'a', function() { <a target="_blank" href="https://github.com/apache/incubator-edgent-website/blob/master/site/recipes/recipe_hello_edgent.md"; class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a> <p>Edgent's pure Java implementation is a powerful feature which allows it to be run on the majority of JVM-compatible systems. It also has the added benefit of enabling the developer to develop applications entirely within the Eclipse and IntelliJ ecosystems. For the purposes of this recipe, it will be assumed that the developer is using Eclipse. To begin the Hello Edgent recipe, create a new project and import the necessary libraries as outlined in the <a href="../docs/edgent-getting-started">Getting started guide</a>. Next, write the following template application:</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> @@ -644,7 +644,7 @@ $('#toc').on('click', 'a', function() { <h2 id="using-topology-strings">Using <code>Topology.strings()</code></h2> <p>The primary abstraction in Edgent is the <code>TStream</code>. A <em><code>TStream</code></em> represents the flow of data in an Edgent application; for example, the periodic floating point readings from a temperature sensor. The data items which are sent through a <code>TStream</code> are Java objects — in the "Hello Edgent!" example, we are sending two strings. There are a number of ways to create a <code>TStream</code>, and <code>Topology.strings()</code> is the simplest. The user specifies a number of strings which will be used as the stream's data items.</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> @@ -658,7 +658,7 @@ $('#toc').on('click', 'a', function() { <h2 id="printing-to-output">Printing to output</h2> <p><code>TStream.print()</code> can be used to print the data items of a stream to standard output by invoking the <code>toString()</code> method of each data item. In this case the data items are already strings, but in principle <code>TStream.print()</code> can be called on any stream, regardless of the datatype carried by the stream.</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> @@ -672,7 +672,7 @@ $('#toc').on('click', 'a', function() { <h2 id="submitting-the-application">Submitting the application</h2> <p>The only remaining step is to submit the application, which is performed by the <code>DirectProvider</code>. Submitting an Edgent application initializes the threads which execute the <code>Topology</code>, and begins processing its data sources.</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/recipes/recipe_parallel_analytics.html ---------------------------------------------------------------------- diff --git a/content/recipes/recipe_parallel_analytics.html b/content/recipes/recipe_parallel_analytics.html index d1c7109..e56d32a 100644 --- a/content/recipes/recipe_parallel_analytics.html +++ b/content/recipes/recipe_parallel_analytics.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span> @@ -678,7 +678,7 @@ stream -> split(width,splitter) -> |-> isolate(10) -> pipeline-ch1 - <p>Many pipelines don't care what channel they're being constructed for. While the pipeline function typically yields the same pipeline processing for each channel there is no requirement for it to do so.</p> <p>In this simple recipe the pipeline receives a <code>TStream<Double></code> as input and generates a <code>TStream<String></code> as output.</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">static</span> <span class="n">BiFunction</span><span class="o"><</span><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">>,</span> <span class="n">Integer</span><span class="o">,</span> <span class="n">TStream</span><span class="o"><</span><span class="n">String</span><span class="o">>></span> <span class="n">pipeline</span><span class="o">()</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">static</span> <span class="n">BiFunction</span><span class="o"><</span><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">>,</span> <span class="n">Integer</span><span class="o">,</span> <span class="n">TStream</span><span class="o"><</span><span class="n">String</span><span class="o">>></span> <span class="nf">pipeline</span><span class="o">()</span> <span class="o">{</span> <span class="c1">// a simple 4 stage pipeline simulating some amount of work by sleeping</span> <span class="k">return</span> <span class="o">(</span><span class="n">stream</span><span class="o">,</span> <span class="n">channel</span><span class="o">)</span> <span class="o">-></span> <span class="o">{</span> @@ -731,7 +731,7 @@ stream -> split(width,splitter) -> |-> isolate(10) -> pipeline-ch1 - <span class="cm">/** * Process several tuples in parallel in a replicated pipeline. */</span> - <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> + <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DevelopmentProvider</span><span class="o">();</span> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"development console url: "</span> @@ -764,7 +764,7 @@ stream -> split(width,splitter) -> |-> isolate(10) -> pipeline-ch1 - <span class="o">}</span> <span class="cm">/** Function to create analytic pipeline and add it to a stream */</span> - <span class="kd">private</span> <span class="kd">static</span> <span class="n">BiFunction</span><span class="o"><</span><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">>,</span><span class="n">Integer</span><span class="o">,</span><span class="n">TStream</span><span class="o"><</span><span class="n">String</span><span class="o">>></span> <span class="n">pipeline</span><span class="o">()</span> <span class="o">{</span> + <span class="kd">private</span> <span class="kd">static</span> <span class="n">BiFunction</span><span class="o"><</span><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">>,</span><span class="n">Integer</span><span class="o">,</span><span class="n">TStream</span><span class="o"><</span><span class="n">String</span><span class="o">>></span> <span class="nf">pipeline</span><span class="o">()</span> <span class="o">{</span> <span class="c1">// a simple 3 stage pipeline simulating some amount of work by sleeping</span> <span class="k">return</span> <span class="o">(</span><span class="n">stream</span><span class="o">,</span> <span class="n">channel</span><span class="o">)</span> <span class="o">-></span> <span class="o">{</span> @@ -778,11 +778,11 @@ stream -> split(width,splitter) -> |-> isolate(10) -> pipeline-ch1 - <span class="o">};</span> <span class="o">}</span> - <span class="kd">private</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">sleep</span><span class="o">(</span><span class="kt">long</span> <span class="n">period</span><span class="o">,</span> <span class="n">TimeUnit</span> <span class="n">unit</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">RuntimeException</span> <span class="o">{</span> + <span class="kd">private</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">sleep</span><span class="o">(</span><span class="kt">long</span> <span class="n">period</span><span class="o">,</span> <span class="n">TimeUnit</span> <span class="n">unit</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">RuntimeException</span> <span class="o">{</span> <span class="k">try</span> <span class="o">{</span> <span class="n">Thread</span><span class="o">.</span><span class="na">sleep</span><span class="o">(</span><span class="n">unit</span><span class="o">.</span><span class="na">toMillis</span><span class="o">(</span><span class="n">period</span><span class="o">));</span> <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">InterruptedException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span> - <span class="k">throw</span> <span class="k">new</span> <span class="n">RuntimeException</span><span class="o">(</span><span class="s">"Interrupted"</span><span class="o">,</span> <span class="n">e</span><span class="o">);</span> + <span class="k">throw</span> <span class="k">new</span> <span class="nf">RuntimeException</span><span class="o">(</span><span class="s">"Interrupted"</span><span class="o">,</span> <span class="n">e</span><span class="o">);</span> <span class="o">}</span> <span class="o">}</span> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/recipes/recipe_source_function.html ---------------------------------------------------------------------- diff --git a/content/recipes/recipe_source_function.html b/content/recipes/recipe_source_function.html index 9d9bf09..b5bc62e 100644 --- a/content/recipes/recipe_source_function.html +++ b/content/recipes/recipe_source_function.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span> @@ -638,7 +638,7 @@ $('#toc').on('click', 'a', function() { <div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b> Edgent's API provides convenience methods for performing HTTP requests. For the sake of example we are writing a HTTP data source manually, but in principle there are easier methods. </div> <p>One example of a custom data source could be retrieving the contents of a web page and printing each line to output. For example, the user could be querying the Yahoo Finance website for the most recent stock price data of Bank of America, Cabot Oil & Gas, and Freeport-McMoRan Inc.:</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> <span class="n">Topology</span> <span class="n">top</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span> @@ -652,7 +652,7 @@ $('#toc').on('click', 'a', function() { <span class="k">try</span> <span class="o">{</span> <span class="n">InputStream</span> <span class="n">is</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="na">openStream</span><span class="o">();</span> <span class="n">BufferedReader</span> <span class="n">br</span> <span class="o">=</span> <span class="k">new</span> <span class="n">BufferedReader</span><span class="o">(</span> - <span class="k">new</span> <span class="n">InputStreamReader</span><span class="o">(</span><span class="n">is</span><span class="o">));</span> + <span class="k">new</span> <span class="nf">InputStreamReader</span><span class="o">(</span><span class="n">is</span><span class="o">));</span> <span class="k">for</span><span class="o">(</span><span class="n">String</span> <span class="n">s</span> <span class="o">=</span> <span class="n">br</span><span class="o">.</span><span class="na">readLine</span><span class="o">();</span> <span class="n">s</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">;</span> <span class="n">s</span> <span class="o">=</span> <span class="n">br</span><span class="o">.</span><span class="na">readLine</span><span class="o">())</span> <span class="n">lines</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="n">s</span><span class="o">);</span> @@ -665,7 +665,7 @@ $('#toc').on('click', 'a', function() { <span class="o">}</span> </code></pre></div> <p>When invoking <code>Topology.source()</code>, we can use <code>queryWebsite</code> to return the required supplier, passing in the URL.</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> <span class="n">Topology</span> <span class="n">top</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span> @@ -684,7 +684,7 @@ $('#toc').on('click', 'a', function() { <h2 id="polling-source-reading-data-periodically">Polling source: reading data periodically</h2> <p>A much more common scenario for a developer is the periodic generation of data from a source operator — a data source may need to be polled every 5 seconds, 3 hours, or any time frame. To this end, <code>Topology</code> exposes the <code>poll()</code> method which can be used to call a function at the frequency of the user's choosing. For example, a user might want to query Yahoo Finance every two seconds to retrieve the most up to date ticker price for a stock:</p> -<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> <span class="n">Topology</span> <span class="n">top</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/recipes/recipe_value_out_of_range.html ---------------------------------------------------------------------- diff --git a/content/recipes/recipe_value_out_of_range.html b/content/recipes/recipe_value_out_of_range.html index d09edd9..ee7b3c9 100644 --- a/content/recipes/recipe_value_out_of_range.html +++ b/content/recipes/recipe_value_out_of_range.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span> @@ -660,7 +660,7 @@ $('#toc').on('click', 'a', function() { <span class="kd">static</span> <span class="kt">double</span> <span class="n">OPTIMAL_TEMP_HIGH</span> <span class="o">=</span> <span class="mf">91.0</span><span class="o">;</span> <span class="kd">static</span> <span class="n">Range</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">optimalTempRange</span> <span class="o">=</span> <span class="n">Ranges</span><span class="o">.</span><span class="na">closed</span><span class="o">(</span><span class="n">OPTIMAL_TEMP_LOW</span><span class="o">,</span> <span class="n">OPTIMAL_TEMP_HIGH</span><span class="o">);</span> - <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> + <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> @@ -783,7 +783,7 @@ Temperature may not be optimal! It is 77.5°F! * and a deadband filter to determine when the temperature * is out of the optimal range. */</span> - <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> + <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/titlepage.html ---------------------------------------------------------------------- diff --git a/content/titlepage.html b/content/titlepage.html index 0ac331b..5d5206f 100644 --- a/content/titlepage.html +++ b/content/titlepage.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4797e2da/content/tocpage.html ---------------------------------------------------------------------- diff --git a/content/tocpage.html b/content/tocpage.html index 2479044..d22606f 100644 --- a/content/tocpage.html +++ b/content/tocpage.html @@ -280,7 +280,7 @@ window.location.href = uri; <ul id="mysidebar" class="nav"> <span class="siteTagline">Edgent</span> - <span class="versionTagline">Version 0.3.0</span> + <span class="versionTagline">Version 1.0.0</span>
