http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cce166b7/bin/docs/org/apache/pirk/querier/wideskies/package-use.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/querier/wideskies/package-use.html b/bin/docs/org/apache/pirk/querier/wideskies/package-use.html new file mode 100644 index 0000000..dc13c1e --- /dev/null +++ b/bin/docs/org/apache/pirk/querier/wideskies/package-use.html @@ -0,0 +1,171 @@ +<!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 (version 1.7.0_80) on Fri Aug 12 15:29:44 EDT 2016 --> +<title>Uses of Package org.apache.pirk.querier.wideskies</title> +<meta name="date" content="2016-08-12"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Package org.apache.pirk.querier.wideskies"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/querier/wideskies/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package org.apache.pirk.querier.wideskies" class="title">Uses of Package<br>org.apache.pirk.querier.wideskies</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../org/apache/pirk/querier/wideskies/package-summary.html">org.apache.pirk.querier.wideskies</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.pirk.querier.wideskies.decrypt">org.apache.pirk.querier.wideskies.decrypt</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.pirk.querier.wideskies.encrypt">org.apache.pirk.querier.wideskies.encrypt</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.querier.wideskies.decrypt"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/pirk/querier/wideskies/package-summary.html">org.apache.pirk.querier.wideskies</a> used by <a href="../../../../../org/apache/pirk/querier/wideskies/decrypt/package-summary.html">org.apache.pirk.querier.wideskies.decrypt</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/pirk/querier/wideskies/class-use/Querier.html#org.apache.pirk.querier.wideskies.decrypt">Querier</a> +<div class="block">Class to hold the information necessary for the PIR querier to perform decryption</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.querier.wideskies.encrypt"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/pirk/querier/wideskies/package-summary.html">org.apache.pirk.querier.wideskies</a> used by <a href="../../../../../org/apache/pirk/querier/wideskies/encrypt/package-summary.html">org.apache.pirk.querier.wideskies.encrypt</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/pirk/querier/wideskies/class-use/Querier.html#org.apache.pirk.querier.wideskies.encrypt">Querier</a> +<div class="block">Class to hold the information necessary for the PIR querier to perform decryption</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/querier/wideskies/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cce166b7/bin/docs/org/apache/pirk/query/wideskies/Query.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/query/wideskies/Query.html b/bin/docs/org/apache/pirk/query/wideskies/Query.html new file mode 100644 index 0000000..a42f314 --- /dev/null +++ b/bin/docs/org/apache/pirk/query/wideskies/Query.html @@ -0,0 +1,471 @@ +<!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 (version 1.7.0_80) on Fri Aug 12 15:29:43 EDT 2016 --> +<title>Query</title> +<meta name="date" content="2016-08-12"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Query"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Query.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-files/index-1.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="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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">org.apache.pirk.query.wideskies</div> +<h2 title="Class Query" class="title">Class Query</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.query.wideskies.Query</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Query</span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a></pre> +<div class="block">Class to hold the PIR query vectors</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.pirk.query.wideskies.Query">Serialized Form</a></dd></dl> +</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="overviewSummary" 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><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#Query(org.apache.pirk.query.wideskies.QueryInfo,%20java.math.BigInteger)">Query</a></strong>(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfoIn, + java.math.BigInteger NInput)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#addQueryElement(java.lang.Integer,%20java.math.BigInteger)">addQueryElement</a></strong>(java.lang.Integer index, + java.math.BigInteger element)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#addQueryElements(java.util.TreeMap)">addQueryElements</a></strong>(java.util.TreeMap<java.lang.Integer,java.math.BigInteger> elements)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#clearElements()">clearElements</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#containsElement(java.math.BigInteger)">containsElement</a></strong>(java.math.BigInteger element)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#generateExpTable(int)">generateExpTable</a></strong>(int numThreads)</code> +<div class="block">This should be called after all query elements have been added in order to generate the expTable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.math.BigInteger</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExp(java.math.BigInteger,%20int)">getExp</a></strong>(java.math.BigInteger value, + int power)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpFile(int)">getExpFile</a></strong>(int i)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.HashMap<java.lang.Integer,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpFileBasedLookup()">getExpFileBasedLookup</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.HashMap<java.math.BigInteger,java.util.HashMap<java.lang.Integer,java.math.BigInteger>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpTable()">getExpTable</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.math.BigInteger</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getN()">getN</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.math.BigInteger</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getNSquared()">getNSquared</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.math.BigInteger</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryElement(int)">getQueryElement</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.TreeMap<java.lang.Integer,java.math.BigInteger></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryElements()">getQueryElements</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryInfo()">getQueryInfo</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#setExpFileBasedLookup(java.util.HashMap)">setExpFileBasedLookup</a></strong>(java.util.HashMap<java.lang.Integer,java.lang.String> expInput)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#setExpTable(java.util.HashMap)">setExpTable</a></strong>(java.util.HashMap<java.math.BigInteger,java.util.HashMap<java.lang.Integer,java.math.BigInteger>> expTableInput)</code> </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>equals, 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="Query(org.apache.pirk.query.wideskies.QueryInfo, java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Query</h4> +<pre>public Query(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfoIn, + java.math.BigInteger NInput)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getQueryInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryInfo</h4> +<pre>public <a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> getQueryInfo()</pre> +</li> +</ul> +<a name="getQueryElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryElements</h4> +<pre>public java.util.TreeMap<java.lang.Integer,java.math.BigInteger> getQueryElements()</pre> +</li> +</ul> +<a name="getQueryElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryElement</h4> +<pre>public java.math.BigInteger getQueryElement(int index)</pre> +</li> +</ul> +<a name="getN()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getN</h4> +<pre>public java.math.BigInteger getN()</pre> +</li> +</ul> +<a name="getNSquared()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNSquared</h4> +<pre>public java.math.BigInteger getNSquared()</pre> +</li> +</ul> +<a name="getExpFileBasedLookup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExpFileBasedLookup</h4> +<pre>public java.util.HashMap<java.lang.Integer,java.lang.String> getExpFileBasedLookup()</pre> +</li> +</ul> +<a name="getExpFile(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExpFile</h4> +<pre>public java.lang.String getExpFile(int i)</pre> +</li> +</ul> +<a name="setExpFileBasedLookup(java.util.HashMap)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExpFileBasedLookup</h4> +<pre>public void setExpFileBasedLookup(java.util.HashMap<java.lang.Integer,java.lang.String> expInput)</pre> +</li> +</ul> +<a name="getExpTable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExpTable</h4> +<pre>public java.util.HashMap<java.math.BigInteger,java.util.HashMap<java.lang.Integer,java.math.BigInteger>> getExpTable()</pre> +</li> +</ul> +<a name="setExpTable(java.util.HashMap)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExpTable</h4> +<pre>public void setExpTable(java.util.HashMap<java.math.BigInteger,java.util.HashMap<java.lang.Integer,java.math.BigInteger>> expTableInput)</pre> +</li> +</ul> +<a name="addQueryElement(java.lang.Integer, java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addQueryElement</h4> +<pre>public void addQueryElement(java.lang.Integer index, + java.math.BigInteger element)</pre> +</li> +</ul> +<a name="addQueryElements(java.util.TreeMap)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addQueryElements</h4> +<pre>public void addQueryElements(java.util.TreeMap<java.lang.Integer,java.math.BigInteger> elements)</pre> +</li> +</ul> +<a name="containsElement(java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsElement</h4> +<pre>public boolean containsElement(java.math.BigInteger element)</pre> +</li> +</ul> +<a name="clearElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearElements</h4> +<pre>public void clearElements()</pre> +</li> +</ul> +<a name="generateExpTable(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generateExpTable</h4> +<pre>public void generateExpTable(int numThreads) + throws java.lang.InterruptedException</pre> +<div class="block">This should be called after all query elements have been added in order to generate the expTable. For int exponentiation with BigIntegers, assumes that + dataPartitionBitSize < 32.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code></dd></dl> +</li> +</ul> +<a name="getExp(java.math.BigInteger, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getExp</h4> +<pre>public java.math.BigInteger getExp(java.math.BigInteger value, + int power)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Query.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-files/index-1.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="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cce166b7/bin/docs/org/apache/pirk/query/wideskies/QueryInfo.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/query/wideskies/QueryInfo.html b/bin/docs/org/apache/pirk/query/wideskies/QueryInfo.html new file mode 100644 index 0000000..055f28a --- /dev/null +++ b/bin/docs/org/apache/pirk/query/wideskies/QueryInfo.html @@ -0,0 +1,494 @@ +<!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 (version 1.7.0_80) on Fri Aug 12 15:29:43 EDT 2016 --> +<title>QueryInfo</title> +<meta name="date" content="2016-08-12"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="QueryInfo"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/QueryInfo.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/pirk/query/wideskies/Query.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/QueryInfo.html" target="_top">Frames</a></li> +<li><a href="QueryInfo.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">org.apache.pirk.query.wideskies</div> +<h2 title="Class QueryInfo" class="title">Class QueryInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.query.wideskies.QueryInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Cloneable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryInfo</span> +extends java.lang.Object +implements java.io.Serializable, java.lang.Cloneable</pre> +<div class="block">Class to hold all of the basic information regarding a query + <p> + Note that the hash key is specific to the query. If we have hash collisions over our selector set, we will append integers to the key starting with 0 until + we no longer have collisions</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.pirk.query.wideskies.QueryInfo">Serialized Form</a></dd></dl> +</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="overviewSummary" 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><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#QueryInfo(int,%20int,%20java.lang.String,%20int,%20java.lang.String,%20boolean,%20boolean,%20boolean)">QueryInfo</a></strong>(int numSelectorsInput, + int hashBitSizeInput, + java.lang.String hashKeyInput, + int dataPartitionBitSizeInput, + java.lang.String queryTypeInput, + boolean useExpLookupTableInput, + boolean embedSelectorInput, + boolean useHDFSExpLookupTableInput)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#QueryInfo(java.util.UUID,%20int,%20int,%20java.lang.String,%20int,%20java.lang.String,%20boolean,%20boolean,%20boolean)">QueryInfo</a></strong>(java.util.UUID identifierInput, + int numSelectorsInput, + int hashBitSizeInput, + java.lang.String hashKeyInput, + int dataPartitionBitSizeInput, + java.lang.String queryTypeInput, + boolean useExpLookupTableInput, + boolean embedSelectorInput, + boolean useHDFSExpLookupTableInput)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#addQuerySchema(org.apache.pirk.schema.query.QuerySchema)">addQuerySchema</a></strong>(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchemaIn)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#clone()">clone</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getDataPartitionBitSize()">getDataPartitionBitSize</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getEmbedSelector()">getEmbedSelector</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getHashBitSize()">getHashBitSize</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getHashKey()">getHashKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.UUID</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getIdentifier()">getIdentifier</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getNumBitsPerDataElement()">getNumBitsPerDataElement</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getNumPartitionsPerDataElement()">getNumPartitionsPerDataElement</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getNumSelectors()">getNumSelectors</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getQuerySchema()">getQuerySchema</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getQueryType()">getQueryType</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getUseExpLookupTable()">getUseExpLookupTable</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getUseHDFSExpLookupTable()">getUseHDFSExpLookupTable</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#printQueryInfo()">printQueryInfo</a></strong>()</code> </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>equals, 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="QueryInfo(int, int, java.lang.String, int, java.lang.String, boolean, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>QueryInfo</h4> +<pre>public QueryInfo(int numSelectorsInput, + int hashBitSizeInput, + java.lang.String hashKeyInput, + int dataPartitionBitSizeInput, + java.lang.String queryTypeInput, + boolean useExpLookupTableInput, + boolean embedSelectorInput, + boolean useHDFSExpLookupTableInput)</pre> +</li> +</ul> +<a name="QueryInfo(java.util.UUID, int, int, java.lang.String, int, java.lang.String, boolean, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryInfo</h4> +<pre>public QueryInfo(java.util.UUID identifierInput, + int numSelectorsInput, + int hashBitSizeInput, + java.lang.String hashKeyInput, + int dataPartitionBitSizeInput, + java.lang.String queryTypeInput, + boolean useExpLookupTableInput, + boolean embedSelectorInput, + boolean useHDFSExpLookupTableInput)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getIdentifier()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentifier</h4> +<pre>public java.util.UUID getIdentifier()</pre> +</li> +</ul> +<a name="getQueryType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryType</h4> +<pre>public java.lang.String getQueryType()</pre> +</li> +</ul> +<a name="getNumSelectors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumSelectors</h4> +<pre>public int getNumSelectors()</pre> +</li> +</ul> +<a name="getHashBitSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashBitSize</h4> +<pre>public int getHashBitSize()</pre> +</li> +</ul> +<a name="getHashKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashKey</h4> +<pre>public java.lang.String getHashKey()</pre> +</li> +</ul> +<a name="getNumBitsPerDataElement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumBitsPerDataElement</h4> +<pre>public int getNumBitsPerDataElement()</pre> +</li> +</ul> +<a name="getNumPartitionsPerDataElement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumPartitionsPerDataElement</h4> +<pre>public int getNumPartitionsPerDataElement()</pre> +</li> +</ul> +<a name="getDataPartitionBitSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataPartitionBitSize</h4> +<pre>public int getDataPartitionBitSize()</pre> +</li> +</ul> +<a name="getUseExpLookupTable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUseExpLookupTable</h4> +<pre>public boolean getUseExpLookupTable()</pre> +</li> +</ul> +<a name="getUseHDFSExpLookupTable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUseHDFSExpLookupTable</h4> +<pre>public boolean getUseHDFSExpLookupTable()</pre> +</li> +</ul> +<a name="getEmbedSelector()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmbedSelector</h4> +<pre>public boolean getEmbedSelector()</pre> +</li> +</ul> +<a name="addQuerySchema(org.apache.pirk.schema.query.QuerySchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addQuerySchema</h4> +<pre>public void addQuerySchema(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchemaIn)</pre> +</li> +</ul> +<a name="getQuerySchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQuerySchema</h4> +<pre>public <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> getQuerySchema()</pre> +</li> +</ul> +<a name="printQueryInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printQueryInfo</h4> +<pre>public void printQueryInfo()</pre> +</li> +</ul> +<a name="clone()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>clone</h4> +<pre>public <a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> clone()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>clone</code> in class <code>java.lang.Object</code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/QueryInfo.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/pirk/query/wideskies/Query.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/QueryInfo.html" target="_top">Frames</a></li> +<li><a href="QueryInfo.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cce166b7/bin/docs/org/apache/pirk/query/wideskies/QueryUtils.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/query/wideskies/QueryUtils.html b/bin/docs/org/apache/pirk/query/wideskies/QueryUtils.html new file mode 100644 index 0000000..4105e18 --- /dev/null +++ b/bin/docs/org/apache/pirk/query/wideskies/QueryUtils.html @@ -0,0 +1,428 @@ +<!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 (version 1.7.0_80) on Fri Aug 12 15:29:43 EDT 2016 --> +<title>QueryUtils</title> +<meta name="date" content="2016-08-12"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="QueryUtils"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/QueryUtils.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/QueryUtils.html" target="_top">Frames</a></li> +<li><a href="QueryUtils.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">org.apache.pirk.query.wideskies</div> +<h2 title="Class QueryUtils" class="title">Class QueryUtils</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.query.wideskies.QueryUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">QueryUtils</span> +extends java.lang.Object</pre> +<div class="block">Class for helper methods to perform the encrypted query</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="overviewSummary" 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><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#QueryUtils()">QueryUtils</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.List<java.math.BigInteger></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#embeddedSelectorToPartitions(java.lang.String,%20java.lang.String,%20org.apache.pirk.schema.data.partitioner.DataPartitioner)">embeddedSelectorToPartitions</a></strong>(java.lang.String selector, + java.lang.String type, + <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> partitioner)</code> +<div class="block">Method to convert the given selector into the extracted BigInteger partitions</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/pirk/schema/response/QueryResponseJSON.html" title="class in org.apache.pirk.schema.response">QueryResponseJSON</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#extractQueryResponseJSON(org.apache.pirk.query.wideskies.QueryInfo,%20org.apache.pirk.schema.query.QuerySchema,%20java.util.ArrayList)">extractQueryResponseJSON</a></strong>(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfo, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + java.util.ArrayList<java.math.BigInteger> parts)</code> +<div class="block">Method to convert the given BigInteger raw data element partitions to a QueryResponseJSON object based upon the given queryType</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#getEmbeddedSelector(java.lang.String,%20java.lang.String,%20org.apache.pirk.schema.data.partitioner.DataPartitioner)">getEmbeddedSelector</a></strong>(java.lang.String selector, + java.lang.String type, + <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> partitioner)</code> +<div class="block">Method get the embedded selector from a given selector</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#getEmbeddedSelectorFromPartitions(java.util.ArrayList,%20int,%20java.lang.String,%20java.lang.Object)">getEmbeddedSelectorFromPartitions</a></strong>(java.util.ArrayList<java.math.BigInteger> parts, + int partsIndex, + java.lang.String type, + java.lang.Object partitioner)</code> +<div class="block">Reconstructs the String version of the embedded selector from its partitions</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#getSelectorByQueryType(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.query.QuerySchema,%20org.apache.pirk.schema.data.DataSchema)">getSelectorByQueryType</a></strong>(org.apache.hadoop.io.MapWritable dataMap, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema)</code> +<div class="block">Pulls the correct selector from the MapWritable data element given the queryType</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#getSelectorByQueryTypeJSON(org.apache.pirk.schema.query.QuerySchema,%20org.json.simple.JSONObject)">getSelectorByQueryTypeJSON</a></strong>(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + org.json.simple.JSONObject dataMap)</code> +<div class="block">Pulls the correct selector from the JSONObject data element given the queryType</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.ArrayList<java.math.BigInteger></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#partitionDataElement(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.query.QuerySchema,%20org.apache.pirk.schema.data.DataSchema,%20boolean)">partitionDataElement</a></strong>(org.apache.hadoop.io.MapWritable dataMap, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema, + boolean embedSelector)</code> +<div class="block">Method to convert the given data element given by the MapWritable data element into the extracted BigInteger partitions based upon the given queryType</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.ArrayList<java.math.BigInteger></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/QueryUtils.html#partitionDataElement(org.apache.pirk.schema.query.QuerySchema,%20org.json.simple.JSONObject,%20boolean)">partitionDataElement</a></strong>(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + org.json.simple.JSONObject jsonData, + boolean embedSelector)</code> +<div class="block">Method to convert the given data element given by the JSONObject data element into the extracted BigInteger partitions based upon the given queryType</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>equals, 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="QueryUtils()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryUtils</h4> +<pre>public QueryUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="extractQueryResponseJSON(org.apache.pirk.query.wideskies.QueryInfo, org.apache.pirk.schema.query.QuerySchema, java.util.ArrayList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extractQueryResponseJSON</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/response/QueryResponseJSON.html" title="class in org.apache.pirk.schema.response">QueryResponseJSON</a> extractQueryResponseJSON(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfo, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + java.util.ArrayList<java.math.BigInteger> parts) + throws java.lang.Exception</pre> +<div class="block">Method to convert the given BigInteger raw data element partitions to a QueryResponseJSON object based upon the given queryType</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="partitionDataElement(org.apache.pirk.schema.query.QuerySchema, org.json.simple.JSONObject, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionDataElement</h4> +<pre>public static java.util.ArrayList<java.math.BigInteger> partitionDataElement(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + org.json.simple.JSONObject jsonData, + boolean embedSelector) + throws java.lang.Exception</pre> +<div class="block">Method to convert the given data element given by the JSONObject data element into the extracted BigInteger partitions based upon the given queryType</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="partitionDataElement(org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.query.QuerySchema, org.apache.pirk.schema.data.DataSchema, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionDataElement</h4> +<pre>public static java.util.ArrayList<java.math.BigInteger> partitionDataElement(org.apache.hadoop.io.MapWritable dataMap, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema, + boolean embedSelector) + throws java.lang.Exception</pre> +<div class="block">Method to convert the given data element given by the MapWritable data element into the extracted BigInteger partitions based upon the given queryType</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="embeddedSelectorToPartitions(java.lang.String, java.lang.String, org.apache.pirk.schema.data.partitioner.DataPartitioner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>embeddedSelectorToPartitions</h4> +<pre>public static java.util.List<java.math.BigInteger> embeddedSelectorToPartitions(java.lang.String selector, + java.lang.String type, + <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> partitioner) + throws java.lang.Exception</pre> +<div class="block">Method to convert the given selector into the extracted BigInteger partitions</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="getEmbeddedSelector(java.lang.String, java.lang.String, org.apache.pirk.schema.data.partitioner.DataPartitioner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmbeddedSelector</h4> +<pre>public static java.lang.String getEmbeddedSelector(java.lang.String selector, + java.lang.String type, + <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> partitioner) + throws java.lang.Exception</pre> +<div class="block">Method get the embedded selector from a given selector</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="getEmbeddedSelectorFromPartitions(java.util.ArrayList, int, java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmbeddedSelectorFromPartitions</h4> +<pre>public static java.lang.String getEmbeddedSelectorFromPartitions(java.util.ArrayList<java.math.BigInteger> parts, + int partsIndex, + java.lang.String type, + java.lang.Object partitioner) + throws java.lang.Exception</pre> +<div class="block">Reconstructs the String version of the embedded selector from its partitions</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="getSelectorByQueryType(org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.query.QuerySchema, org.apache.pirk.schema.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSelectorByQueryType</h4> +<pre>public static java.lang.String getSelectorByQueryType(org.apache.hadoop.io.MapWritable dataMap, + <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema)</pre> +<div class="block">Pulls the correct selector from the MapWritable data element given the queryType + <p> + Pulls first element of array if element is an array type</div> +</li> +</ul> +<a name="getSelectorByQueryTypeJSON(org.apache.pirk.schema.query.QuerySchema, org.json.simple.JSONObject)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSelectorByQueryTypeJSON</h4> +<pre>public static java.lang.String getSelectorByQueryTypeJSON(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> qSchema, + org.json.simple.JSONObject dataMap)</pre> +<div class="block">Pulls the correct selector from the JSONObject data element given the queryType + <p> + Pulls first element of array if element is an array type</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/QueryUtils.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/QueryUtils.html" target="_top">Frames</a></li> +<li><a href="QueryUtils.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 ======= --> +</body> +</html>
