| <!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>QuerySchema</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="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><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemaTest.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/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><a href="../../../../../org/apache/pirk/schema/query/LoadQuerySchemaTest.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/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> |