docs/org/apache/pirk/schema/data/DataSchema.html - incubator-retired-pirk - Git at Google

 <!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 (1.8.0_102) on Mon Oct 03 08:48:18 EDT 2016 -->
 <title>DataSchema</title>
 <meta name="date" content="2016-10-03">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="DataSchema";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <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/DataSchema.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&nbsp;Class</li>
 <li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/pirk/schema/data/DataSchema.html" target="_top">Frames</a></li>
 <li><a href="DataSchema.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</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.data</div>
 <h2 title="Class DataSchema" class="title">Class DataSchema</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.pirk.schema.data.DataSchema</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="typeNameLabel">DataSchema</span>
 extends java.lang.Object
 implements java.io.Serializable</pre>
 <div class="block">A data schema describes the target data being referenced by a <code>Querier</code> and a <code>Responder</code>.
  <p>
  The schema comprises a number of elements, each of which has a name, type, and a partitioner. Elements may be declared as arrays of types.
  <p>
  Schemas are typically loaded from XML descriptors.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><code>DataSchemaLoader</code></a>,
 <a href="../../../../../serialized-form.html#org.apache.pirk.schema.data.DataSchema">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#containsElement-java.lang.String-">containsElement</a></span>(java.lang.String&nbsp;elementName)</code>
 <div class="block">Returns true if the data schema contains an element with the given name.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getArrayElements--">getArrayElements</a></span>()</code>
 <div class="block">Returns the element names that are declared as arrays.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getElementNames--">getElementNames</a></span>()</code>
 <div class="block">Returns the set of element names defined by this schema.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getElementType-java.lang.String-">getElementType</a></span>(java.lang.String&nbsp;elementName)</code>
 <div class="block">Returns the name of the Java type associated with the given element name.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getNonArrayElements--">getNonArrayElements</a></span>()</code>
 <div class="block">Returns the element names that are declared to not be arrays.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerForElement-java.lang.String-">getPartitionerForElement</a></span>(java.lang.String&nbsp;elementName)</code>
 <div class="block">Returns the partitioner instance for the given element name.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerInstance-java.lang.String-">getPartitionerInstance</a></span>(java.lang.String&nbsp;partitionerTypeName)</code>
 <div class="block">Returns the partitioner corresponding to the given partitioner class name.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerTypeName-java.lang.String-">getPartitionerTypeName</a></span>(java.lang.String&nbsp;elementName)</code>
 <div class="block">Returns the partitioner type name for a given element name.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getSchemaName--">getSchemaName</a></span>()</code>
 <div class="block">Returns the name of this schema.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>org.apache.hadoop.io.Text</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getTextName-java.lang.String-">getTextName</a></span>(java.lang.String&nbsp;elementName)</code>
 <div class="block">Returns the Hadoop text representation of a given element name.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#isArrayElement-java.lang.String-">isArrayElement</a></span>(java.lang.String&nbsp;element)</code>
 <div class="block">Returns true if the given element name is an array type.</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&nbsp;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="containsElement-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>containsElement</h4>
 <pre>public&nbsp;boolean&nbsp;containsElement(java.lang.String&nbsp;elementName)</pre>
 <div class="block">Returns true if the data schema contains an element with the given name.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>elementName</code> - The element name to check.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the schema does define an element with that name, of false otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="getElementNames--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getElementNames</h4>
 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getElementNames()</pre>
 <div class="block">Returns the set of element names defined by this schema.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The possibly empty set of element names.</dd>
 </dl>
 </li>
 </ul>
 <a name="getElementType-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getElementType</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getElementType(java.lang.String&nbsp;elementName)</pre>
 <div class="block">Returns the name of the Java type associated with the given element name.
  <p>
  The Java type is either a primitive type name, as defined in the <a href="../../../../../org/apache/pirk/schema/data/partitioner/PrimitiveTypePartitioner.html" title="class in org.apache.pirk.schema.data.partitioner"><code>PrimitiveTypePartitioner</code></a>, or a full canonical class name representing the element
  type.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>elementName</code> - The element name whose type is requested.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The type of the element, or <code>null</code> if the schema does not define the given element name.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../org/apache/pirk/schema/data/partitioner/PrimitiveTypePartitioner.html" title="class in org.apache.pirk.schema.data.partitioner"><code>PrimitiveTypePartitioner</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getArrayElements--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getArrayElements</h4>
 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getArrayElements()</pre>
 <div class="block">Returns the element names that are declared as arrays.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The set of names that are arrays, or an empty set if none.</dd>
 </dl>
 </li>
 </ul>
 <a name="getNonArrayElements--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getNonArrayElements</h4>
 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getNonArrayElements()</pre>
 <div class="block">Returns the element names that are declared to not be arrays.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The set of names that are not arrays, or an empty set if none.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPartitionerForElement-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPartitionerForElement</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a>&nbsp;getPartitionerForElement(java.lang.String&nbsp;elementName)
                                          throws <a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
 <div class="block">Returns the partitioner instance for the given element name.
  <p>
  A partitioner for the named type is created on first request, and the same partitioner is returned on subsequent calls.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>elementName</code> - the name of the element whose partitioner is required.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the data partitioner, or <code>null</code> if the element does not exist.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code> - if the partitioner cannot be instantiated.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerInstance-java.lang.String-"><code>getPartitionerInstance(String)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getPartitionerInstance-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPartitionerInstance</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a>&nbsp;getPartitionerInstance(java.lang.String&nbsp;partitionerTypeName)
                                        throws <a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
 <div class="block">Returns the partitioner corresponding to the given partitioner class name.
  <p>
  A partitioner for the named type is created on first request, and the same partitioner is returned on subsequent calls to this method.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>partitionerTypeName</code> - The class name for a partitioner type.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The partitioner instance of the requested type.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code> - If a problem occurs instantiating a new partitioner of the requested type.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPartitionerTypeName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPartitionerTypeName</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getPartitionerTypeName(java.lang.String&nbsp;elementName)</pre>
 <div class="block">Returns the partitioner type name for a given element name.
  <p>
  The partitioner type name is either that of the primitive partitioner, where the element name is a primitive type. For non-primitives it is the fully
  qualified name of a Java class that implements the <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner"><code>DataPartitioner</code></a> interface.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>elementName</code> - The element name whose partitioner type is requested.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The type name of the element's partitioner, or <code>null</code> if there is no element of that name.</dd>
 </dl>
 </li>
 </ul>
 <a name="getSchemaName--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSchemaName</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getSchemaName()</pre>
 <div class="block">Returns the name of this schema.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The schema name.</dd>
 </dl>
 </li>
 </ul>
 <a name="getTextName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTextName</h4>
 <pre>public&nbsp;org.apache.hadoop.io.Text&nbsp;getTextName(java.lang.String&nbsp;elementName)</pre>
 <div class="block">Returns the Hadoop text representation of a given element name.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>elementName</code> - The name of the element whose text representation is requested.</dd>
 </dl>
 </li>
 </ul>
 <a name="isArrayElement-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>isArrayElement</h4>
 <pre>public&nbsp;boolean&nbsp;isArrayElement(java.lang.String&nbsp;element)</pre>
 <div class="block">Returns true if the given element name is an array type.
  <p>
  The method returns <code>false</code> if the element is not an array type or the schema does not define an element of this type.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>element</code> - The name of the element to test.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the element is an array type, and <code>false</code> otherwise.</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>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <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/DataSchema.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&nbsp;Class</li>
 <li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/pirk/schema/data/DataSchema.html" target="_top">Frames</a></li>
 <li><a href="DataSchema.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>