http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/7a339429/javadocs/test/org/apache/pirk/schema/data/DataSchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchema.html b/javadocs/test/org/apache/pirk/schema/data/DataSchema.html new file mode 100644 index 0000000..3ea81de --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/DataSchema.html @@ -0,0 +1,433 @@ +<!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:08 EDT 2016 --> +<title>DataSchema</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="DataSchema"; + } +//--> +</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/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 Class</li> +<li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><span class="strong">Next 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 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.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="strong">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="strong">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="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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#containsElement(java.lang.String)">containsElement</a></strong>(java.lang.String elementName)</code> +<div class="block">Returns true if the data schema contains an element with the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getArrayElements()">getArrayElements</a></strong>()</code> +<div class="block">Returns the element names that are declared as arrays.</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/data/DataSchema.html#getElementNames()">getElementNames</a></strong>()</code> +<div class="block">Returns the set of element names defined by 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/data/DataSchema.html#getElementType(java.lang.String)">getElementType</a></strong>(java.lang.String elementName)</code> +<div class="block">Returns the name of the Java type associated with the given element name.</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/data/DataSchema.html#getNonArrayElements()">getNonArrayElements</a></strong>()</code> +<div class="block">Returns the element names that are declared to not be arrays.</div> +</td> +</tr> +<tr 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><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerForElement(java.lang.String)">getPartitionerForElement</a></strong>(java.lang.String elementName)</code> +<div class="block">Returns the partitioner instance for the given element name.</div> +</td> +</tr> +<tr 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><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getPartitionerInstance(java.lang.String)">getPartitionerInstance</a></strong>(java.lang.String partitionerTypeName)</code> +<div class="block">Returns the partitioner corresponding to the given partitioner class name.</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/data/DataSchema.html#getPartitionerTypeName(java.lang.String)">getPartitionerTypeName</a></strong>(java.lang.String elementName)</code> +<div class="block">Returns the partitioner type name for a given element name.</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/data/DataSchema.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>org.apache.hadoop.io.Text</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#getTextName(java.lang.String)">getTextName</a></strong>(java.lang.String elementName)</code> +<div class="block">Returns the Hadoop text representation of a given element name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html#isArrayElement(java.lang.String)">isArrayElement</a></strong>(java.lang.String 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 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 boolean containsElement(java.lang.String elementName)</pre> +<div class="block">Returns true if the data schema contains an element with the given name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementName</code> - The element name to check.</dd> +<dt><span class="strong">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 java.util.Set<java.lang.String> getElementNames()</pre> +<div class="block">Returns the set of element names defined by this schema.</div> +<dl><dt><span class="strong">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 java.lang.String getElementType(java.lang.String 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="strong">Parameters:</span></dt><dd><code>elementName</code> - The element name whose type is requested.</dd> +<dt><span class="strong">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="strong">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 java.util.Set<java.lang.String> getArrayElements()</pre> +<div class="block">Returns the element names that are declared as arrays.</div> +<dl><dt><span class="strong">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 java.util.Set<java.lang.String> getNonArrayElements()</pre> +<div class="block">Returns the element names that are declared to not be arrays.</div> +<dl><dt><span class="strong">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 <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> getPartitionerForElement(java.lang.String 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="strong">Parameters:</span></dt><dd><code>elementName</code> - the name of the element whose partitioner is required.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the data partitioner, or <code>null</code> if the element does not exist.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>PIRExcpetion</code> - if the partitioner cannot be instantiated.</dd> +<dd><code><a href="../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd><dt><span class="strong">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 <a href="../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html" title="interface in org.apache.pirk.schema.data.partitioner">DataPartitioner</a> getPartitionerInstance(java.lang.String 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="strong">Parameters:</span></dt><dd><code>partitionerTypeName</code> - The class name for a partitioner type.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The partitioner instance of the requested type.</dd> +<dt><span class="strong">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 java.lang.String getPartitionerTypeName(java.lang.String 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="strong">Parameters:</span></dt><dd><code>elementName</code> - The element name whose partitioner type is requested.</dd> +<dt><span class="strong">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 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="getTextName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTextName</h4> +<pre>public org.apache.hadoop.io.Text getTextName(java.lang.String elementName)</pre> +<div class="block">Returns the Hadoop text representation of a given element name.</div> +<dl><dt><span class="strong">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 boolean isArrayElement(java.lang.String 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="strong">Parameters:</span></dt><dd><code>element</code> - The name of the element to test.</dd> +<dt><span class="strong">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><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/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 Class</li> +<li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><span class="strong">Next 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 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/data/DataSchemaLoader.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html b/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html new file mode 100644 index 0000000..fa539d3 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html @@ -0,0 +1,325 @@ +<!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:08 EDT 2016 --> +<title>DataSchemaLoader</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="DataSchemaLoader"; + } +//--> +</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/DataSchemaLoader.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/data/DataSchema.html" title="class in org.apache.pirk.schema.data"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html" title="class in org.apache.pirk.schema.data"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/data/DataSchemaLoader.html" target="_top">Frames</a></li> +<li><a href="DataSchemaLoader.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.data</div> +<h2 title="Class DataSchemaLoader" class="title">Class DataSchemaLoader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.data.DataSchemaLoader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataSchemaLoader</span> +extends java.lang.Object</pre> +<div class="block">Class to load any data schemas specified in the properties file, 'data.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> + <element> + <name> element name /name> + <type> class name or type name (if Java primitive type) of the element </type> + <isArray> true or false -- whether or not the schema element is an array within the data </isArray> + <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> + </element> + </schema> + </code> + </pre> + + Primitive types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string" + <p></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/data/DataSchemaLoader.html#DataSchemaLoader()">DataSchemaLoader</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/data/DataSchemaLoader.html#initialize()">initialize</a></strong>()</code> +<div class="block">Kept for compatibility</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/data/DataSchemaLoader.html#initialize(boolean,%20org.apache.hadoop.fs.FileSystem)">initialize</a></strong>(boolean hdfs, + org.apache.hadoop.fs.FileSystem fs)</code> +<div class="block">Kept for compatibility</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html#loadSchema(java.io.InputStream)">loadSchema</a></strong>(java.io.InputStream stream)</code> +<div class="block">Returns the data 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="DataSchemaLoader()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataSchemaLoader</h4> +<pre>public DataSchemaLoader()</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> +<div class="block">Kept for compatibility</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">Kept for compatibility</div> +<dl><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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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 data 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 data schema description.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The data 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/DataSchemaLoader.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/data/DataSchema.html" title="class in org.apache.pirk.schema.data"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html" title="class in org.apache.pirk.schema.data"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/pirk/schema/data/DataSchemaLoader.html" target="_top">Frames</a></li> +<li><a href="DataSchemaLoader.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/data/DataSchemaRegistry.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html b/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html new file mode 100644 index 0000000..403b2b6 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html @@ -0,0 +1,267 @@ +<!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:08 EDT 2016 --> +<title>DataSchemaRegistry</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="DataSchemaRegistry"; + } +//--> +</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/DataSchemaRegistry.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/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><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/data/DataSchemaRegistry.html" target="_top">Frames</a></li> +<li><a href="DataSchemaRegistry.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.data</div> +<h2 title="Class DataSchemaRegistry" class="title">Class DataSchemaRegistry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.data.DataSchemaRegistry</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataSchemaRegistry</span> +extends java.lang.Object</pre> +<div class="block">The data schema registry is a global location for data schema descriptors.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data"><code>DataSchema</code></a>, +<a href="../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><code>DataSchemaLoader</code></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>static <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html#get(java.lang.String)">get</a></strong>(java.lang.String schemaName)</code> +<div class="block">Returns the data 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/data/DataSchemaRegistry.html#getNames()">getNames</a></strong>()</code> +<div class="block">Returns the set of data schema names held in the registry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html#put(org.apache.pirk.schema.data.DataSchema)">put</a></strong>(<a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> schema)</code> +<div class="block">Adds the given data 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.data.DataSchema)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> put(<a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> schema)</pre> +<div class="block">Adds the given data 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 data 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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> get(java.lang.String schemaName)</pre> +<div class="block">Returns the data schema with the given name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schemaName</code> - The data schema name to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The data 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 data schema names held in the registry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The possibly empty set of data 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/DataSchemaRegistry.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/data/DataSchemaLoader.html" title="class in org.apache.pirk.schema.data"><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/data/DataSchemaRegistry.html" target="_top">Frames</a></li> +<li><a href="DataSchemaRegistry.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/data/LoadDataSchemas.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html b/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html new file mode 100644 index 0000000..99649fe --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html @@ -0,0 +1,335 @@ +<!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 Sun Jul 24 11:37:26 EDT 2016 --> +<title>LoadDataSchemas</title> +<meta name="date" content="2016-07-24"> +<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="LoadDataSchemas"; + } +//--> +</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/LoadDataSchemas.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/data/DataSchema.html" title="class in org.apache.pirk.schema.data"><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/data/LoadDataSchemas.html" target="_top">Frames</a></li> +<li><a href="LoadDataSchemas.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.data</div> +<h2 title="Class LoadDataSchemas" class="title">Class LoadDataSchemas</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pirk.schema.data.LoadDataSchemas</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LoadDataSchemas</span> +extends java.lang.Object</pre> +<div class="block">Class to load any data schemas specified in the properties file, 'data.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> + <element> + <name> element name /name> + <type> class name or type name (if Java primitive type) of the element </type> + <isArray> true or false -- whether or not the schema element is an array within the data </isArray> + <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> + </element> + </schema> + </code> + </pre> + + Primitive types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string" + <p></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/data/LoadDataSchemas.html#LoadDataSchemas()">LoadDataSchemas</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 <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/LoadDataSchemas.html#getSchema(java.lang.String)">getSchema</a></strong>(java.lang.String schemaName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.HashMap<java.lang.String,<a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/LoadDataSchemas.html#getSchemaMap()">getSchemaMap</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/schema/data/LoadDataSchemas.html#getSchemaNames()">getSchemaNames</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/data/LoadDataSchemas.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/data/LoadDataSchemas.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="LoadDataSchemas()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LoadDataSchemas</h4> +<pre>public LoadDataSchemas()</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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="blockListLast"> +<li class="blockList"> +<h4>getSchema</h4> +<pre>public static <a href="../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> getSchema(java.lang.String schemaName)</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/LoadDataSchemas.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/data/DataSchema.html" title="class in org.apache.pirk.schema.data"><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/data/LoadDataSchemas.html" target="_top">Frames</a></li> +<li><a href="LoadDataSchemas.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/data/class-use/DataSchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html b/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html new file mode 100644 index 0000000..e5dd575 --- /dev/null +++ b/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html @@ -0,0 +1,385 @@ +<!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.data.DataSchema</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.data.DataSchema"; + } +//--> +</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">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/data/class-use/DataSchema.html" target="_top">Frames</a></li> +<li><a href="DataSchema.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.data.DataSchema" class="title">Uses of Class<br>org.apache.pirk.schema.data.DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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.data">org.apache.pirk.schema.data</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.pirk.schema.query.filter">org.apache.pirk.schema.query.filter</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.pirk.utils">org.apache.pirk.utils</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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> with parameters of type <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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 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.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> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.responder.wideskies.common"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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,<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="rowColor"> +<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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><span class="strong">BroadcastVars.</span><code><strong><a href="../../../../../../org/apache/pirk/responder/wideskies/spark/BroadcastVars.html#getDataSchema()">getDataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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#setDataSchema(org.apache.pirk.schema.data.DataSchema)">setDataSchema</a></strong>(<a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchemaIn)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.schema.data"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> in <a href="../../../../../../org/apache/pirk/schema/data/package-summary.html">org.apache.pirk.schema.data</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/data/package-summary.html">org.apache.pirk.schema.data</a> that return <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><span class="strong">DataSchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html#get(java.lang.String)">get</a></strong>(java.lang.String schemaName)</code> +<div class="block">Returns the data schema with the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><span class="strong">DataSchemaLoader.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/data/DataSchemaLoader.html#loadSchema(java.io.InputStream)">loadSchema</a></strong>(java.io.InputStream stream)</code> +<div class="block">Returns the data schema as defined in XML format on the given stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><span class="strong">DataSchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html#put(org.apache.pirk.schema.data.DataSchema)">put</a></strong>(<a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> schema)</code> +<div class="block">Adds the given data 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/data/package-summary.html">org.apache.pirk.schema.data</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a></code></td> +<td class="colLast"><span class="strong">DataSchemaRegistry.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/data/DataSchemaRegistry.html#put(org.apache.pirk.schema.data.DataSchema)">put</a></strong>(<a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> schema)</code> +<div class="block">Adds the given data schema to the registry.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.schema.query.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> in <a href="../../../../../../org/apache/pirk/schema/query/filter/package-summary.html">org.apache.pirk.schema.query.filter</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/filter/package-summary.html">org.apache.pirk.schema.query.filter</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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>boolean</code></td> +<td class="colLast"><span class="strong">StopListFilter.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/query/filter/StopListFilter.html#filterDataElement(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">filterDataElement</a></strong>(org.apache.hadoop.io.MapWritable dataElement, + <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DataFilter.</span><code><strong><a href="../../../../../../org/apache/pirk/schema/query/filter/DataFilter.html#filterDataElement(org.apache.hadoop.io.MapWritable,%20org.apache.pirk.schema.data.DataSchema)">filterDataElement</a></strong>(org.apache.hadoop.io.MapWritable dataElement, + <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> dSchema)</code> +<div class="block">Filter the data element</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.pirk.utils"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</a> in <a href="../../../../../../org/apache/pirk/utils/package-summary.html">org.apache.pirk.utils</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/utils/package-summary.html">org.apache.pirk.utils</a> with parameters of type <a href="../../../../../../org/apache/pirk/schema/data/DataSchema.html" title="class in org.apache.pirk.schema.data">DataSchema</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 boolean</code></td> +<td class="colLast"><span class="strong">QueryParserUtils.</span><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"><span class="strong">QueryParserUtils.</span><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"><span class="strong">QueryParserUtils.</span><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"><span class="strong">QueryParserUtils.</span><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.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><span class="strong">StringUtils.</span><code><strong><a href="../../../../../../org/apache/pirk/utils/StringUtils.html#jsonStringToMap(java.lang.String,%20org.apache.pirk.schema.data.DataSchema)">jsonStringToMap</a></strong>(java.lang.String jsonString, + <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 take an input json string and output a Map<String, Object> with arrays as ArrayList<String> objects and single values as String objects</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.apache.hadoop.io.MapWritable</code></td> +<td class="colLast"><span class="strong">StringUtils.</span><code><strong><a href="../../../../../../org/apache/pirk/utils/StringUtils.html#jsonStringToMapWritableWithArrayWritable(java.lang.String,%20org.apache.pirk.schema.data.DataSchema)">jsonStringToMapWritableWithArrayWritable</a></strong>(java.lang.String jsonString, + <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 take an input json string and output a MapWritable with arrays as WritableArrayWritable objects</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.apache.hadoop.io.MapWritable</code></td> +<td class="colLast"><span class="strong">StringUtils.</span><code><strong><a href="../../../../../../org/apache/pirk/utils/StringUtils.html#jsonStringToMapWritableWithWritableArrayWritable(java.lang.String,%20org.apache.pirk.schema.data.DataSchema)">jsonStringToMapWritableWithWritableArrayWritable</a></strong>(java.lang.String jsonString, + <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 take an input json string and output a MapWritable with arrays as WritableArrayWritable objects</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/data/DataSchema.html" title="class in org.apache.pirk.schema.data">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/data/class-use/DataSchema.html" target="_top">Frames</a></li> +<li><a href="DataSchema.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>
