http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cce166b7/bin/docs/org/apache/pirk/utils/GenerateCronItems.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/GenerateCronItems.html b/bin/docs/org/apache/pirk/utils/GenerateCronItems.html new file mode 100644 index 0000000..af18bd7 --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/GenerateCronItems.html @@ -0,0 +1,270 @@ +<!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 Jul 08 11:57:21 EDT 2016 --> +<title>GenerateCronItems</title> +<meta name="date" content="2016-07-08"> +<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="GenerateCronItems"; + } +//--> +</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/GenerateCronItems.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/utils/FileIOUtils.Callable.html" title="interface in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/HDFS.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/GenerateCronItems.html" target="_top">Frames</a></li> +<li><a href="GenerateCronItems.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.utils</div> +<h2 title="Class GenerateCronItems" class="title">Class GenerateCronItems</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.GenerateCronItems</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">GenerateCronItems</span> +extends java.lang.Object</pre> +<div class="block">Class that generates the cron scripts and crontab for the PIR algorithm + <p> + If add: + <p> + - Given a set of query vectors, creates a cron script to run the PIR with the specified parameters, and adds to the crontab with the given frequency + <p> + If delete: + <p> + - Given a crontab entry and current cron script, deletes it from the crontab file and from the cron script directory + <p> + - NOTE: This does not delete the actual query vectors from their location</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/utils/GenerateCronItems.html#GenerateCronItems()">GenerateCronItems</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 void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/GenerateCronItems.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</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="GenerateCronItems()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GenerateCronItems</h4> +<pre>public GenerateCronItems()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args) + throws java.io.IOException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/GenerateCronItems.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/utils/FileIOUtils.Callable.html" title="interface in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/HDFS.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/GenerateCronItems.html" target="_top">Frames</a></li> +<li><a href="GenerateCronItems.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/utils/HDFS.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/HDFS.html b/bin/docs/org/apache/pirk/utils/HDFS.html new file mode 100644 index 0000000..612ea2a --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/HDFS.html @@ -0,0 +1,431 @@ +<!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>HDFS</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="HDFS"; + } +//--> +</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/HDFS.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/utils/FileIOUtils.Callable.html" title="interface in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/ISO8601DateParser.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/HDFS.html" target="_top">Frames</a></li> +<li><a href="HDFS.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.utils</div> +<h2 title="Class HDFS" class="title">Class HDFS</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.HDFS</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">HDFS</span> +extends java.lang.Object</pre> +<div class="block">Class for basic HDFS fileIO utils</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/utils/HDFS.html#HDFS()">HDFS</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 void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#deletePath(org.apache.hadoop.fs.FileSystem,%20java.lang.String)">deletePath</a></strong>(org.apache.hadoop.fs.FileSystem fs, + java.lang.String filepath)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#findFileInDirectory(org.apache.hadoop.fs.FileSystem,%20java.lang.String,%20java.lang.String)">findFileInDirectory</a></strong>(org.apache.hadoop.fs.FileSystem fs, + java.lang.String directory, + java.lang.String startsWith)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.ArrayList<org.apache.hadoop.fs.Path></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#getFilesInDirectory(org.apache.hadoop.fs.FileSystem,%20java.lang.String)">getFilesInDirectory</a></strong>(org.apache.hadoop.fs.FileSystem fs, + java.lang.String directory)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.ArrayList<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#readFile(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.fs.Path)">readFile</a></strong>(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.ArrayList<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#readFile(org.apache.hadoop.fs.FileSystem,%20java.lang.String)">readFile</a></strong>(org.apache.hadoop.fs.FileSystem fs, + java.lang.String filepath)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.HashSet<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#readFileHashSet(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.fs.Path)">readFileHashSet</a></strong>(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#writeFile(java.util.Collection,%20org.apache.hadoop.fs.FileSystem,%20java.lang.String,%20boolean)">writeFile</a></strong>(java.util.Collection<java.lang.String> elements, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#writeFile(java.util.List,%20org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.fs.Path,%20boolean)">writeFile</a></strong>(java.util.List<java.math.BigInteger> elements, + org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path, + boolean deleteOnExit)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#writeFile(java.util.List,%20org.apache.hadoop.fs.FileSystem,%20java.lang.String,%20boolean)">writeFile</a></strong>(java.util.List<org.json.simple.JSONObject> elements, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#writeFile(java.util.Map,%20org.apache.hadoop.fs.FileSystem,%20java.lang.String,%20boolean)">writeFile</a></strong>(java.util.Map<java.lang.String,java.lang.Integer> sortedMap, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/HDFS.html#writeFileIntegers(java.util.List,%20org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.fs.Path,%20boolean)">writeFileIntegers</a></strong>(java.util.List<java.lang.Integer> elements, + org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path, + boolean deleteOnExit)</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="HDFS()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HDFS</h4> +<pre>public HDFS()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeFile(java.util.Collection, org.apache.hadoop.fs.FileSystem, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>public static void writeFile(java.util.Collection<java.lang.String> elements, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</pre> +</li> +</ul> +<a name="writeFile(java.util.List, org.apache.hadoop.fs.FileSystem, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>public static void writeFile(java.util.List<org.json.simple.JSONObject> elements, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</pre> +</li> +</ul> +<a name="writeFile(java.util.List, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>public static void writeFile(java.util.List<java.math.BigInteger> elements, + org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path, + boolean deleteOnExit)</pre> +</li> +</ul> +<a name="writeFile(java.util.Map, org.apache.hadoop.fs.FileSystem, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>public static void writeFile(java.util.Map<java.lang.String,java.lang.Integer> sortedMap, + org.apache.hadoop.fs.FileSystem fs, + java.lang.String path, + boolean deleteOnExit)</pre> +</li> +</ul> +<a name="readFile(org.apache.hadoop.fs.FileSystem, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFile</h4> +<pre>public static java.util.ArrayList<java.lang.String> readFile(org.apache.hadoop.fs.FileSystem fs, + java.lang.String filepath)</pre> +</li> +</ul> +<a name="readFile(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFile</h4> +<pre>public static java.util.ArrayList<java.lang.String> readFile(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path)</pre> +</li> +</ul> +<a name="readFileHashSet(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFileHashSet</h4> +<pre>public static java.util.HashSet<java.lang.String> readFileHashSet(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path)</pre> +</li> +</ul> +<a name="getFilesInDirectory(org.apache.hadoop.fs.FileSystem, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilesInDirectory</h4> +<pre>public static java.util.ArrayList<org.apache.hadoop.fs.Path> getFilesInDirectory(org.apache.hadoop.fs.FileSystem fs, + java.lang.String directory)</pre> +</li> +</ul> +<a name="findFileInDirectory(org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findFileInDirectory</h4> +<pre>public static org.apache.hadoop.fs.Path findFileInDirectory(org.apache.hadoop.fs.FileSystem fs, + java.lang.String directory, + java.lang.String startsWith)</pre> +</li> +</ul> +<a name="deletePath(org.apache.hadoop.fs.FileSystem, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deletePath</h4> +<pre>public static void deletePath(org.apache.hadoop.fs.FileSystem fs, + java.lang.String filepath)</pre> +</li> +</ul> +<a name="writeFileIntegers(java.util.List, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeFileIntegers</h4> +<pre>public static void writeFileIntegers(java.util.List<java.lang.Integer> elements, + org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path path, + boolean deleteOnExit)</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/HDFS.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/utils/FileIOUtils.Callable.html" title="interface in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/ISO8601DateParser.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/HDFS.html" target="_top">Frames</a></li> +<li><a href="HDFS.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/utils/ISO8601DateParser.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/ISO8601DateParser.html b/bin/docs/org/apache/pirk/utils/ISO8601DateParser.html new file mode 100644 index 0000000..21f0859 --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/ISO8601DateParser.html @@ -0,0 +1,302 @@ +<!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>ISO8601DateParser</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="ISO8601DateParser"; + } +//--> +</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/ISO8601DateParser.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/utils/HDFS.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/ISO8601DateParser.html" target="_top">Frames</a></li> +<li><a href="ISO8601DateParser.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.utils</div> +<h2 title="Class ISO8601DateParser" class="title">Class ISO8601DateParser</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.ISO8601DateParser</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ISO8601DateParser</span> +extends java.lang.Object</pre> +<div class="block">Class to parse a date in ISO86091 format</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/utils/ISO8601DateParser.html#ISO8601DateParser()">ISO8601DateParser</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.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/ISO8601DateParser.html#fromLongDate(long)">fromLongDate</a></strong>(long dateLongFormat)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/ISO8601DateParser.html#getDate(java.lang.String)">getDate</a></strong>(java.lang.String isoDate)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/ISO8601DateParser.html#getLongDate(java.lang.String)">getLongDate</a></strong>(java.lang.String isoDate)</code> </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/utils/ISO8601DateParser.html#parseDate(java.lang.String)">parseDate</a></strong>(java.lang.String date)</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="ISO8601DateParser()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ISO8601DateParser</h4> +<pre>public ISO8601DateParser()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="parseDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseDate</h4> +<pre>public static java.lang.String parseDate(java.lang.String date)</pre> +</li> +</ul> +<a name="getDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public static java.util.Date getDate(java.lang.String isoDate) + throws java.text.ParseException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.text.ParseException</code></dd></dl> +</li> +</ul> +<a name="getLongDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLongDate</h4> +<pre>public static long getLongDate(java.lang.String isoDate) + throws java.text.ParseException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.text.ParseException</code></dd></dl> +</li> +</ul> +<a name="fromLongDate(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromLongDate</h4> +<pre>public static java.lang.String fromLongDate(long dateLongFormat)</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/ISO8601DateParser.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/utils/HDFS.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/ISO8601DateParser.html" target="_top">Frames</a></li> +<li><a href="ISO8601DateParser.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/utils/KeyedHash.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/KeyedHash.html b/bin/docs/org/apache/pirk/utils/KeyedHash.html new file mode 100644 index 0000000..547bdfc --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/KeyedHash.html @@ -0,0 +1,288 @@ +<!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>KeyedHash</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="KeyedHash"; + } +//--> +</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/KeyedHash.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/utils/ISO8601DateParser.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/KeyedHash.html" target="_top">Frames</a></li> +<li><a href="KeyedHash.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.utils</div> +<h2 title="Class KeyedHash" class="title">Class KeyedHash</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.KeyedHash</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">KeyedHash</span> +extends java.lang.Object</pre> +<div class="block">Class for the PIR keyed hash + <p> + Defaults to java hashCode(); can optionally choose MD5, SHA-1, or SHA-256</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/utils/KeyedHash.html#KeyedHash()">KeyedHash</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 int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/KeyedHash.html#hash(java.lang.String,%20int,%20java.lang.String)">hash</a></strong>(java.lang.String key, + int bitSize, + java.lang.String input)</code> +<div class="block">Hash method that uses the java String hashCode()</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/KeyedHash.html#hash(java.lang.String,%20int,%20java.lang.String,%20java.lang.String)">hash</a></strong>(java.lang.String key, + int bitSize, + java.lang.String input, + java.lang.String hashType)</code> +<div class="block">Hash method to optionally specify a hash type other than the default java hashCode() hashType must be MD5, SHA-1, or SHA-256</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="KeyedHash()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyedHash</h4> +<pre>public KeyedHash()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="hash(java.lang.String, int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hash</h4> +<pre>public static int hash(java.lang.String key, + int bitSize, + java.lang.String input)</pre> +<div class="block">Hash method that uses the java String hashCode()</div> +</li> +</ul> +<a name="hash(java.lang.String, int, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hash</h4> +<pre>public static int hash(java.lang.String key, + int bitSize, + java.lang.String input, + java.lang.String hashType)</pre> +<div class="block">Hash method to optionally specify a hash type other than the default java hashCode() hashType must be MD5, SHA-1, or SHA-256</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/KeyedHash.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/utils/ISO8601DateParser.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/KeyedHash.html" target="_top">Frames</a></li> +<li><a href="KeyedHash.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/utils/LogUtils.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/LogUtils.html b/bin/docs/org/apache/pirk/utils/LogUtils.html new file mode 100644 index 0000000..3a9eb36 --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/LogUtils.html @@ -0,0 +1,378 @@ +<!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 Jul 08 11:57:21 EDT 2016 --> +<title>LogUtils</title> +<meta name="date" content="2016-07-08"> +<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="LogUtils"; + } +//--> +</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/LogUtils.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/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/LogUtils.html" target="_top">Frames</a></li> +<li><a href="LogUtils.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.utils</div> +<h2 title="Class LogUtils" class="title">Class LogUtils</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.LogUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LogUtils</span> +extends java.lang.Object</pre> +<div class="block">Class for basic logging utils</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.apache.log4j.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/LogUtils.html#logger">logger</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/utils/LogUtils.html#LogUtils()">LogUtils</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.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/LogUtils.html#entering()">entering</a></strong>()</code> </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/utils/LogUtils.html#entering(java.lang.String)">entering</a></strong>(java.lang.String methodName)</code> </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/utils/LogUtils.html#exiting()">exiting</a></strong>()</code> </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/utils/LogUtils.html#exiting(java.lang.String)">exiting</a></strong>(java.lang.String methodName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.apache.log4j.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/LogUtils.html#getLoggerForThisClass()">getLoggerForThisClass</a></strong>()</code> +<div class="block">Should be called at the from from each class using log4j.</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/utils/LogUtils.html#getNameForThisClass()">getNameForThisClass</a></strong>()</code> +<div class="block">Returns the name of the class calling this method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/LogUtils.html#initialize()">initialize</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="logger"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>logger</h4> +<pre>public static org.apache.log4j.Logger logger</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LogUtils()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LogUtils</h4> +<pre>public LogUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initialize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public static void initialize()</pre> +</li> +</ul> +<a name="getLoggerForThisClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoggerForThisClass</h4> +<pre>public static org.apache.log4j.Logger getLoggerForThisClass()</pre> +<div class="block">Should be called at the from from each class using log4j. Example: static private Logger logger = LogUtils.getLoggerForThisClass();</div> +<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="getNameForThisClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNameForThisClass</h4> +<pre>public static java.lang.String getNameForThisClass()</pre> +<div class="block">Returns the name of the class calling this method.</div> +</li> +</ul> +<a name="entering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entering</h4> +<pre>public static java.lang.String entering()</pre> +</li> +</ul> +<a name="exiting()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exiting</h4> +<pre>public static java.lang.String exiting()</pre> +</li> +</ul> +<a name="entering(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entering</h4> +<pre>public static java.lang.String entering(java.lang.String methodName)</pre> +</li> +</ul> +<a name="exiting(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exiting</h4> +<pre>public static java.lang.String exiting(java.lang.String methodName)</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/LogUtils.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/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/LogUtils.html" target="_top">Frames</a></li> +<li><a href="LogUtils.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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/utils/PIRException.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/PIRException.html b/bin/docs/org/apache/pirk/utils/PIRException.html new file mode 100644 index 0000000..72822a2 --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/PIRException.html @@ -0,0 +1,289 @@ +<!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>PIRException</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="PIRException"; + } +//--> +</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/PIRException.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/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/PIRException.html" target="_top">Frames</a></li> +<li><a href="PIRException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.utils</div> +<h2 title="Class PIRException" class="title">Class PIRException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.PIRException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PIRException</span> +extends java.lang.Exception</pre> +<div class="block">Custom exception for the PIR utilities</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.pirk.utils.PIRException">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/utils/PIRException.html#PIRException()">PIRException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/utils/PIRException.html#PIRException(java.lang.String)">PIRException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/utils/PIRException.html#PIRException(java.lang.String,%20java.lang.Throwable)">PIRException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/utils/PIRException.html#PIRException(java.lang.Throwable)">PIRException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, 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="PIRException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PIRException</h4> +<pre>public PIRException()</pre> +</li> +</ul> +<a name="PIRException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PIRException</h4> +<pre>public PIRException(java.lang.String message)</pre> +</li> +</ul> +<a name="PIRException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PIRException</h4> +<pre>public PIRException(java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PIRException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PIRException</h4> +<pre>public PIRException(java.lang.String message, + java.lang.Throwable cause)</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/PIRException.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/utils/KeyedHash.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/PIRException.html" target="_top">Frames</a></li> +<li><a href="PIRException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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/utils/QueryParserUtils.html ---------------------------------------------------------------------- diff --git a/bin/docs/org/apache/pirk/utils/QueryParserUtils.html b/bin/docs/org/apache/pirk/utils/QueryParserUtils.html new file mode 100644 index 0000000..da587d6 --- /dev/null +++ b/bin/docs/org/apache/pirk/utils/QueryParserUtils.html @@ -0,0 +1,353 @@ +<!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>QueryParserUtils</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="QueryParserUtils"; + } +//--> +</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/QueryParserUtils.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/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/StopListUtils.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/QueryParserUtils.html" target="_top">Frames</a></li> +<li><a href="QueryParserUtils.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.utils</div> +<h2 title="Class QueryParserUtils" class="title">Class QueryParserUtils</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.utils.QueryParserUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">QueryParserUtils</span> +extends java.lang.Object</pre> +<div class="block">Class used for URI query parsing + <p> + Query of the form @{code ?q=<queryField>:<queryTerm>} + <p> + TODO: Use Lucene's query parsing?... Make this lots lots better...</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/utils/QueryParserUtils.html#QueryParserUtils()">QueryParserUtils</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 boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRangeQuery(boolean,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20org.apache.pirk.schema.data.DataSchema)">checkRangeQuery</a></strong>(boolean inclusive, + java.lang.String field, + java.lang.String query, + java.lang.String value, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> +<div class="block">Method to handle ranges queries</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecord(java.lang.String,%20java.util.Map,%20org.apache.pirk.schema.data.DataSchema)">checkRecord</a></strong>(java.lang.String uriQuery, + java.util.Map<java.lang.String,java.lang.Object> doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecord(java.lang.String,%20org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">checkRecord</a></strong>(java.lang.String uriQuery, + org.apache.hadoop.io.MapWritable doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> +<div class="block">Given a URI query string, checks to see if the given document satisfies the query</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecordWritableArrayWritable(java.lang.String,%20org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">checkRecordWritableArrayWritable</a></strong>(java.lang.String uriQuery, + org.apache.hadoop.io.MapWritable doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> </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/utils/QueryParserUtils.html#wildcardToRegex(java.lang.String)">wildcardToRegex</a></strong>(java.lang.String wildcard)</code> +<div class="block">Method to convert a URI wildcard query into a java regex</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="QueryParserUtils()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryParserUtils</h4> +<pre>public QueryParserUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="checkRecord(java.lang.String, org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkRecord</h4> +<pre>public static boolean checkRecord(java.lang.String uriQuery, + org.apache.hadoop.io.MapWritable doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> +<div class="block">Given a URI query string, checks to see if the given document satisfies the query + <p> + ...Very hacky... + <p> + NOTE: Assumes that MapWritable keys are Text objects and values are Text or TextArrayWritable objects + <p> + NOTE: Support for list fields (values) is provided for checkRecord with Map<String, Object> and checkRecord with MapWritable containing + WritableArrayWritable types for array values (vs. json string list representation) + <p> + NOTE: @ symbol represents flag ignore case sensitivity used after field (e.g. user_agent@:*searchparam*) + <p> + NOTE: Assumes that all AND booleans come before any OR booleans - ADD @ case sensitivity support for range queries</div> +</li> +</ul> +<a name="checkRecord(java.lang.String, java.util.Map, org.apache.pirk.schema.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkRecord</h4> +<pre>public static boolean checkRecord(java.lang.String uriQuery, + java.util.Map<java.lang.String,java.lang.Object> doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> +</li> +</ul> +<a name="checkRecordWritableArrayWritable(java.lang.String, org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkRecordWritableArrayWritable</h4> +<pre>public static boolean checkRecordWritableArrayWritable(java.lang.String uriQuery, + org.apache.hadoop.io.MapWritable doc, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> +</li> +</ul> +<a name="checkRangeQuery(boolean, java.lang.String, java.lang.String, java.lang.String, org.apache.pirk.schema.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkRangeQuery</h4> +<pre>public static boolean checkRangeQuery(boolean inclusive, + java.lang.String field, + java.lang.String query, + java.lang.String value, + <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> +<div class="block">Method to handle ranges queries</div> +</li> +</ul> +<a name="wildcardToRegex(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wildcardToRegex</h4> +<pre>public static java.lang.String wildcardToRegex(java.lang.String wildcard)</pre> +<div class="block">Method to convert a URI wildcard query into a java regex</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/QueryParserUtils.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/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pirk/utils/StopListUtils.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/pirk/utils/QueryParserUtils.html" target="_top">Frames</a></li> +<li><a href="QueryParserUtils.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>