| <!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>QuerySchemaLoader</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="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: |
| |
| <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; just |
| as with the data schema, the element name is case sensitive</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> |
| <div class="block">Default constructor.</div> |
| </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> |
| <div class="block">Initializes the static <a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><code>QuerySchemaRegistry</code></a> with a list of query schema names.</div> |
| </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> |
| <div class="block">Initializes the static <a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><code>QuerySchemaRegistry</code></a> with a list of available query schema names.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/query/QuerySchemaLoader.html#loadSchema(java.io.InputStream)">loadSchema</a></strong>(java.io.InputStream stream)</code> |
| <div class="block">Returns the query schema as defined in XML format on the given stream.</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="QuerySchemaLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QuerySchemaLoader</h4> |
| <pre>public QuerySchemaLoader()</pre> |
| <div class="block">Default constructor.</div> |
| </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> |
| <div class="block">Initializes the static <a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><code>QuerySchemaRegistry</code></a> with a list of query schema names.</div> |
| <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> |
| <div class="block">Initializes the static <a href="../../../../../org/apache/pirk/schema/query/QuerySchemaRegistry.html" title="class in org.apache.pirk.schema.query"><code>QuerySchemaRegistry</code></a> with a list of available query schema names.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>hdfs</code> - If true, specifies that the query schema is an hdfs file; if false, that it is a regular file.</dd><dd><code>fs</code> - Used only when <code>hdfs</code> is true; the <code>FileSystem</code> handle for the hdfs in which the query schema exists</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd></dl> |
| </li> |
| </ul> |
| <a name="loadSchema(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>loadSchema</h4> |
| <pre>public <a href="../../../../../org/apache/pirk/schema/query/QuerySchema.html" title="class in org.apache.pirk.schema.query">QuerySchema</a> loadSchema(java.io.InputStream stream) |
| throws java.io.IOException, |
| <a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre> |
| <div class="block">Returns the query schema as defined in XML format on the given stream.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The source of the XML query schema description.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The query schema.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - A problem occurred reading from the given stream.</dd> |
| <dd><code><a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code> - The schema description is invalid.</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> |
