blob: ed526166e1ff51b81756ca3ee45812fe3d154912 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PartitionLocation (Drill : 1.20.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PartitionLocation (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PartitionLocation.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-all.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/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/planner/PhysicalPlanReader.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/planner/PartitionLocation.html" target="_top">Frames</a></li>
<li><a href="PartitionLocation.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.planner</div>
<h2 title="Interface PartitionLocation" class="title">Interface PartitionLocation</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/drill/exec/planner/DFSDirPartitionLocation.html" title="class in org.apache.drill.exec.planner">DFSDirPartitionLocation</a>, <a href="../../../../../org/apache/drill/exec/planner/DFSFilePartitionLocation.html" title="class in org.apache.drill.exec.planner">DFSFilePartitionLocation</a>, <a href="../../../../../org/apache/drill/exec/planner/sql/HivePartitionLocation.html" title="class in org.apache.drill.exec.planner.sql">HivePartitionLocation</a>, <a href="../../../../../org/apache/drill/exec/planner/ParquetPartitionLocation.html" title="class in org.apache.drill.exec.planner">ParquetPartitionLocation</a>, <a href="../../../../../org/apache/drill/exec/planner/SimplePartitionLocation.html" title="class in org.apache.drill.exec.planner">SimplePartitionLocation</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PartitionLocation</span></pre>
<div class="block">Interface to define a partition. Partition could be simple,
which represents a basic unit for partition, determined by
the underlying storage plugin. On file system, a simple partition
represents a file. Partition could be composite, consisting of
other partitions. On file system storage plugin, a composite
partition corresponds to a directory.
Simple partition location keeps track the string representation of
partition and also stores the value of the individual partition keys
for this partition. Composite partition location keeps track the common
partition keys, but does not keep track the the string representation of
partition and leave it to each individual simple partition it consists of.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/PartitionLocation.html#getCompositePartitionPath--">getCompositePartitionPath</a></span>()</code>
<div class="block">Returns the path string of directory names only for composite partition</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/PartitionLocation.html#getEntirePartitionLocation--">getEntirePartitionLocation</a></span>()</code>
<div class="block">Returns the path of this partition.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/planner/SimplePartitionLocation.html" title="class in org.apache.drill.exec.planner">SimplePartitionLocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/PartitionLocation.html#getPartitionLocationRecursive--">getPartitionLocationRecursive</a></span>()</code>
<div class="block">Returns the list of the non-composite partitions that this partition consists of.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/PartitionLocation.html#getPartitionValue-int-">getPartitionValue</a></span>(int&nbsp;index)</code>
<div class="block">Returns the value of the 'index' partition column</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/PartitionLocation.html#isCompositePartition--">isCompositePartition</a></span>()</code>
<div class="block">Returns if this is a simple or composite partition.</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="getPartitionValue-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionValue</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPartitionValue(int&nbsp;index)</pre>
<div class="block">Returns the value of the 'index' partition column</div>
</li>
</ul>
<a name="getEntirePartitionLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntirePartitionLocation</h4>
<pre>org.apache.hadoop.fs.Path&nbsp;getEntirePartitionLocation()</pre>
<div class="block">Returns the path of this partition.
Only a non-composite partition supports this.</div>
</li>
</ul>
<a name="getPartitionLocationRecursive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionLocationRecursive</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/planner/SimplePartitionLocation.html" title="class in org.apache.drill.exec.planner">SimplePartitionLocation</a>&gt;&nbsp;getPartitionLocationRecursive()</pre>
<div class="block">Returns the list of the non-composite partitions that this partition consists of.</div>
</li>
</ul>
<a name="isCompositePartition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompositePartition</h4>
<pre>boolean&nbsp;isCompositePartition()</pre>
<div class="block">Returns if this is a simple or composite partition.</div>
</li>
</ul>
<a name="getCompositePartitionPath--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCompositePartitionPath</h4>
<pre>org.apache.hadoop.fs.Path&nbsp;getCompositePartitionPath()</pre>
<div class="block">Returns the path string of directory names only for composite partition</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PartitionLocation.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-all.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/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/planner/PhysicalPlanReader.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/planner/PartitionLocation.html" target="_top">Frames</a></li>
<li><a href="PartitionLocation.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>