-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtutorial.html
258 lines (147 loc) · 13.3 KB
/
tutorial.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tutorial — MultiCategory 0.0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Data sets" href="data_sets.html" />
<link rel="prev" title="Install" href="install.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> MultiCategory
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#view-schema-and-instance-categories">View schema and instance categories</a></li>
<li class="toctree-l2"><a class="reference internal" href="#executing-queries">Executing queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="#categorical-view-of-query-and-fold-function">Categorical view of query and fold-function</a></li>
<li class="toctree-l2"><a class="reference internal" href="#query-processing-example">Query processing example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="data_sets.html">Data sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="theoretical_background.html">Theoretical background</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Lisence</a></li>
<li class="toctree-l1"><a class="reference internal" href="citing.html">Citing</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Bibliography</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MultiCategory</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Tutorial</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorial.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="tutorial">
<h1>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h1>
<p>MultiCategory is relatively simple to use thanks to the web interface. On the right side of the main view of the web interface, you can find the implemented data sets.</p>
<div class="section" id="view-schema-and-instance-categories">
<h2>View schema and instance categories<a class="headerlink" href="#view-schema-and-instance-categories" title="Permalink to this headline">¶</a></h2>
<p>For the selected data set you can click the buttons ‘’Schema category’’ and ‘’Instance category’’ to open the wanted category. The categories are drawn as D3js graphs.</p>
</div>
<div class="section" id="executing-queries">
<h2>Executing queries<a class="headerlink" href="#executing-queries" title="Permalink to this headline">¶</a></h2>
<p>Click the ‘’Examples’’ button that opens a collection of dropdown menus. Behind the dropdown menus, you will find various multi-model query examples. Choose an example that opens it in the input editor. You can modify the query if you wish and then execute
it by clicking the play button. Depending on the query the result should appear below the input field. The ‘’Result’’ button toggles the result.</p>
<p>In some property graphs nodes contain lots of information. If you want to view this information, you can click ‘’Contents of a node’’ that opens a field. If you now move the mouse over the nodes
you can study data inside the nodes. This applies to all the graphs.</p>
</div>
<div class="section" id="categorical-view-of-query-and-fold-function">
<h2>Categorical view of query and fold-function<a class="headerlink" href="#categorical-view-of-query-and-fold-function" title="Permalink to this headline">¶</a></h2>
<p>After executing a query, you can click ‘’Categorical view of query’’ that examines the query and draws it as a graph. This graph is a visualization of the sequence of the fold-functions. You can click the nodes that are related to the main fold-function (the largest nodes in the graph). After clicking these nodes, a new graph is drawn. This graph is a visualization of the inner structure of the clicked fold-function. If you want to view the corresponding fold-function, you
can click the ‘’Fold-function’’ button. You can also copy this function and execute it in the Haskell program that runs, for instance, in REPL.</p>
</div>
<div class="section" id="query-processing-example">
<h2>Query processing example<a class="headerlink" href="#query-processing-example" title="Permalink to this headline">¶</a></h2>
<p>For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">LET</span> <span class="n">t</span> <span class="n">BE</span>
<span class="n">QUERY</span> <span class="p">(</span>\<span class="n">x</span> <span class="o">-></span> <span class="k">if</span> <span class="n">customerName</span> <span class="n">x</span> <span class="o">==</span> <span class="s2">"Alice"</span> <span class="n">then</span> <span class="n">cons</span> <span class="n">x</span> <span class="k">else</span> <span class="n">nil</span><span class="p">)</span>
<span class="n">FROM</span> <span class="n">customers</span>
<span class="n">TO</span> <span class="n">relational</span>
<span class="n">IN</span>
<span class="n">QUERY</span> <span class="p">(</span>\<span class="n">x</span> <span class="o">-></span> <span class="k">if</span> <span class="nb">any</span> <span class="p">(</span>\<span class="n">y</span> <span class="o">-></span> <span class="n">knows</span> <span class="n">x</span> <span class="n">y</span> <span class="n">customers</span><span class="p">)</span> <span class="n">t</span> <span class="n">then</span> <span class="n">cons</span> <span class="n">x</span> <span class="k">else</span> <span class="n">nil</span><span class="p">)</span>
<span class="n">FROM</span> <span class="n">customers</span>
<span class="n">TO</span> <span class="n">algebraic</span> <span class="n">graph</span>
</pre></div>
</div>
<p>becomes a sequence of folds:</p>
<div class="highlight-Haskell notranslate"><div class="highlight"><pre><span></span><span class="kr">let</span> <span class="n">t</span> <span class="ow">=</span>
<span class="nf">foldg</span> <span class="kt">[]</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="ow">-></span> <span class="kr">if</span> <span class="n">customerName</span> <span class="n">x</span> <span class="o">==</span> <span class="s">"Alice"</span> <span class="kr">then</span> <span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="kr">else</span> <span class="kt">[]</span> <span class="p">)</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="n">y</span> <span class="ow">-></span> <span class="n">union</span> <span class="n">x</span> <span class="n">y</span> <span class="p">)</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="n">y</span> <span class="ow">-></span> <span class="n">union</span> <span class="n">x</span> <span class="n">y</span> <span class="p">)</span> <span class="n">customers</span>
<span class="kr">in</span>
<span class="nf">foldg</span> <span class="kt">Algebra</span><span class="o">.</span><span class="kt">Graph</span><span class="o">.</span><span class="n">empty</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="ow">-></span> <span class="kr">if</span> <span class="n">any</span> <span class="p">(</span> <span class="nf">\</span><span class="n">y</span> <span class="ow">-></span> <span class="n">knows</span> <span class="n">x</span> <span class="n">y</span> <span class="n">customers</span> <span class="p">)</span> <span class="n">t</span> <span class="kr">then</span> <span class="kt">Vertex</span> <span class="n">x</span> <span class="kr">else</span> <span class="kt">Algebra</span><span class="o">.</span><span class="kt">Graph</span><span class="o">.</span><span class="n">empty</span> <span class="p">)</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="n">y</span> <span class="ow">-></span> <span class="n">overlay</span> <span class="n">x</span> <span class="n">y</span> <span class="p">)</span> <span class="p">(</span><span class="nf">\</span><span class="n">x</span> <span class="n">y</span> <span class="ow">-></span> <span class="n">connect</span> <span class="n">x</span> <span class="n">y</span> <span class="p">)</span> <span class="n">customers</span>
</pre></div>
</div>
<p>The user does not need to know the <code class="docutils literal notranslate"><span class="pre">cons</span></code> and <code class="docutils literal notranslate"><span class="pre">nil</span></code> functions for the collections. The system can determine them based on the data sets and it knows how to use them in different combinations.
The user is also allowed to input multiple lambda functions. If the user does not provide a lambda function, then a certain initial setting is used.</p>
<p>Unfortunately, the system cannot know how the user wants to build richer structures from primitive structures. For example, if the user is querying a table to the graph, they need to define explicitly how data is organized in the output graph. On the other hand, if the user is querying graph to the table, then it suffices to use <code class="docutils literal notranslate"><span class="pre">cons</span></code> and <code class="docutils literal notranslate"><span class="pre">nil</span></code> functions and multiple lambda functions.</p>
<p>The program contains more examples that can be executed.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="data_sets.html" class="btn btn-neutral float-right" title="Data sets" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="install.html" class="btn btn-neutral float-left" title="Install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Valter Uotila
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>