blob: c2bcb64488b6bf2a4a8ed5ab0e75141e1c3dcba0 [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 (1.8.0_40) on Thu Jul 20 13:17:29 PDT 2017 -->
<title>PartitionedFileSourceBase (gobblin-core 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="PartitionedFileSourceBase (gobblin-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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="../../gobblin/source/PartitionAwareFileRetriever.FileInfo.html" title="class in gobblin.source"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/source/RegexBasedPartitionedRetriever.html" title="class in gobblin.source"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/source/PartitionedFileSourceBase.html" target="_top">Frames</a></li>
<li><a href="PartitionedFileSourceBase.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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">gobblin.source</div>
<h2 title="Class PartitionedFileSourceBase" class="title">Class PartitionedFileSourceBase&lt;SCHEMA,DATA&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-core-base/gobblin/source/extractor/extract/AbstractSource.html?is-external=true" title="class or interface in gobblin.source.extractor.extract">gobblin.source.extractor.extract.AbstractSource</a>&lt;S,D&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">gobblin.source.extractor.filebased.FileBasedSource</a>&lt;SCHEMA,DATA&gt;</li>
<li>
<ul class="inheritance">
<li>gobblin.source.PartitionedFileSourceBase&lt;SCHEMA,DATA&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source">Source</a>&lt;SCHEMA,DATA&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../gobblin/source/DatePartitionedAvroFileSource.html" title="class in gobblin.source">DatePartitionedAvroFileSource</a>, <a href="../../gobblin/source/RegexPartitionedAvroFileSource.html" title="class in gobblin.source">RegexPartitionedAvroFileSource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">PartitionedFileSourceBase&lt;SCHEMA,DATA&gt;</span>
extends <a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">FileBasedSource</a>&lt;SCHEMA,DATA&gt;</pre>
<div class="block">Implementation of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source"><code>Source</code></a> that reads over date-partitioned files.
This source can be regarded as the reader equivalent of <a href="../../gobblin/writer/partitioner/TimeBasedAvroWriterPartitioner.html" title="class in gobblin.writer.partitioner"><code>TimeBasedAvroWriterPartitioner</code></a>.
<p>
The class will iterate through all the data folders given by the base directory
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/ConfigurationKeys.html?is-external=true#SOURCE_FILEBASED_DATA_DIRECTORY" title="class or interface in gobblin.configuration"><code>ConfigurationKeys.SOURCE_FILEBASED_DATA_DIRECTORY</code></a>. It relies on a <a href="../../gobblin/source/PartitionAwareFileRetriever.html" title="interface in gobblin.source"><code>PartitionAwareFileRetriever</code></a>
to actually retrieve the files in a given partition.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/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="../../gobblin/source/PartitionedFileSourceBase.html#DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY">DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/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="../../gobblin/source/PartitionedFileSourceBase.html#DATE_PARTITIONED_SOURCE_PARTITION_PREFIX">DATE_PARTITIONED_SOURCE_PARTITION_PREFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/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="../../gobblin/source/PartitionedFileSourceBase.html#DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX">DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/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="../../gobblin/source/PartitionedFileSourceBase.html#DATE_PARTITIONED_SOURCE_PREFIX">DATE_PARTITIONED_SOURCE_PREFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/util/DatePartitionType.html?is-external=true" title="class or interface in gobblin.util">DatePartitionType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#DEFAULT_DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY">DEFAULT_DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.source.extractor.filebased.FileBasedSource">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.source.extractor.filebased.<a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">FileBasedSource</a></h3>
<code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#fsHelper">fsHelper</a>, <a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#splitPattern">splitPattern</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#PartitionedFileSourceBase-gobblin.source.PartitionAwareFileRetriever-">PartitionedFileSourceBase</a></span>(<a href="../../gobblin/source/PartitionAwareFileRetriever.html" title="interface in gobblin.source">PartitionAwareFileRetriever</a>&nbsp;retriever)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/Extractor.html?is-external=true" title="class or interface in gobblin.source.extractor">Extractor</a>&lt;<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">SCHEMA</a>,<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">DATA</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#getExtractor-gobblin.configuration.WorkUnitState-">getExtractor</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/WorkUnitState.html?is-external=true" title="class or interface in gobblin.configuration">WorkUnitState</a>&nbsp;state)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../gobblin/source/PartitionAwareFileRetriever.html" title="interface in gobblin.source">PartitionAwareFileRetriever</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#getRetriever--">getRetriever</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#getWorkunits-gobblin.configuration.SourceState-">getWorkunits</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/SourceState.html?is-external=true" title="class or interface in gobblin.configuration">SourceState</a>&nbsp;state)</code>
<div class="block">This method takes the snapshot seen in the previous run, and compares it to the list
of files currently in the source - it then decided which files it needs to pull
and distributes those files across the workunits; it does this comparison by comparing
the names of the files currently in the source vs.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#init-gobblin.configuration.SourceState-">init</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/SourceState.html?is-external=true" title="class or interface in gobblin.configuration">SourceState</a>&nbsp;state)</code>
<div class="block">Gobblin calls the <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true#getWorkunits-gobblin.configuration.SourceState-" title="class or interface in gobblin.source"><code>Source.getWorkunits(SourceState)</code></a> method after creating a <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source"><code>Source</code></a> object with a
blank constructor, so any custom initialization of the object needs to be done here.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/source/PartitionedFileSourceBase.html#initFileSystemHelper-gobblin.configuration.State-">initFileSystemHelper</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/State.html?is-external=true" title="class or interface in gobblin.configuration">State</a>&nbsp;state)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.source.extractor.filebased.FileBasedSource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.source.extractor.filebased.<a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">FileBasedSource</a></h3>
<code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#getcurrentFsSnapshot-gobblin.configuration.State-">getcurrentFsSnapshot</a>, <a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#getLsPattern-gobblin.configuration.State-">getLsPattern</a>, <a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#initLogger-gobblin.configuration.SourceState-">initLogger</a>, <a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#shutdown-gobblin.configuration.SourceState-">shutdown</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.source.extractor.extract.AbstractSource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.source.extractor.extract.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-core-base/gobblin/source/extractor/extract/AbstractSource.html?is-external=true" title="class or interface in gobblin.source.extractor.extract">AbstractSource</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-core-base/gobblin/source/extractor/extract/AbstractSource.html?is-external=true#createExtract-gobblin.source.workunit.Extract.TableType-java.lang.String-java.lang.String-" title="class or interface in gobblin.source.extractor.extract">createExtract</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-core-base/gobblin/source/extractor/extract/AbstractSource.html?is-external=true#getPreviousWorkUnitsForRetry-gobblin.configuration.SourceState-" title="class or interface in gobblin.source.extractor.extract">getPreviousWorkUnitsForRetry</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-core-base/gobblin/source/extractor/extract/AbstractSource.html?is-external=true#getPreviousWorkUnitStatesForRetry-gobblin.configuration.SourceState-" title="class or interface in gobblin.source.extractor.extract">getPreviousWorkUnitStatesForRetry</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DATE_PARTITIONED_SOURCE_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATE_PARTITIONED_SOURCE_PREFIX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DATE_PARTITIONED_SOURCE_PREFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#gobblin.source.PartitionedFileSourceBase.DATE_PARTITIONED_SOURCE_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATE_PARTITIONED_SOURCE_PARTITION_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATE_PARTITIONED_SOURCE_PARTITION_PREFIX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DATE_PARTITIONED_SOURCE_PARTITION_PREFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#gobblin.source.PartitionedFileSourceBase.DATE_PARTITIONED_SOURCE_PARTITION_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#gobblin.source.PartitionedFileSourceBase.DATE_PARTITIONED_SOURCE_PARTITION_SUFFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#gobblin.source.PartitionedFileSourceBase.DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</h4>
<pre>public static final&nbsp;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/util/DatePartitionType.html?is-external=true" title="class or interface in gobblin.util">DatePartitionType</a> DEFAULT_DATE_PARTITIONED_SOURCE_PARTITION_GRANULARITY</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PartitionedFileSourceBase-gobblin.source.PartitionAwareFileRetriever-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PartitionedFileSourceBase</h4>
<pre>protected&nbsp;PartitionedFileSourceBase(<a href="../../gobblin/source/PartitionAwareFileRetriever.html" title="interface in gobblin.source">PartitionAwareFileRetriever</a>&nbsp;retriever)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-gobblin.configuration.SourceState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>protected&nbsp;void&nbsp;init(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/SourceState.html?is-external=true" title="class or interface in gobblin.configuration">SourceState</a>&nbsp;state)</pre>
<div class="block">Gobblin calls the <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true#getWorkunits-gobblin.configuration.SourceState-" title="class or interface in gobblin.source"><code>Source.getWorkunits(SourceState)</code></a> method after creating a <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source"><code>Source</code></a> object with a
blank constructor, so any custom initialization of the object needs to be done here.</div>
</li>
</ul>
<a name="initFileSystemHelper-gobblin.configuration.State-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initFileSystemHelper</h4>
<pre>public&nbsp;void&nbsp;initFileSystemHelper(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/State.html?is-external=true" title="class or interface in gobblin.configuration">State</a>&nbsp;state)
throws <a href="../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#initFileSystemHelper-gobblin.configuration.State-">initFileSystemHelper</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">FileBasedSource</a>&lt;<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">SCHEMA</a>,<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">DATA</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></code></dd>
</dl>
</li>
</ul>
<a name="getExtractor-gobblin.configuration.WorkUnitState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtractor</h4>
<pre>public abstract&nbsp;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/Extractor.html?is-external=true" title="class or interface in gobblin.source.extractor">Extractor</a>&lt;<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">SCHEMA</a>,<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">DATA</a>&gt;&nbsp;getExtractor(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/WorkUnitState.html?is-external=true" title="class or interface in gobblin.configuration">WorkUnitState</a>&nbsp;state)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getWorkunits-gobblin.configuration.SourceState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkunits</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;getWorkunits(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/SourceState.html?is-external=true" title="class or interface in gobblin.configuration">SourceState</a>&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#getWorkunits-gobblin.configuration.SourceState-">FileBasedSource</a></code></span></div>
<div class="block">This method takes the snapshot seen in the previous run, and compares it to the list
of files currently in the source - it then decided which files it needs to pull
and distributes those files across the workunits; it does this comparison by comparing
the names of the files currently in the source vs. the names retrieved from the
previous state</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true#getWorkunits-gobblin.configuration.SourceState-" title="class or interface in gobblin.source">getWorkunits</a></code>&nbsp;in interface&nbsp;<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source">Source</a>&lt;<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">SCHEMA</a>,<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">DATA</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html#getWorkunits-gobblin.configuration.SourceState-">getWorkunits</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/source/extractor/filebased/FileBasedSource.html" title="class in gobblin.source.extractor.filebased">FileBasedSource</a>&lt;<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">SCHEMA</a>,<a href="../../gobblin/source/PartitionedFileSourceBase.html" title="type parameter in PartitionedFileSourceBase">DATA</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - is the source state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of workunits for the framework to run</dd>
</dl>
</li>
</ul>
<a name="getRetriever--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRetriever</h4>
<pre>protected&nbsp;<a href="../../gobblin/source/PartitionAwareFileRetriever.html" title="interface in gobblin.source">PartitionAwareFileRetriever</a>&nbsp;getRetriever()</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>
<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="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="../../gobblin/source/PartitionAwareFileRetriever.FileInfo.html" title="class in gobblin.source"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/source/RegexBasedPartitionedRetriever.html" title="class in gobblin.source"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/source/PartitionedFileSourceBase.html" target="_top">Frames</a></li>
<li><a href="PartitionedFileSourceBase.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>