| <!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 Aug 30 09:50:44 EDT 2016 --> |
| <title>QueryParserUtils</title> |
| <meta name="date" content="2016-08-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QueryParserUtils"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QueryParserUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/pirk/utils/QueryResultsWriter.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/pirk/utils/QueryParserUtils.html" target="_top">Frames</a></li> |
| <li><a href="QueryParserUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.pirk.utils</div> |
| <h2 title="Class QueryParserUtils" class="title">Class QueryParserUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.pirk.utils.QueryParserUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">QueryParserUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Class used for URI query parsing |
| <p> |
| Query of the form @{code ?q=<queryField>:<queryTerm>} |
| <p> |
| TODO: Use Lucene's query parsing?... Make this lots lots better...</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#QueryParserUtils()">QueryParserUtils</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRangeQuery(boolean,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20org.apache.pirk.schema.data.DataSchema)">checkRangeQuery</a></strong>(boolean inclusive, |
| java.lang.String field, |
| java.lang.String query, |
| java.lang.String value, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> |
| <div class="block">Method to handle ranges queries</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecord(java.lang.String,%20java.util.Map,%20org.apache.pirk.schema.data.DataSchema)">checkRecord</a></strong>(java.lang.String uriQuery, |
| java.util.Map<java.lang.String,java.lang.Object> doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecord(java.lang.String,%20org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">checkRecord</a></strong>(java.lang.String uriQuery, |
| org.apache.hadoop.io.MapWritable doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> |
| <div class="block">Given a URI query string, checks to see if the given document satisfies the query</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#checkRecordWritableArrayWritable(java.lang.String,%20org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">checkRecordWritableArrayWritable</a></strong>(java.lang.String uriQuery, |
| org.apache.hadoop.io.MapWritable doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/pirk/utils/QueryParserUtils.html#wildcardToRegex(java.lang.String)">wildcardToRegex</a></strong>(java.lang.String wildcard)</code> |
| <div class="block">Method to convert a URI wildcard query into a java regex</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="QueryParserUtils()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QueryParserUtils</h4> |
| <pre>public QueryParserUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="checkRecord(java.lang.String, org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.data.DataSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRecord</h4> |
| <pre>public static boolean checkRecord(java.lang.String uriQuery, |
| org.apache.hadoop.io.MapWritable doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> |
| <div class="block">Given a URI query string, checks to see if the given document satisfies the query |
| <p> |
| ...Very hacky... |
| <p> |
| NOTE: Assumes that MapWritable keys are Text objects and values are Text or TextArrayWritable objects |
| <p> |
| NOTE: Support for list fields (values) is provided for checkRecord with Map<String, Object> and checkRecord with MapWritable containing |
| WritableArrayWritable types for array values (vs. json string list representation) |
| <p> |
| NOTE: @ symbol represents flag ignore case sensitivity used after field (e.g. user_agent@:*searchparam*) |
| <p> |
| NOTE: Assumes that all AND booleans come before any OR booleans - ADD @ case sensitivity support for range queries</div> |
| </li> |
| </ul> |
| <a name="checkRecord(java.lang.String, java.util.Map, org.apache.pirk.schema.data.DataSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRecord</h4> |
| <pre>public static boolean checkRecord(java.lang.String uriQuery, |
| java.util.Map<java.lang.String,java.lang.Object> doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> |
| </li> |
| </ul> |
| <a name="checkRecordWritableArrayWritable(java.lang.String, org.apache.hadoop.io.MapWritable, org.apache.pirk.schema.data.DataSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRecordWritableArrayWritable</h4> |
| <pre>public static boolean checkRecordWritableArrayWritable(java.lang.String uriQuery, |
| org.apache.hadoop.io.MapWritable doc, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> |
| </li> |
| </ul> |
| <a name="checkRangeQuery(boolean, java.lang.String, java.lang.String, java.lang.String, org.apache.pirk.schema.data.DataSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRangeQuery</h4> |
| <pre>public static boolean checkRangeQuery(boolean inclusive, |
| java.lang.String field, |
| java.lang.String query, |
| java.lang.String value, |
| <a href="../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dataSchema)</pre> |
| <div class="block">Method to handle ranges queries</div> |
| </li> |
| </ul> |
| <a name="wildcardToRegex(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>wildcardToRegex</h4> |
| <pre>public static java.lang.String wildcardToRegex(java.lang.String wildcard)</pre> |
| <div class="block">Method to convert a URI wildcard query into a java regex</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QueryParserUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/pirk/utils/QueryResultsWriter.html" title="class in org.apache.pirk.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/pirk/utils/QueryParserUtils.html" target="_top">Frames</a></li> |
| <li><a href="QueryParserUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
