blob: af6e2a88a14b2ead228534a3cd498faf3574b8e8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Tue Aug 30 09:58:50 EDT 2016 -->
<title>DataPartitioner</title>
<meta name="date" content="2016-08-30">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataPartitioner";
}
//-->
</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/DataPartitioner.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/partitioner/IPDataPartitioner.html" title="class in org.apache.pirk.schema.data.partitioner"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/pirk/schema/data/partitioner/DataPartitioner.html" target="_top">Frames</a></li>
<li><a href="DataPartitioner.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:&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.partitioner</div>
<h2 title="Interface DataPartitioner" class="title">Interface DataPartitioner</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/pirk/schema/data/partitioner/IPDataPartitioner.html" title="class in org.apache.pirk.schema.data.partitioner">IPDataPartitioner</a>, <a href="../../../../../../org/apache/pirk/schema/data/partitioner/ISO8601DatePartitioner.html" title="class in org.apache.pirk.schema.data.partitioner">ISO8601DatePartitioner</a>, <a href="../../../../../../org/apache/pirk/schema/data/partitioner/PrimitiveTypePartitioner.html" title="class in org.apache.pirk.schema.data.partitioner">PrimitiveTypePartitioner</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">DataPartitioner</span>
extends java.io.Serializable</pre>
<div class="block">Interface for data partitioning
<p>
All custom object partitioners must implement this interface</div>
</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">&nbsp;</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>java.util.List&lt;java.math.BigInteger&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#arrayToPartitions(java.util.List,%20java.lang.String)">arrayToPartitions</a></strong>(java.util.List&lt;?&gt;&nbsp;elementList,
java.lang.String&nbsp;type)</code>
<div class="block">Creates partitions for an array of the same type of elements - used when a data value field is an array and we wish to encode these into the return value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#fromPartitions(java.util.List,%20int,%20java.lang.String)">fromPartitions</a></strong>(java.util.List&lt;java.math.BigInteger&gt;&nbsp;parts,
int&nbsp;partsIndex,
java.lang.String&nbsp;type)</code>
<div class="block">Method to reconstruct an Object given a List of its BigInteger partition elements and its type identifier.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#getBits(java.lang.String)">getBits</a></strong>(java.lang.String&nbsp;type)</code>
<div class="block">Returns the number of bits of an object with the given type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#getNumPartitions(java.lang.String)">getNumPartitions</a></strong>(java.lang.String&nbsp;type)</code>
<div class="block">Method to get the number of partitions of the data object given the type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.math.BigInteger&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#getPaddedPartitions(java.lang.String)">getPaddedPartitions</a></strong>(java.lang.String&nbsp;type)</code>
<div class="block">Method to get an empty set of partitions by data type - used for padding return array values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.math.BigInteger&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pirk/schema/data/partitioner/DataPartitioner.html#toPartitions(java.lang.Object,%20java.lang.String)">toPartitions</a></strong>(java.lang.Object&nbsp;object,
java.lang.String&nbsp;type)</code>
<div class="block">Method to partition the given Object into a List of BigInteger partition elements given its type identifier.</div>
</td>
</tr>
</table>
</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="toPartitions(java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPartitions</h4>
<pre>java.util.List&lt;java.math.BigInteger&gt;&nbsp;toPartitions(java.lang.Object&nbsp;object,
java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Method to partition the given Object into a List of BigInteger partition elements given its type identifier.
<p>
If the Object does not have/need a specific type identifier, use null.</div>
<dl><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></dd></dl>
</li>
</ul>
<a name="fromPartitions(java.util.List, int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPartitions</h4>
<pre>java.lang.Object&nbsp;fromPartitions(java.util.List&lt;java.math.BigInteger&gt;&nbsp;parts,
int&nbsp;partsIndex,
java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Method to reconstruct an Object given a List of its BigInteger partition elements and its type identifier.
<p>
If the Object does not have/need a specific type identifier, use null.</div>
<dl><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></dd></dl>
</li>
</ul>
<a name="getBits(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBits</h4>
<pre>int&nbsp;getBits(java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Returns the number of bits of an object with the given type.</div>
<dl><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></dd></dl>
</li>
</ul>
<a name="arrayToPartitions(java.util.List, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arrayToPartitions</h4>
<pre>java.util.List&lt;java.math.BigInteger&gt;&nbsp;arrayToPartitions(java.util.List&lt;?&gt;&nbsp;elementList,
java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Creates partitions for an array of the same type of elements - used when a data value field is an array and we wish to encode these into the return value.</div>
<dl><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></dd></dl>
</li>
</ul>
<a name="getPaddedPartitions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPaddedPartitions</h4>
<pre>java.util.List&lt;java.math.BigInteger&gt;&nbsp;getPaddedPartitions(java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Method to get an empty set of partitions by data type - used for padding return array values.</div>
<dl><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></dd></dl>
</li>
</ul>
<a name="getNumPartitions(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNumPartitions</h4>
<pre>int&nbsp;getNumPartitions(java.lang.String&nbsp;type)
throws <a href="../../../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Method to get the number of partitions of the data object given the type.</div>
<dl><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></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/DataPartitioner.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/partitioner/IPDataPartitioner.html" title="class in org.apache.pirk.schema.data.partitioner"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/pirk/schema/data/partitioner/DataPartitioner.html" target="_top">Frames</a></li>
<li><a href="DataPartitioner.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:&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>