http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/7a339429/javadocs/test/org/apache/pirk/schema/data/partitioner/package-use.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/partitioner/package-use.html b/javadocs/test/org/apache/pirk/schema/data/partitioner/package-use.html new file mode 100644 index 0000000..d3c7e71 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/partitioner/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 Tue Jul 26 22:21:09 EDT 2016 --> +<title>Uses of Package org.apache.pirk.schema.data.partitioner</title> +<meta name="date" content="2016-07-26"> +<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.schema.data.partitioner"; + } +//--> +</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/schema/data/partitioner/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.schema.data.partitioner" class="title">Uses of Package<br>org.apache.pirk.schema.data.partitioner</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/schema/data/partitioner/package-summary.html">org.apache.pirk.schema.data.partitioner</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.schema.data">org.apache.pirk.schema.data</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.pirk.schema.data.partitioner">org.apache.pirk.schema.data.partitioner</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.schema.data"> +<!-- --> +</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/schema/data/partitioner/package-summary.html">org.apache.pirk.schema.data.partitioner</a> used by <a href="../../../../../../org/apache/pirk/schema/data/package-summary.html">org.apache.pirk.schema.data</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/schema/data/partitioner/class-use/DataPartitioner.html#org.apache.pirk.schema.data">DataPartitioner</a> +<div class="block">Interface for data partitioning</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.schema.data.partitioner"> +<!-- --> +</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/schema/data/partitioner/package-summary.html">org.apache.pirk.schema.data.partitioner</a> used by <a href="../../../../../../org/apache/pirk/schema/data/partitioner/package-summary.html">org.apache.pirk.schema.data.partitioner</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/schema/data/partitioner/class-use/DataPartitioner.html#org.apache.pirk.schema.data.partitioner">DataPartitioner</a> +<div class="block">Interface for data partitioning</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/schema/data/partitioner/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/7a339429/javadocs/test/org/apache/pirk/schema/query/LoadQuerySchemas.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/LoadQuerySchemas.html b/javadocs/test/org/apache/pirk/schema/query/LoadQuerySchemas.html new file mode 100644 index 0000000..e7b2a41 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/LoadQuerySchemas.html @@ -0,0 +1,379 @@ +<!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 Tue Jul 26 08:53:00 EDT 2016 --> +<title>LoadQuerySchemas</title> +<meta name="date" content="2016-07-26"> +<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="LoadQuerySchemas"; + } +//--> +</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/LoadQuerySchemas.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/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/LoadQuerySchemas.html" target="_top">Frames</a></li> +<li><a href="LoadQuerySchemas.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.schema.query</div> +<h2 title="Class LoadQuerySchemas" class="title">Class LoadQuerySchemas</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.query.LoadQuerySchemas</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LoadQuerySchemas</span> +extends java.lang.Object</pre> +<div class="block">Class to load any query schemas specified in the properties file, 'query.schemas' + <p> + Schemas should be specified as follows; all items are treated in a case insensitive manner: + + <pre> + <code><schema> + <schemaName> name of the schema </schemaName> + <dataSchemaName> name of the data schema over which this query is run </dataSchemaName> + <selectorName> name of the element in the data schema that will be the selector </selectorName> + <elements> + <name> element name of element in the data schema to include in the query response </name> + </elements> + <filter> (optional) name of the filter class to use to filter the data </filter> + <filterNames> (optional) + <name> element name of element in the data schema to apply pre-processing filters </name> + </filterNames> + </schema> + </code> + </pre> + <p> + TODO: Allow the schema to specify how many array elements to return per element, if the element is an array type</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/schema/query/LoadQuerySchemas.html#LoadQuerySchemas()">LoadQuerySchemas</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/schema/query/LoadQuerySchemas.html#containsSchema(java.lang.String)">containsSchema</a></strong>(java.lang.String schemaNameIn)</code> +<div class="block">Checks whether or not (true/false) the given schema is loaded</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/schema/query/LoadQuerySchemas.html#getSchema(java.lang.String)">getSchema</a></strong>(java.lang.String schemaName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.HashMap<java.lang.String,<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/schema/query/LoadQuerySchemas.html#getSchemaMap()">getSchemaMap</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html#getSchemaNames()">getSchemaNames</a></strong>()</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/schema/query/LoadQuerySchemas.html#getSchemasString()">getSchemasString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html#initialize()">initialize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html#initialize(boolean,%20org.apache.hadoop.fs.FileSystem)">initialize</a></strong>(boolean hdfs, + org.apache.hadoop.fs.FileSystem fs)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html#printSchemas()">printSchemas</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="LoadQuerySchemas()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LoadQuerySchemas</h4> +<pre>public LoadQuerySchemas()</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() + throws java.lang.Exception</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="initialize(boolean, org.apache.hadoop.fs.FileSystem)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public static void initialize(boolean hdfs, + org.apache.hadoop.fs.FileSystem fs) + throws java.lang.Exception</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="getSchemaMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchemaMap</h4> +<pre>public static java.util.HashMap<java.lang.String,<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a>> getSchemaMap()</pre> +</li> +</ul> +<a name="getSchemaNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchemaNames</h4> +<pre>public static java.util.Set<java.lang.String> getSchemaNames()</pre> +</li> +</ul> +<a name="getSchema(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchema</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> getSchema(java.lang.String schemaName)</pre> +</li> +</ul> +<a name="containsSchema(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsSchema</h4> +<pre>public static boolean containsSchema(java.lang.String schemaNameIn)</pre> +<div class="block">Checks whether or not (true/false) the given schema is loaded</div> +</li> +</ul> +<a name="printSchemas()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printSchemas</h4> +<pre>public static void printSchemas()</pre> +</li> +</ul> +<a name="getSchemasString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSchemasString</h4> +<pre>public static java.lang.String getSchemasString()</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/LoadQuerySchemas.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/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/LoadQuerySchemas.html" target="_top">Frames</a></li> +<li><a href="LoadQuerySchemas.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/7a339429/javadocs/test/org/apache/pirk/schema/query/QuerySchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/QuerySchema.html b/javadocs/test/org/apache/pirk/schema/query/QuerySchema.html new file mode 100644 index 0000000..102dca3 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/QuerySchema.html @@ -0,0 +1,358 @@ +<!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 Tue Jul 26 22:21:06 EDT 2016 --> +<title>QuerySchema</title> +<meta name="date" content="2016-07-26"> +<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="QuerySchema"; + } +//--> +</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/QuerySchema.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/schema/query/QuerySchemaLoader.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchema.html" target="_top">Frames</a></li> +<li><a href="QuerySchema.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.schema.query</div> +<h2 title="Class QuerySchema" class="title">Class QuerySchema</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.query.QuerySchema</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">QuerySchema</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">Class to hold a query schema</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.pirk.schema.query.QuerySchema">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getDataElementSize()">getDataElementSize</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/schema/query/QuerySchema.html#getDataSchemaName()">getDataSchemaName</a></strong>()</code> +<div class="block">Returns the name of the data schema.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getElementNames()">getElementNames</a></strong>()</code> +<div class="block">Returns the element names to include in the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/query/filter/DataFilter.html" title="interface in org.apache.pirk.schema.query.filter">DataFilter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the data element filter for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getFilteredElementNames()">getFilteredElementNames</a></strong>()</code> +<div class="block">Returns the set of element names on which to apply the filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getFilterTypeName()">getFilterTypeName</a></strong>()</code> +<div class="block">Returns the name of the filter class for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getSchemaName()">getSchemaName</a></strong>()</code> +<div class="block">Returns the name of this schema.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getSelectorName()">getSelectorName</a></strong>()</code> +<div class="block">Returns the element name used as the selector.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSchemaName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchemaName</h4> +<pre>public java.lang.String getSchemaName()</pre> +<div class="block">Returns the name of this schema.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The schema name.</dd></dl> +</li> +</ul> +<a name="getDataSchemaName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSchemaName</h4> +<pre>public java.lang.String getDataSchemaName()</pre> +<div class="block">Returns the name of the data schema. + <p> + This query is designed to be run over data described by this data schema.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The data schema name.</dd></dl> +</li> +</ul> +<a name="getElementNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getElementNames</h4> +<pre>public java.util.List<java.lang.String> getElementNames()</pre> +<div class="block">Returns the element names to include in the response. + <p> + The element names are defined by the data schema associated with this query.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The ordered list of query element names.</dd></dl> +</li> +</ul> +<a name="getSelectorName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSelectorName</h4> +<pre>public java.lang.String getSelectorName()</pre> +<div class="block">Returns the element name used as the selector. + <p> + The element names are defined by the data schema associated with this query.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The element names being selected.</dd></dl> +</li> +</ul> +<a name="getDataElementSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataElementSize</h4> +<pre>public int getDataElementSize()</pre> +</li> +</ul> +<a name="getFilterTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterTypeName</h4> +<pre>public java.lang.String getFilterTypeName()</pre> +<div class="block">Returns the name of the filter class for this query. + + The filter class name is the fully qualified name of a Java class that implements the <a href="../../../../../org/apache/pirk/schema/query/filter/DataFilter.html" title="interface in org.apache.pirk.schema.query.filter"><code>DataFilter</code></a> interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The type name of the query filter, or <code>null</code> if there is no filter defined.</dd></dl> +</li> +</ul> +<a name="getFilteredElementNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteredElementNames</h4> +<pre>public java.util.Set<java.lang.String> getFilteredElementNames()</pre> +<div class="block">Returns the set of element names on which to apply the filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The possibly empty set of data schema element names.</dd></dl> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../../org/apache/pirk/schema/query/filter/DataFilter.html" title="interface in org.apache.pirk.schema.query.filter">DataFilter</a> getFilter()</pre> +<div class="block">Returns the data element filter for this query. + <p> + The data filter is applied to the <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html#getFilteredElementNames()"><code>getFilteredElementNames()</code></a> data elements.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The data filter, or <code>null</code> if no filter has been specified for this query.</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/QuerySchema.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/schema/query/QuerySchemaLoader.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchema.html" target="_top">Frames</a></li> +<li><a href="QuerySchema.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/7a339429/javadocs/test/org/apache/pirk/schema/query/QuerySchemaLoader.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/QuerySchemaLoader.html b/javadocs/test/org/apache/pirk/schema/query/QuerySchemaLoader.html new file mode 100644 index 0000000..429a63b --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/QuerySchemaLoader.html @@ -0,0 +1,298 @@ +<!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 Tue Jul 26 22:21:06 EDT 2016 --> +<title>QuerySchemaLoader</title> +<meta name="date" content="2016-07-26"> +<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="QuerySchemaLoader"; + } +//--> +</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/QuerySchemaLoader.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/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchemaLoader.html" target="_top">Frames</a></li> +<li><a href="QuerySchemaLoader.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.schema.query</div> +<h2 title="Class QuerySchemaLoader" class="title">Class QuerySchemaLoader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.query.QuerySchemaLoader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">QuerySchemaLoader</span> +extends java.lang.Object</pre> +<div class="block">Class to load any query schemas specified in the properties file, 'query.schemas' + <p> + Schemas should be specified as follows; all items are treated in a case insensitive manner: + + <pre> + <code><schema> + <schemaName> name of the schema </schemaName> + <dataSchemaName> name of the data schema over which this query is run </dataSchemaName> + <selectorName> name of the element in the data schema that will be the selector </selectorName> + <elements> + <name> element name of element in the data schema to include in the query response </name> + </elements> + <filter> (optional) name of the filter class to use to filter the data </filter> + <filterNames> (optional) + <name> element name of element in the data schema to apply pre-processing filters </name> + </filterNames> + </schema> + </code> + </pre> + <p> + TODO: Allow the schema to specify how many array elements to return per element, if the element is an array type</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/schema/query/QuerySchemaLoader.html#QuerySchemaLoader()">QuerySchemaLoader</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/schema/query/QuerySchemaLoader.html#initialize()">initialize</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchemaLoader.html#initialize(boolean,%20org.apache.hadoop.fs.FileSystem)">initialize</a></strong>(boolean hdfs, + org.apache.hadoop.fs.FileSystem fs)</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="QuerySchemaLoader()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QuerySchemaLoader</h4> +<pre>public QuerySchemaLoader()</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() + throws java.lang.Exception</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="initialize(boolean, org.apache.hadoop.fs.FileSystem)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public static void initialize(boolean hdfs, + org.apache.hadoop.fs.FileSystem fs) + throws java.lang.Exception</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</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/QuerySchemaLoader.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/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchemaLoader.html" target="_top">Frames</a></li> +<li><a href="QuerySchemaLoader.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/7a339429/javadocs/test/org/apache/pirk/schema/query/QuerySchemaRegistry.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/QuerySchemaRegistry.html b/javadocs/test/org/apache/pirk/schema/query/QuerySchemaRegistry.html new file mode 100644 index 0000000..e152fd0 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/QuerySchemaRegistry.html @@ -0,0 +1,264 @@ +<!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 Tue Jul 26 22:21:06 EDT 2016 --> +<title>QuerySchemaRegistry</title> +<meta name="date" content="2016-07-26"> +<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="QuerySchemaRegistry"; + } +//--> +</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/QuerySchemaRegistry.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/schema/query/QuerySchemaLoader.html" title="class in org.apache.pirk.schema.query"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchemaRegistry.html" target="_top">Frames</a></li> +<li><a href="QuerySchemaRegistry.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.schema.query</div> +<h2 title="Class QuerySchemaRegistry" class="title">Class QuerySchemaRegistry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.query.QuerySchemaRegistry</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">QuerySchemaRegistry</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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 <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/schema/query/QuerySchemaRegistry.html#get(java.lang.String)">get</a></strong>(java.lang.String schemaName)</code> +<div class="block">Returns the query schema with the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html#getNames()">getNames</a></strong>()</code> +<div class="block">Returns the set of query schema names held in the registry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/schema/query/QuerySchemaRegistry.html#put(org.apache.pirk.schema.query.QuerySchema)">put</a></strong>(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> schema)</code> +<div class="block">Adds the given query schema to the registry.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="put(org.apache.pirk.schema.query.QuerySchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> put(<a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> schema)</pre> +<div class="block">Adds the given query schema to the registry. + + If there was an existing schema with the same name, it is replaced.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - The query schema to add.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the previous schema registered at the same name, or <code>null</code> if there were none.</dd></dl> +</li> +</ul> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> get(java.lang.String schemaName)</pre> +<div class="block">Returns the query schema with the given name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schemaName</code> - The query schema name to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The query schema, or <code>null</code> if no such schema.</dd></dl> +</li> +</ul> +<a name="getNames()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getNames</h4> +<pre>public static java.util.Set<java.lang.String> getNames()</pre> +<div class="block">Returns the set of query schema names held in the registry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The possibly empty set of query schema names.</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/QuerySchemaRegistry.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/schema/query/QuerySchemaLoader.html" title="class in org.apache.pirk.schema.query"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/query/QuerySchemaRegistry.html" target="_top">Frames</a></li> +<li><a href="QuerySchemaRegistry.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/7a339429/javadocs/test/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html b/javadocs/test/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html new file mode 100644 index 0000000..1e0bb02 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html @@ -0,0 +1,115 @@ +<!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 Tue Jul 26 08:53:03 EDT 2016 --> +<title>Uses of Class org.apache.pirk.schema.query.LoadQuerySchemas</title> +<meta name="date" content="2016-07-26"> +<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 Class org.apache.pirk.schema.query.LoadQuerySchemas"; + } +//--> +</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><a href="../../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html" title="class in org.apache.pirk.schema.query">Class</a></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/schema/query/class-use/LoadQuerySchemas.html" target="_top">Frames</a></li> +<li><a href="LoadQuerySchemas.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"> +<h2 title="Uses of Class org.apache.pirk.schema.query.LoadQuerySchemas" class="title">Uses of Class<br>org.apache.pirk.schema.query.LoadQuerySchemas</h2> +</div> +<div class="classUseContainer">No usage of org.apache.pirk.schema.query.LoadQuerySchemas</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><a href="../../../../../../org/apache/pirk/schema/query/LoadQuerySchemas.html" title="class in org.apache.pirk.schema.query">Class</a></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/schema/query/class-use/LoadQuerySchemas.html" target="_top">Frames</a></li> +<li><a href="LoadQuerySchemas.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/7a339429/javadocs/test/org/apache/pirk/schema/query/class-use/QuerySchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/query/class-use/QuerySchema.html b/javadocs/test/org/apache/pirk/schema/query/class-use/QuerySchema.html new file mode 100644 index 0000000..9129cae --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/query/class-use/QuerySchema.html @@ -0,0 +1,326 @@ +<!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 Tue Jul 26 22:21:09 EDT 2016 --> +<title>Uses of Class org.apache.pirk.schema.query.QuerySchema</title> +<meta name="date" content="2016-07-26"> +<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 Class org.apache.pirk.schema.query.QuerySchema"; + } +//--> +</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><a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">Class</a></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/schema/query/class-use/QuerySchema.html" target="_top">Frames</a></li> +<li><a href="QuerySchema.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"> +<h2 title="Uses of Class org.apache.pirk.schema.query.QuerySchema" class="title">Uses of Class<br>org.apache.pirk.schema.query.QuerySchema</h2> +</div> +<div class="classUseContainer"> +<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/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</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.query.wideskies">org.apache.pirk.query.wideskies</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.pirk.responder.wideskies.common">org.apache.pirk.responder.wideskies.common</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.pirk.responder.wideskies.spark">org.apache.pirk.responder.wideskies.spark</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.pirk.schema.query">org.apache.pirk.schema.query</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.pirk.query.wideskies"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> in <a href="../../../../../../org/apache/pirk/query/wideskies/package-summary.html">org.apache.pirk.query.wideskies</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/query/wideskies/package-summary.html">org.apache.pirk.query.wideskies</a> that return <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<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"><span class="strong">QueryInfo.</span><code><strong><a href="../../../../../../org/apache/pirk/query/wideskies/QueryInfo.html#getQuerySchema()">getQuerySchema</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/query/wideskies/package-summary.html">org.apache.pirk.query.wideskies</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">QueryInfo.</span><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>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"><span class="strong">QueryUtils.</span><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"><span class="strong">QueryUtils.</span><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"><span class="strong">QueryUtils.</span><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"><span class="strong">QueryUtils.</span><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"><span class="strong">QueryUtils.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.responder.wideskies.common"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> in <a href="../../../../../../org/apache/pirk/responder/wideskies/common/package-summary.html">org.apache.pirk.responder.wideskies.common</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/responder/wideskies/common/package-summary.html">org.apache.pirk.responder.wideskies.common</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static scala.Tuple2<java.lang.Integer,java.util.ArrayList<java.math.BigInteger>></code></td> +<td class="colLast"><span class="strong">HashSelectorAndPartitionData.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/common/HashSelectorAndPartitionData.html#hashSelectorAndFormPartitions(org.json.simple.JSONObject,%20org.apache.pirk.query.wideskies.QueryInfo,%20org.apache.pirk.schema.query.QuerySchema)">hashSelectorAndFormPartitions</a></strong>(org.json.simple.JSONObject json, + <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)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static scala.Tuple2<java.lang.Integer,<a href="../../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html" title="class in org.apache.pirk.inputformat.hadoop">BytesArrayWritable</a>></code></td> +<td class="colLast"><span class="strong">HashSelectorAndPartitionData.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/common/HashSelectorAndPartitionData.html#hashSelectorAndFormPartitions(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.query.QuerySchema,%20org.apache.pirk.schema.data.DataSchema,%20org.apache.pirk.query.wideskies.QueryInfo)">hashSelectorAndFormPartitions</a></strong>(org.apache.hadoop.io.MapWritable dataElement, + <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, + <a href="../../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static scala.Tuple2<java.lang.Integer,java.util.ArrayList<java.math.BigInteger>></code></td> +<td class="colLast"><span class="strong">HashSelectorAndPartitionData.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/common/HashSelectorAndPartitionData.html#hashSelectorAndFormPartitionsBigInteger(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.query.QuerySchema,%20org.apache.pirk.schema.data.DataSchema,%20org.apache.pirk.query.wideskies.QueryInfo)">hashSelectorAndFormPartitionsBigInteger</a></strong>(org.apache.hadoop.io.MapWritable dataElement, + <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, + <a href="../../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a> queryInfo)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.responder.wideskies.spark"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> in <a href="../../../../../../org/apache/pirk/responder/wideskies/spark/package-summary.html">org.apache.pirk.responder.wideskies.spark</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/responder/wideskies/spark/package-summary.html">org.apache.pirk.responder.wideskies.spark</a> that return <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<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"><span class="strong">BroadcastVars.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/spark/BroadcastVars.html#getQuerySchema()">getQuerySchema</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/responder/wideskies/spark/package-summary.html">org.apache.pirk.responder.wideskies.spark</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BroadcastVars.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/spark/BroadcastVars.html#setQuerySchema(org.apache.pirk.schema.query.QuerySchema)">setQuerySchema</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> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.schema.query"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> in <a href="../../../../../../org/apache/pirk/schema/query/package-summary.html">org.apache.pirk.schema.query</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/schema/query/package-summary.html">org.apache.pirk.schema.query</a> that return <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></code></td> +<td class="colLast"><span class="strong">QuerySchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html#get(java.lang.String)">get</a></strong>(java.lang.String schemaName)</code> +<div class="block">Returns the query schema with the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></code></td> +<td class="colLast"><span class="strong">QuerySchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html#put(org.apache.pirk.schema.query.QuerySchema)">put</a></strong>(<a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> schema)</code> +<div class="block">Adds the given query schema to the registry.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/pirk/schema/query/package-summary.html">org.apache.pirk.schema.query</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></code></td> +<td class="colLast"><span class="strong">QuerySchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html#put(org.apache.pirk.schema.query.QuerySchema)">put</a></strong>(<a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> schema)</code> +<div class="block">Adds the given query schema to the registry.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="../../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">Class</a></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/schema/query/class-use/QuerySchema.html" target="_top">Frames</a></li> +<li><a href="QuerySchema.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>
