blob: 68ee6b5ddb8472c8370c0cc329a57fb7aee107af [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:31 PDT 2017 -->
<title>FileBasedSource (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="FileBasedSource (gobblin-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":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/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/source/extractor/filebased/FileByteIterator.html" title="class in gobblin.source.extractor.filebased"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/source/extractor/filebased/FileBasedSource.html" target="_top">Frames</a></li>
<li><a href="FileBasedSource.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.extractor.filebased</div>
<h2 title="Class FileBasedSource" class="title">Class FileBasedSource&lt;S,D&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>gobblin.source.extractor.filebased.FileBasedSource&lt;S,D&gt;</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;S,D&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../gobblin/source/extractor/hadoop/AvroFileSource.html" title="class in gobblin.source.extractor.hadoop">AvroFileSource</a>, <a href="../../../../gobblin/source/PartitionedFileSourceBase.html" title="class in gobblin.source">PartitionedFileSourceBase</a>, <a href="../../../../gobblin/source/extractor/extract/sftp/SftpSource.html" title="class in gobblin.source.extractor.extract.sftp">SftpSource</a>, <a href="../../../../gobblin/source/extractor/filebased/TextFileBasedSource.html" title="class in gobblin.source.extractor.filebased">TextFileBasedSource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FileBasedSource&lt;S,D&gt;</span>
extends <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>&lt;S,D&gt;</pre>
<div class="block">This class is a base class for file based sources, it provides default
functionality for keeping track of which files have already been pulled
by the framework and for determining which files need to be pulled in this run</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>protected <a href="../../../../gobblin/source/extractor/filebased/TimestampAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">TimestampAwareFileBasedHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.html#fsHelper">fsHelper</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/extractor/filebased/FileBasedSource.html#splitPattern">splitPattern</a></span></code>&nbsp;</td>
</tr>
</table>
</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.html#FileBasedSource--">FileBasedSource</a></span>()</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><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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.html#getcurrentFsSnapshot-gobblin.configuration.State-">getcurrentFsSnapshot</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>
<div class="block">This method is responsible for connecting to the source and taking
a snapshot of the folder where the data is present, it then returns
a list of the files in String format</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <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/extractor/filebased/FileBasedSource.html#getLsPattern-gobblin.configuration.State-">getLsPattern</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>
<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/extractor/filebased/FileBasedSource.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>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.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>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.html#initLogger-gobblin.configuration.SourceState-">initLogger</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">Initialize the logger.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/filebased/FileBasedSource.html#shutdown-gobblin.configuration.SourceState-">shutdown</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>&nbsp;</td>
</tr>
</table>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.source.Source">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.source.<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></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true#getExtractor-gobblin.configuration.WorkUnitState-" title="class or interface in gobblin.source">getExtractor</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="fsHelper">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fsHelper</h4>
<pre>protected&nbsp;<a href="../../../../gobblin/source/extractor/filebased/TimestampAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">TimestampAwareFileBasedHelper</a> fsHelper</pre>
</li>
</ul>
<a name="splitPattern">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>splitPattern</h4>
<pre>protected&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> splitPattern</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FileBasedSource--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FileBasedSource</h4>
<pre>public&nbsp;FileBasedSource()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initLogger-gobblin.configuration.SourceState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initLogger</h4>
<pre>protected&nbsp;void&nbsp;initLogger(<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">Initialize the logger.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - Source state</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">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="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="getcurrentFsSnapshot-gobblin.configuration.State-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getcurrentFsSnapshot</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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getcurrentFsSnapshot(<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)</pre>
<div class="block">This method is responsible for connecting to the source and taking
a snapshot of the folder where the data is present, it then returns
a list of the files in String format</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - is used to connect to the source</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of file name or paths present on the external data
directory</dd>
</dl>
</li>
</ul>
<a name="getLsPattern-gobblin.configuration.State-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLsPattern</h4>
<pre>protected&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>&nbsp;getLsPattern(<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)</pre>
</li>
</ul>
<a name="shutdown-gobblin.configuration.SourceState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre>public&nbsp;void&nbsp;shutdown(<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>
</li>
</ul>
<a name="initFileSystemHelper-gobblin.configuration.State-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>initFileSystemHelper</h4>
<pre>public abstract&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="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>
</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/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/source/extractor/filebased/FileByteIterator.html" title="class in gobblin.source.extractor.filebased"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/source/extractor/filebased/FileBasedSource.html" target="_top">Frames</a></li>
<li><a href="FileBasedSource.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>