This commit is contained in:
Michael Minella
2017-03-23 10:18:33 -05:00
6775 changed files with 1178484 additions and 106 deletions

View File

@@ -0,0 +1,670 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>AbstractNeo4jItemReader (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="AbstractNeo4jItemReader (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":42,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/AbstractNeo4jItemReader.html" target="_top">Frames</a></li>
<li><a href="AbstractNeo4jItemReader.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">org.springframework.batch.item.data</div>
<h2 title="Class AbstractNeo4jItemReader" class="title">Class AbstractNeo4jItemReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">org.springframework.batch.item.ItemStreamSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">org.springframework.batch.item.data.AbstractPaginatedDataItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.AbstractNeo4jItemReader&lt;T&gt;</li>
</ul>
</li>
</ul>
</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="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a>&lt;T&gt;, <a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data">Neo4jItemReader</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractNeo4jItemReader&lt;T&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a>&lt;T&gt;
implements org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
Restartable <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads objects from the graph database Neo4j
via a paging technique.
</p>
<p>
It executes cypher queries built from the statement fragments provided to
retrieve the requested data. The query is executed using paged requests of
a size specified in <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-"><code>AbstractPaginatedDataItemReader.setPageSize(int)</code></a>. Additional pages are requested
as needed when the <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a> method is called. On restart, the reader
will begin again at the same number item it left off at.
</p>
<p>
Performance is dependent on your Neo4J configuration (embedded or remote) as
well as page size. Setting a fairly large page size and using a commit
interval that matches the page size should provide better performance.
</p>
<p>
This implementation is thread-safe between calls to
<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-"><code>AbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext)</code></a>, however you
should set <code>saveState=false</code> if used in a multi-threaded
environment (no restart available).
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.07</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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 org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#logger">logger</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#page">page</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#pageSize">pageSize</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#results">results</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#AbstractNeo4jItemReader--">AbstractNeo4jItemReader</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>
<div class="block">Checks mandatory properties</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#generateLimitCypherQuery--">generateLimitCypherQuery</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getParameterValues--">getParameterValues</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected org.neo4j.ogm.session.SessionFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getSessionFactory--">getSessionFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected java.lang.Class&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="type parameter in AbstractNeo4jItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getTargetType--">getTargetType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected org.springframework.data.neo4j.template.Neo4jOperations</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getTemplate--">getTemplate</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getSessionFactory--"><code>getSessionFactory()</code></a></span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setMatchStatement-java.lang.String-">setMatchStatement</a></span>(java.lang.String&nbsp;matchStatement)</code>
<div class="block">An optional match fragment of the cypher query.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setOrderByStatement-java.lang.String-">setOrderByStatement</a></span>(java.lang.String&nbsp;orderByStatement)</code>
<div class="block">A list of properties to order the results by.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setParameterValues-java.util.Map-">setParameterValues</a></span>(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameterValues)</code>
<div class="block">Optional parameters to be used in the cypher query.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setReturnStatement-java.lang.String-">setReturnStatement</a></span>(java.lang.String&nbsp;returnStatement)</code>
<div class="block">The return statement of the cypher query.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-">setSessionFactory</a></span>(org.neo4j.ogm.session.SessionFactory&nbsp;sessionFactory)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setStartStatement-java.lang.String-">setStartStatement</a></span>(java.lang.String&nbsp;startStatement)</code>
<div class="block">The start segment of the cypher query.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setTargetType-java.lang.Class-">setTargetType</a></span>(java.lang.Class&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="type parameter in AbstractNeo4jItemReader">T</a>&gt;&nbsp;targetType)</code>
<div class="block">The object type to be returned from each call to <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a></div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setTemplate-org.springframework.data.neo4j.template.Neo4jOperations-">setTemplate</a></span>(org.springframework.data.neo4j.template.Neo4jOperations&nbsp;template)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-"><code>setSessionFactory(SessionFactory)</code></a></span></div>
</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setWhereStatement-java.lang.String-">setWhereStatement</a></span>(java.lang.String&nbsp;whereStatement)</code>
<div class="block">An optional where fragment of the cypher query.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doClose--">doClose</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doOpen--">doOpen</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">doPageRead</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doRead--">doRead</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#jumpToItem-int-">jumpToItem</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-">setPageSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#close--">close</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#getCurrentItemCount--">getCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#isSaveState--">isSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-">open</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--">read</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setCurrentItemCount-int-">setCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setMaxItemCount-int-">setMaxItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setSaveState-boolean-">setSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#update-org.springframework.batch.item.ExecutionContext-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.ItemStreamSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></h3>
<code><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#getExecutionContextKey-java.lang.String-">getExecutionContextKey</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setExecutionContextName-java.lang.String-">setExecutionContextName</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setName-java.lang.String-">setName</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.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractNeo4jItemReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractNeo4jItemReader</h4>
<pre>public&nbsp;AbstractNeo4jItemReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setParameterValues-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterValues</h4>
<pre>public&nbsp;void&nbsp;setParameterValues(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameterValues)</pre>
<div class="block">Optional parameters to be used in the cypher query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterValues</code> - the parameter values to be used in the cypher query</dd>
</dl>
</li>
</ul>
<a name="getParameterValues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterValues</h4>
<pre>protected final&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getParameterValues()</pre>
</li>
</ul>
<a name="setStartStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartStatement</h4>
<pre>public&nbsp;void&nbsp;setStartStatement(java.lang.String&nbsp;startStatement)</pre>
<div class="block">The start segment of the cypher query. START is prepended
to the statement provided and should <em>not</em> be
included.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>startStatement</code> - the start fragment of the cypher query.</dd>
</dl>
</li>
</ul>
<a name="setReturnStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReturnStatement</h4>
<pre>public&nbsp;void&nbsp;setReturnStatement(java.lang.String&nbsp;returnStatement)</pre>
<div class="block">The return statement of the cypher query. RETURN is prepended
to the statement provided and should <em>not</em> be
included</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>returnStatement</code> - the return fragment of the cypher query.</dd>
</dl>
</li>
</ul>
<a name="setMatchStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMatchStatement</h4>
<pre>public&nbsp;void&nbsp;setMatchStatement(java.lang.String&nbsp;matchStatement)</pre>
<div class="block">An optional match fragment of the cypher query. MATCH is
prepended to the statement provided and should <em>not</em>
be included.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>matchStatement</code> - the match fragment of the cypher query</dd>
</dl>
</li>
</ul>
<a name="setWhereStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWhereStatement</h4>
<pre>public&nbsp;void&nbsp;setWhereStatement(java.lang.String&nbsp;whereStatement)</pre>
<div class="block">An optional where fragment of the cypher query. WHERE is
prepended to the statement provided and should <em>not</em>
be included.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>whereStatement</code> - where fragment of the cypher query</dd>
</dl>
</li>
</ul>
<a name="setOrderByStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrderByStatement</h4>
<pre>public&nbsp;void&nbsp;setOrderByStatement(java.lang.String&nbsp;orderByStatement)</pre>
<div class="block">A list of properties to order the results by. This is
required so that subsequent page requests pull back the
segment of results correctly. ORDER BY is prepended to
the statement provided and should <em>not</em> be included.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>orderByStatement</code> - order by fragment of the cypher query.</dd>
</dl>
</li>
</ul>
<a name="getSessionFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionFactory</h4>
<pre>protected&nbsp;org.neo4j.ogm.session.SessionFactory&nbsp;getSessionFactory()</pre>
</li>
</ul>
<a name="setSessionFactory-org.neo4j.ogm.session.SessionFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionFactory</h4>
<pre>public&nbsp;void&nbsp;setSessionFactory(org.neo4j.ogm.session.SessionFactory&nbsp;sessionFactory)</pre>
</li>
</ul>
<a name="setTemplate-org.springframework.data.neo4j.template.Neo4jOperations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemplate</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setTemplate(org.springframework.data.neo4j.template.Neo4jOperations&nbsp;template)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-"><code>setSessionFactory(SessionFactory)</code></a></span></div>
<div class="block">Used to perform operations against the Neo4J database.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the Neo4jOperations instance to use</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Neo4jOperations</code></dd>
</dl>
</li>
</ul>
<a name="getTemplate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplate</h4>
<pre>@Deprecated
protected final&nbsp;org.springframework.data.neo4j.template.Neo4jOperations&nbsp;getTemplate()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getSessionFactory--"><code>getSessionFactory()</code></a></span></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Neo4jOperations</code></dd>
</dl>
</li>
</ul>
<a name="setTargetType-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTargetType</h4>
<pre>public&nbsp;void&nbsp;setTargetType(java.lang.Class&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="type parameter in AbstractNeo4jItemReader">T</a>&gt;&nbsp;targetType)</pre>
<div class="block">The object type to be returned from each call to <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetType</code> - the type of object to return.</dd>
</dl>
</li>
</ul>
<a name="getTargetType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetType</h4>
<pre>protected final&nbsp;java.lang.Class&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="type parameter in AbstractNeo4jItemReader">T</a>&gt;&nbsp;getTargetType()</pre>
</li>
</ul>
<a name="generateLimitCypherQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateLimitCypherQuery</h4>
<pre>protected&nbsp;java.lang.String&nbsp;generateLimitCypherQuery()</pre>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<div class="block">Checks mandatory properties</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>InitializingBean.afterPropertiesSet()</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/AbstractNeo4jItemReader.html" target="_top">Frames</a></li>
<li><a href="AbstractNeo4jItemReader.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>

View File

@@ -0,0 +1,518 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>AbstractPaginatedDataItemReader (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="AbstractPaginatedDataItemReader (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"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="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" target="_top">Frames</a></li>
<li><a href="AbstractPaginatedDataItemReader.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">org.springframework.batch.item.data</div>
<h2 title="Class AbstractPaginatedDataItemReader" class="title">Class AbstractPaginatedDataItemReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">org.springframework.batch.item.ItemStreamSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.AbstractPaginatedDataItemReader&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of item to be read</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a>&lt;T&gt;, <a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a>, <a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data">MongoItemReader</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPaginatedDataItemReader&lt;T&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</pre>
<div class="block">A base class that handles basic reading logic based on the paginated
semantics of Spring Data's paginated facilities. It also handles the
semantics required for restartability based on those facilities.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#page">page</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#pageSize">pageSize</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#results">results</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="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#AbstractPaginatedDataItemReader--">AbstractPaginatedDataItemReader</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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doClose--">doClose</a></span>()</code>
<div class="block">Close the resources opened in <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--"><code>AbstractItemCountingItemStreamItemReader.doOpen()</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doOpen--">doOpen</a></span>()</code>
<div class="block">Open resources necessary to start reading input.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">doPageRead</a></span>()</code>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doRead--">doRead</a></span>()</code>
<div class="block">Read next item from input.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#jumpToItem-int-">jumpToItem</a></span>(int&nbsp;itemLastIndex)</code>
<div class="block">Move to the given item index.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-">setPageSize</a></span>(int&nbsp;pageSize)</code>
<div class="block">The number of items to be read with each page.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#close--">close</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#getCurrentItemCount--">getCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#isSaveState--">isSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-">open</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--">read</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setCurrentItemCount-int-">setCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setMaxItemCount-int-">setMaxItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setSaveState-boolean-">setSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#update-org.springframework.batch.item.ExecutionContext-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.ItemStreamSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></h3>
<code><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#getExecutionContextKey-java.lang.String-">getExecutionContextKey</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setExecutionContextName-java.lang.String-">setExecutionContextName</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setName-java.lang.String-">setName</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.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="page">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>page</h4>
<pre>protected volatile&nbsp;int page</pre>
</li>
</ul>
<a name="pageSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pageSize</h4>
<pre>protected&nbsp;int pageSize</pre>
</li>
</ul>
<a name="results">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>results</h4>
<pre>protected&nbsp;java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt; results</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractPaginatedDataItemReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPaginatedDataItemReader</h4>
<pre>public&nbsp;AbstractPaginatedDataItemReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre>public&nbsp;void&nbsp;setPageSize(int&nbsp;pageSize)</pre>
<div class="block">The number of items to be read with each page.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - the number of items</dd>
</dl>
</li>
</ul>
<a name="doRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doRead</h4>
<pre>protected&nbsp;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&nbsp;doRead()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Read next item from input.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--">doRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>item</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="doPageRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doPageRead</h4>
<pre>protected abstract&nbsp;java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;&nbsp;doPageRead()</pre>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page. Each time
this method is called, the resulting <code>Iterator</code>
should contain the items read within the next page.
<br><br>
If the <code>Iterator</code> is empty or null when it is
returned, this <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> will assume that the
input has been exhausted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> containing the items within a page.</dd>
</dl>
</li>
</ul>
<a name="doOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doOpen</h4>
<pre>protected&nbsp;void&nbsp;doOpen()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Open resources necessary to start reading input.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--">doOpen</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="doClose--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doClose</h4>
<pre>protected&nbsp;void&nbsp;doClose()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doClose--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Close the resources opened in <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--"><code>AbstractItemCountingItemStreamItemReader.doOpen()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doClose--">doClose</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="jumpToItem-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jumpToItem</h4>
<pre>protected&nbsp;void&nbsp;jumpToItem(int&nbsp;itemLastIndex)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#jumpToItem-int-">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Move to the given item index. Subclasses should override this method if
there is a more efficient way of moving to given index than re-reading
the input using <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--"><code>AbstractItemCountingItemStreamItemReader.doRead()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#jumpToItem-int-">jumpToItem</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="type parameter in AbstractPaginatedDataItemReader">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itemLastIndex</code> - index of item (0 based) to jump to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</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="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" target="_top">Frames</a></li>
<li><a href="AbstractPaginatedDataItemReader.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>

View File

@@ -0,0 +1,364 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>GemfireItemWriter (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="GemfireItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/GemfireItemWriter.html" target="_top">Frames</a></li>
<li><a href="GemfireItemWriter.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="#fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">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>Field&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">org.springframework.batch.item.data</div>
<h2 title="Class GemfireItemWriter" class="title">Class GemfireItemWriter&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">org.springframework.batch.item.KeyValueItemWriter</a>&lt;K,V&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.GemfireItemWriter&lt;K,V&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="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;V&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data">SpELMappingGemfireItemWriter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">GemfireItemWriter&lt;K,V&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a>&lt;K,V&gt;</pre>
<div class="block">An <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> that stores items in GemFire</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>David Turanski</dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a></h3>
<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#delete">delete</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#itemKeyMapper">itemKeyMapper</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#GemfireItemWriter--">GemfireItemWriter</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="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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#init--">init</a></span>()</code>
<div class="block">afterPropertiesSet() hook</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#setTemplate-org.springframework.data.gemfire.GemfireTemplate-">setTemplate</a></span>(org.springframework.data.gemfire.GemfireTemplate&nbsp;gemfireTemplate)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#writeKeyValue-K-V-">writeKeyValue</a></span>(<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">K</a>&nbsp;key,
<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">V</a>&nbsp;value)</code>
<div class="block">Subclasses implement this method to write each item to key value store</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a></h3>
<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#afterPropertiesSet--">afterPropertiesSet</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#setDelete-boolean-">setDelete</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#setItemKeyMapper-org.springframework.core.convert.converter.Converter-">setItemKeyMapper</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#write-java.util.List-">write</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.Object</h3>
<code>clone, equals, finalize, 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="GemfireItemWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GemfireItemWriter</h4>
<pre>public&nbsp;GemfireItemWriter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setTemplate-org.springframework.data.gemfire.GemfireTemplate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemplate</h4>
<pre>public&nbsp;void&nbsp;setTemplate(org.springframework.data.gemfire.GemfireTemplate&nbsp;gemfireTemplate)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gemfireTemplate</code> - the <code>GemfireTemplate</code> to set</dd>
</dl>
</li>
</ul>
<a name="writeKeyValue-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="writeKeyValue-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeKeyValue</h4>
<pre>protected&nbsp;void&nbsp;writeKeyValue(<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">K</a>&nbsp;key,
<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">V</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#writeKeyValue-K-V-">KeyValueItemWriter</a></code></span></div>
<div class="block">Subclasses implement this method to write each item to key value store</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#writeKeyValue-K-V-">writeKeyValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a>&lt;<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">K</a>,<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">V</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dd><code>value</code> - the item</dd>
</dl>
</li>
</ul>
<a name="init--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>protected&nbsp;void&nbsp;init()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#init--">KeyValueItemWriter</a></code></span></div>
<div class="block">afterPropertiesSet() hook</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#init--">init</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a>&lt;<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">K</a>,<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="type parameter in GemfireItemWriter">V</a>&gt;</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="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/GemfireItemWriter.html" target="_top">Frames</a></li>
<li><a href="GemfireItemWriter.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="#fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">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>Field&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>

View File

@@ -0,0 +1,568 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>MongoItemReader (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="MongoItemReader (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/MongoItemReader.html" target="_top">Frames</a></li>
<li><a href="MongoItemReader.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="#fields.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">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>Field&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">org.springframework.batch.item.data</div>
<h2 title="Class MongoItemReader" class="title">Class MongoItemReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">org.springframework.batch.item.ItemStreamSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">org.springframework.batch.item.data.AbstractPaginatedDataItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.MongoItemReader&lt;T&gt;</li>
</ul>
</li>
</ul>
</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="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a>&lt;T&gt;, <a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MongoItemReader&lt;T&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a>&lt;T&gt;
implements org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
Restartable <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads documents from MongoDB
via a paging technique.
</p>
<p>
It executes the JSON <a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setQuery-java.lang.String-"><code>setQuery(String)</code></a> to retrieve the requested
documents. The query is executed using paged requests specified in the
<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-"><code>AbstractPaginatedDataItemReader.setPageSize(int)</code></a>. Additional pages are requested as needed to
provide data when the <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a> method is called.
</p>
<p>
The JSON query provided supports parameter substitution via ?&lt;index&gt;
placeholders where the &lt;index&gt; indicates the index of the
parameterValue to substitute.
</p>
<p>
The implementation is thread-safe between calls to
<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-"><code>AbstractItemCountingItemStreamItemReader.open(ExecutionContext)</code></a>, but remember to use <code>saveState=false</code>
if used in a multi-threaded client (no restart available).
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#page">page</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#pageSize">pageSize</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#results">results</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#MongoItemReader--">MongoItemReader</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>
<div class="block">Checks mandatory properties</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="type parameter in MongoItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#doPageRead--">doPageRead</a></span>()</code>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setCollection-java.lang.String-">setCollection</a></span>(java.lang.String&nbsp;collection)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setFields-java.lang.String-">setFields</a></span>(java.lang.String&nbsp;fields)</code>
<div class="block">JSON defining the fields to be returned from the matching documents
by MongoDB.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setHint-java.lang.String-">setHint</a></span>(java.lang.String&nbsp;hint)</code>
<div class="block">JSON String telling MongoDB what index to use.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setParameterValues-java.util.List-">setParameterValues</a></span>(java.util.List&lt;java.lang.Object&gt;&nbsp;parameterValues)</code>
<div class="block"><code>List</code> of values to be substituted in for each of the
parameters in the query.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setQuery-java.lang.String-">setQuery</a></span>(java.lang.String&nbsp;query)</code>
<div class="block">A JSON formatted MongoDB query.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setSort-java.util.Map-">setSort</a></span>(java.util.Map&lt;java.lang.String,org.springframework.data.domain.Sort.Direction&gt;&nbsp;sorts)</code>
<div class="block"><code>Map</code> of property names/<code>Sort.Direction</code> values to
sort the input by.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setTargetType-java.lang.Class-">setTargetType</a></span>(java.lang.Class&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="type parameter in MongoItemReader">T</a>&gt;&nbsp;type)</code>
<div class="block">The type of object to be returned for each <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a> call.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html#setTemplate-org.springframework.data.mongodb.core.MongoOperations-">setTemplate</a></span>(org.springframework.data.mongodb.core.MongoOperations&nbsp;template)</code>
<div class="block">Used to perform operations against the MongoDB instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doClose--">doClose</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doOpen--">doOpen</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doRead--">doRead</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#jumpToItem-int-">jumpToItem</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-">setPageSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#close--">close</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#getCurrentItemCount--">getCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#isSaveState--">isSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-">open</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--">read</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setCurrentItemCount-int-">setCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setMaxItemCount-int-">setMaxItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setSaveState-boolean-">setSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#update-org.springframework.batch.item.ExecutionContext-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.ItemStreamSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></h3>
<code><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#getExecutionContextKey-java.lang.String-">getExecutionContextKey</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setExecutionContextName-java.lang.String-">setExecutionContextName</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setName-java.lang.String-">setName</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.Object</h3>
<code>clone, equals, finalize, 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="MongoItemReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MongoItemReader</h4>
<pre>public&nbsp;MongoItemReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setTemplate-org.springframework.data.mongodb.core.MongoOperations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemplate</h4>
<pre>public&nbsp;void&nbsp;setTemplate(org.springframework.data.mongodb.core.MongoOperations&nbsp;template)</pre>
<div class="block">Used to perform operations against the MongoDB instance. Also
handles the mapping of documents to objects.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the MongoOperations instance to use</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>MongoOperations</code></dd>
</dl>
</li>
</ul>
<a name="setQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuery</h4>
<pre>public&nbsp;void&nbsp;setQuery(java.lang.String&nbsp;query)</pre>
<div class="block">A JSON formatted MongoDB query. Parameterization of the provided query is allowed
via ?&lt;index&gt; placeholders where the &lt;index&gt; indicates the index of the
parameterValue to substitute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - JSON formatted Mongo query</dd>
</dl>
</li>
</ul>
<a name="setTargetType-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTargetType</h4>
<pre>public&nbsp;void&nbsp;setTargetType(java.lang.Class&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="type parameter in MongoItemReader">T</a>&gt;&nbsp;type)</pre>
<div class="block">The type of object to be returned for each <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--"><code>AbstractItemCountingItemStreamItemReader.read()</code></a> call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of object to return</dd>
</dl>
</li>
</ul>
<a name="setParameterValues-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterValues</h4>
<pre>public&nbsp;void&nbsp;setParameterValues(java.util.List&lt;java.lang.Object&gt;&nbsp;parameterValues)</pre>
<div class="block"><code>List</code> of values to be substituted in for each of the
parameters in the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterValues</code> - </dd>
</dl>
</li>
</ul>
<a name="setFields-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFields</h4>
<pre>public&nbsp;void&nbsp;setFields(java.lang.String&nbsp;fields)</pre>
<div class="block">JSON defining the fields to be returned from the matching documents
by MongoDB.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fields</code> - JSON string that identifies the fields to sort by.</dd>
</dl>
</li>
</ul>
<a name="setSort-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSort</h4>
<pre>public&nbsp;void&nbsp;setSort(java.util.Map&lt;java.lang.String,org.springframework.data.domain.Sort.Direction&gt;&nbsp;sorts)</pre>
<div class="block"><code>Map</code> of property names/<code>Sort.Direction</code> values to
sort the input by.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sorts</code> - map of properties and direction to sort each.</dd>
</dl>
</li>
</ul>
<a name="setCollection-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCollection</h4>
<pre>public&nbsp;void&nbsp;setCollection(java.lang.String&nbsp;collection)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collection</code> - Mongo collection to be queried.</dd>
</dl>
</li>
</ul>
<a name="setHint-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHint</h4>
<pre>public&nbsp;void&nbsp;setHint(java.lang.String&nbsp;hint)</pre>
<div class="block">JSON String telling MongoDB what index to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hint</code> - string indicating what index to use.</dd>
</dl>
</li>
</ul>
<a name="doPageRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doPageRead</h4>
<pre>protected&nbsp;java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="type parameter in MongoItemReader">T</a>&gt;&nbsp;doPageRead()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">AbstractPaginatedDataItemReader</a></code></span></div>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page. Each time
this method is called, the resulting <code>Iterator</code>
should contain the items read within the next page.
<br><br>
If the <code>Iterator</code> is empty or null when it is
returned, this <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> will assume that the
input has been exhausted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">doPageRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="type parameter in MongoItemReader">T</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> containing the items within a page.</dd>
</dl>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<div class="block">Checks mandatory properties</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>InitializingBean.afterPropertiesSet()</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="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/MongoItemReader.html" target="_top">Frames</a></li>
<li><a href="MongoItemReader.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="#fields.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">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>Field&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>

View File

@@ -0,0 +1,409 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>MongoItemWriter (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="MongoItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/MongoItemWriter.html" target="_top">Frames</a></li>
<li><a href="MongoItemWriter.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><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>Field&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">org.springframework.batch.item.data</div>
<h2 title="Class MongoItemWriter" class="title">Class MongoItemWriter&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.MongoItemWriter&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MongoItemWriter&lt;T&gt;</span>
extends java.lang.Object
implements <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
A <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> implementation that writes to a MongoDB store using an implementation of Spring Data's
<code>MongoOperations</code>. Since MongoDB is not a transactional store, a best effort is made to persist
written data at the last moment, yet still honor job status contracts. No attempt to roll back is made
if an error occurs during writing.
</p>
<p>
This writer is thread-safe once all properties are set (normal singleton behavior) so it can be used in multiple
concurrent transactions.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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="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="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#MongoItemWriter--">MongoItemWriter</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#doWrite-java.util.List-">doWrite</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="type parameter in MongoItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Performs the actual write to the store via the template.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#setCollection-java.lang.String-">setCollection</a></span>(java.lang.String&nbsp;collection)</code>
<div class="block">Set the name of the Mongo collection to be written to.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#setDelete-boolean-">setDelete</a></span>(boolean&nbsp;delete)</code>
<div class="block">Indicates if the items being passed to the writer are to be saved or
removed from the data store.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#setTemplate-org.springframework.data.mongodb.core.MongoOperations-">setTemplate</a></span>(org.springframework.data.mongodb.core.MongoOperations&nbsp;template)</code>
<div class="block">Set the <code>MongoOperations</code> to be used to save items to be written.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html#write-java.util.List-">write</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="type parameter in MongoItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">If a transaction is active, buffer items to be written just before commit.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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="MongoItemWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MongoItemWriter</h4>
<pre>public&nbsp;MongoItemWriter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setDelete-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelete</h4>
<pre>public&nbsp;void&nbsp;setDelete(boolean&nbsp;delete)</pre>
<div class="block">Indicates if the items being passed to the writer are to be saved or
removed from the data store. If set to false (default), the items will
be saved. If set to true, the items will be removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>delete</code> - removal indicator</dd>
</dl>
</li>
</ul>
<a name="setTemplate-org.springframework.data.mongodb.core.MongoOperations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemplate</h4>
<pre>public&nbsp;void&nbsp;setTemplate(org.springframework.data.mongodb.core.MongoOperations&nbsp;template)</pre>
<div class="block">Set the <code>MongoOperations</code> to be used to save items to be written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the template implementation to be used.</dd>
</dl>
</li>
</ul>
<a name="setCollection-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCollection</h4>
<pre>public&nbsp;void&nbsp;setCollection(java.lang.String&nbsp;collection)</pre>
<div class="block">Set the name of the Mongo collection to be written to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collection</code> - the name of the collection.</dd>
</dl>
</li>
</ul>
<a name="write-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="type parameter in MongoItemWriter">T</a>&gt;&nbsp;items)
throws java.lang.Exception</pre>
<div class="block">If a transaction is active, buffer items to be written just before commit.
Otherwise write items using the provided template.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;<a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="type parameter in MongoItemWriter">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - items to be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if there are errors. The framework will catch the
exception and convert or rethrow it as appropriate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-"><code>ItemWriter.write(List)</code></a></dd>
</dl>
</li>
</ul>
<a name="doWrite-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doWrite</h4>
<pre>protected&nbsp;void&nbsp;doWrite(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="type parameter in MongoItemWriter">T</a>&gt;&nbsp;items)</pre>
<div class="block">Performs the actual write to the store via the template.
This can be overridden by a subclass if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - the list of items to be persisted.</dd>
</dl>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</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="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/MongoItemWriter.html" target="_top">Frames</a></li>
<li><a href="MongoItemWriter.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><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>Field&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>

View File

@@ -0,0 +1,373 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>Neo4jItemReader (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="Neo4jItemReader (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/Neo4jItemReader.html" target="_top">Frames</a></li>
<li><a href="Neo4jItemReader.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="#fields.inherited.from.class.org.springframework.batch.item.data.AbstractNeo4jItemReader">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>Field&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">org.springframework.batch.item.data</div>
<h2 title="Class Neo4jItemReader" class="title">Class Neo4jItemReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">org.springframework.batch.item.ItemStreamSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">org.springframework.batch.item.data.AbstractPaginatedDataItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">org.springframework.batch.item.data.AbstractNeo4jItemReader</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.Neo4jItemReader&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
</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="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a>, <a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Neo4jItemReader&lt;T&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a></pre>
<div class="block"><p>
Extensions of the <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data"><code>AbstractNeo4jItemReader</code></a>.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.data.AbstractNeo4jItemReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#logger">logger</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#page">page</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#pageSize">pageSize</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#results">results</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html#Neo4jItemReader--">Neo4jItemReader</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="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>protected java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="type parameter in Neo4jItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html#doPageRead--">doPageRead</a></span>()</code>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.data.AbstractNeo4jItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#afterPropertiesSet--">afterPropertiesSet</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#generateLimitCypherQuery--">generateLimitCypherQuery</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getParameterValues--">getParameterValues</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getSessionFactory--">getSessionFactory</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getTargetType--">getTargetType</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#getTemplate--">getTemplate</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setMatchStatement-java.lang.String-">setMatchStatement</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setOrderByStatement-java.lang.String-">setOrderByStatement</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setParameterValues-java.util.Map-">setParameterValues</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setReturnStatement-java.lang.String-">setReturnStatement</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-">setSessionFactory</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setStartStatement-java.lang.String-">setStartStatement</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setTargetType-java.lang.Class-">setTargetType</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setTemplate-org.springframework.data.neo4j.template.Neo4jOperations-">setTemplate</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html#setWhereStatement-java.lang.String-">setWhereStatement</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.data.AbstractPaginatedDataItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doClose--">doClose</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doOpen--">doOpen</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doRead--">doRead</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#jumpToItem-int-">jumpToItem</a>, <a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#setPageSize-int-">setPageSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#close--">close</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#getCurrentItemCount--">getCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#isSaveState--">isSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-">open</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--">read</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setCurrentItemCount-int-">setCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setMaxItemCount-int-">setMaxItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setSaveState-boolean-">setSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#update-org.springframework.batch.item.ExecutionContext-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.ItemStreamSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></h3>
<code><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#getExecutionContextKey-java.lang.String-">getExecutionContextKey</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setExecutionContextName-java.lang.String-">setExecutionContextName</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setName-java.lang.String-">setName</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.Object</h3>
<code>clone, equals, finalize, 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="Neo4jItemReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Neo4jItemReader</h4>
<pre>public&nbsp;Neo4jItemReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="doPageRead--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doPageRead</h4>
<pre>protected&nbsp;java.util.Iterator&lt;<a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="type parameter in Neo4jItemReader">T</a>&gt;&nbsp;doPageRead()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">AbstractPaginatedDataItemReader</a></code></span></div>
<div class="block">Method this <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item"><code>ItemStreamReader</code></a> delegates to
for the actual work of reading a page. Each time
this method is called, the resulting <code>Iterator</code>
should contain the items read within the next page.
<br><br>
If the <code>Iterator</code> is empty or null when it is
returned, this <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> will assume that the
input has been exhausted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html#doPageRead--">doPageRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> containing the items within a page.</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="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/Neo4jItemReader.html" target="_top">Frames</a></li>
<li><a href="Neo4jItemReader.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="#fields.inherited.from.class.org.springframework.batch.item.data.AbstractNeo4jItemReader">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>Field&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>

View File

@@ -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 (1.8.0_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>Neo4jItemWriter (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="Neo4jItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/Neo4jItemWriter.html" target="_top">Frames</a></li>
<li><a href="Neo4jItemWriter.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">org.springframework.batch.item.data</div>
<h2 title="Class Neo4jItemWriter" class="title">Class Neo4jItemWriter&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.Neo4jItemWriter&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Neo4jItemWriter&lt;T&gt;</span>
extends java.lang.Object
implements <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
A <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> implementation that writes to a Neo4j database.
</p>
<p>
This writer is thread-safe once all properties are set (normal singleton
behavior) so it can be used in multiple concurrent transactions.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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 static org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#logger">logger</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="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#Neo4jItemWriter--">Neo4jItemWriter</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>
<div class="block">Checks mandatory properties</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#doWrite-java.util.List-">doWrite</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="type parameter in Neo4jItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Performs the actual write using the template.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#setDelete-boolean-">setDelete</a></span>(boolean&nbsp;delete)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-">setSessionFactory</a></span>(org.neo4j.ogm.session.SessionFactory&nbsp;sessionFactory)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#setTemplate-org.springframework.data.neo4j.template.Neo4jOperations-">setTemplate</a></span>(org.springframework.data.neo4j.template.Neo4jOperations&nbsp;template)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-"><code>setSessionFactory(SessionFactory)</code></a></span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#write-java.util.List-">write</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="type parameter in Neo4jItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Write all items to the data store.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected static final&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Neo4jItemWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Neo4jItemWriter</h4>
<pre>public&nbsp;Neo4jItemWriter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setDelete-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelete</h4>
<pre>public&nbsp;void&nbsp;setDelete(boolean&nbsp;delete)</pre>
</li>
</ul>
<a name="setTemplate-org.springframework.data.neo4j.template.Neo4jOperations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemplate</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setTemplate(org.springframework.data.neo4j.template.Neo4jOperations&nbsp;template)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html#setSessionFactory-org.neo4j.ogm.session.SessionFactory-"><code>setSessionFactory(SessionFactory)</code></a></span></div>
<div class="block">Set the <code>Neo4jOperations</code> to be used to save items</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the template implementation to be used</dd>
</dl>
</li>
</ul>
<a name="setSessionFactory-org.neo4j.ogm.session.SessionFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionFactory</h4>
<pre>public&nbsp;void&nbsp;setSessionFactory(org.neo4j.ogm.session.SessionFactory&nbsp;sessionFactory)</pre>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<div class="block">Checks mandatory properties</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>InitializingBean.afterPropertiesSet()</code></dd>
</dl>
</li>
</ul>
<a name="write-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="type parameter in Neo4jItemWriter">T</a>&gt;&nbsp;items)
throws java.lang.Exception</pre>
<div class="block">Write all items to the data store.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;<a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="type parameter in Neo4jItemWriter">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - items to be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if there are errors. The framework will catch the
exception and convert or rethrow it as appropriate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-"><code>ItemWriter.write(java.util.List)</code></a></dd>
</dl>
</li>
</ul>
<a name="doWrite-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doWrite</h4>
<pre>protected&nbsp;void&nbsp;doWrite(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="type parameter in Neo4jItemWriter">T</a>&gt;&nbsp;items)</pre>
<div class="block">Performs the actual write using the template. This can be overriden by
a subclass if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - the list of items to be persisted.</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="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/Neo4jItemWriter.html" target="_top">Frames</a></li>
<li><a href="Neo4jItemWriter.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>

View File

@@ -0,0 +1,598 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>RepositoryItemReader (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="RepositoryItemReader (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/RepositoryItemReader.html" target="_top">Frames</a></li>
<li><a href="RepositoryItemReader.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">org.springframework.batch.item.data</div>
<h2 title="Class RepositoryItemReader" class="title">Class RepositoryItemReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">org.springframework.batch.item.ItemStreamSupport</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.RepositoryItemReader&lt;T&gt;</li>
</ul>
</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="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a>&lt;T&gt;, <a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RepositoryItemReader&lt;T&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;T&gt;
implements org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
A <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads records utilizing
a <code>PagingAndSortingRepository</code>.
</p>
<p>
Performance of the reader is dependent on the repository implementation, however
setting a reasonably large page size and matching that to the commit interval should
yield better performance.
</p>
<p>
The reader must be configured with a <code>PagingAndSortingRepository</code>,
a <code>Sort</code>, and a pageSize greater than 0.
</p>
<p>
This implementation is thread-safe between calls to <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-"><code>AbstractItemCountingItemStreamItemReader.open(ExecutionContext)</code></a>, but remember to use
<code>saveState=false</code> if used in a multi-threaded client (no restart available).
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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 org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#logger">logger</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="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#RepositoryItemReader--">RepositoryItemReader</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#doClose--">doClose</a></span>()</code>
<div class="block">Close the resources opened in <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--"><code>AbstractItemCountingItemStreamItemReader.doOpen()</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#doOpen--">doOpen</a></span>()</code>
<div class="block">Open resources necessary to start reading input.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#doPageRead--">doPageRead</a></span>()</code>
<div class="block">Performs the actual reading of a page via the repository.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#doRead--">doRead</a></span>()</code>
<div class="block">Read next item from input.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#jumpToItem-int-">jumpToItem</a></span>(int&nbsp;itemLastIndex)</code>
<div class="block">Move to the given item index.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#setArguments-java.util.List-">setArguments</a></span>(java.util.List&lt;?&gt;&nbsp;arguments)</code>
<div class="block">Arguments to be passed to the data providing method.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#setMethodName-java.lang.String-">setMethodName</a></span>(java.lang.String&nbsp;methodName)</code>
<div class="block">Specifies what method on the repository to call.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#setPageSize-int-">setPageSize</a></span>(int&nbsp;pageSize)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#setRepository-org.springframework.data.repository.PagingAndSortingRepository-">setRepository</a></span>(org.springframework.data.repository.PagingAndSortingRepository&lt;?,?&gt;&nbsp;repository)</code>
<div class="block">The <code>PagingAndSortingRepository</code>
implementation used to read input from.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html#setSort-java.util.Map-">setSort</a></span>(java.util.Map&lt;java.lang.String,org.springframework.data.domain.Sort.Direction&gt;&nbsp;sorts)</code>
<div class="block">Provides ordering of the results so that order is maintained between paged queries</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a></h3>
<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#close--">close</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#getCurrentItemCount--">getCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#isSaveState--">isSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#open-org.springframework.batch.item.ExecutionContext-">open</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#read--">read</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setCurrentItemCount-int-">setCurrentItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setMaxItemCount-int-">setMaxItemCount</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#setSaveState-boolean-">setSaveState</a>, <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#update-org.springframework.batch.item.ExecutionContext-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.ItemStreamSupport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></h3>
<code><a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#getExecutionContextKey-java.lang.String-">getExecutionContextKey</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setExecutionContextName-java.lang.String-">setExecutionContextName</a>, <a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html#setName-java.lang.String-">setName</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.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RepositoryItemReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RepositoryItemReader</h4>
<pre>public&nbsp;RepositoryItemReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setArguments-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setArguments</h4>
<pre>public&nbsp;void&nbsp;setArguments(java.util.List&lt;?&gt;&nbsp;arguments)</pre>
<div class="block">Arguments to be passed to the data providing method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - list of method arguments to be passed to the repository</dd>
</dl>
</li>
</ul>
<a name="setSort-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSort</h4>
<pre>public&nbsp;void&nbsp;setSort(java.util.Map&lt;java.lang.String,org.springframework.data.domain.Sort.Direction&gt;&nbsp;sorts)</pre>
<div class="block">Provides ordering of the results so that order is maintained between paged queries</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sorts</code> - the fields to sort by and the directions</dd>
</dl>
</li>
</ul>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre>public&nbsp;void&nbsp;setPageSize(int&nbsp;pageSize)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - The number of items to retrieve per page.</dd>
</dl>
</li>
</ul>
<a name="setRepository-org.springframework.data.repository.PagingAndSortingRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepository</h4>
<pre>public&nbsp;void&nbsp;setRepository(org.springframework.data.repository.PagingAndSortingRepository&lt;?,?&gt;&nbsp;repository)</pre>
<div class="block">The <code>PagingAndSortingRepository</code>
implementation used to read input from.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repository</code> - underlying repository for input to be read from.</dd>
</dl>
</li>
</ul>
<a name="setMethodName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMethodName</h4>
<pre>public&nbsp;void&nbsp;setMethodName(java.lang.String&nbsp;methodName)</pre>
<div class="block">Specifies what method on the repository to call. This method must take
<code>Pageable</code> as the <em>last</em> argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>methodName</code> - </dd>
</dl>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="doRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doRead</h4>
<pre>protected&nbsp;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&nbsp;doRead()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Read next item from input.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--">doRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>item</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="jumpToItem-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jumpToItem</h4>
<pre>protected&nbsp;void&nbsp;jumpToItem(int&nbsp;itemLastIndex)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#jumpToItem-int-">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Move to the given item index. Subclasses should override this method if
there is a more efficient way of moving to given index than re-reading
the input using <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doRead--"><code>AbstractItemCountingItemStreamItemReader.doRead()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#jumpToItem-int-">jumpToItem</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itemLastIndex</code> - index of item (0 based) to jump to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="doPageRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doPageRead</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;&nbsp;doPageRead()
throws java.lang.Exception</pre>
<div class="block">Performs the actual reading of a page via the repository.
Available for overriding as needed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of items that make up the page</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="doOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doOpen</h4>
<pre>protected&nbsp;void&nbsp;doOpen()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Open resources necessary to start reading input.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--">doOpen</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</dd>
</dl>
</li>
</ul>
<a name="doClose--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doClose</h4>
<pre>protected&nbsp;void&nbsp;doClose()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doClose--">AbstractItemCountingItemStreamItemReader</a></code></span></div>
<div class="block">Close the resources opened in <a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doOpen--"><code>AbstractItemCountingItemStreamItemReader.doOpen()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html#doClose--">doClose</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="type parameter in RepositoryItemReader">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - Allows subclasses to throw checked exceptions for interpretation by the framework</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="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/RepositoryItemReader.html" target="_top">Frames</a></li>
<li><a href="RepositoryItemReader.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>

View File

@@ -0,0 +1,437 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>RepositoryItemWriter (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="RepositoryItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/RepositoryItemWriter.html" target="_top">Frames</a></li>
<li><a href="RepositoryItemWriter.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">org.springframework.batch.item.data</div>
<h2 title="Class RepositoryItemWriter" class="title">Class RepositoryItemWriter&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.RepositoryItemWriter&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RepositoryItemWriter&lt;T&gt;</span>
extends java.lang.Object
implements <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;, org.springframework.beans.factory.InitializingBean</pre>
<div class="block"><p>
A <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> wrapper for a
<code>CrudRepository</code> from Spring Data.
</p>
<p>
It depends on <code>CrudRepository.save(Iterable)</code>
method to store the items for the chunk. Performance will be determined by that
implementation more than this writer.
</p>
<p>
As long as the repository provided is thread-safe, this writer is also thread-safe once
properties are set (normal singleton behavior), so it can be used in multiple concurrent
transactions.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</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 static org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#logger">logger</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="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#RepositoryItemWriter--">RepositoryItemWriter</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>
<div class="block">Check mandatory properties - there must be a repository.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#doWrite-java.util.List-">doWrite</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Performs the actual write to the repository.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#setMethodName-java.lang.String-">setMethodName</a></span>(java.lang.String&nbsp;methodName)</code>
<div class="block">Specifies what method on the repository to call.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#setRepository-org.springframework.data.repository.CrudRepository-">setRepository</a></span>(org.springframework.data.repository.CrudRepository&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>,?&gt;&nbsp;repository)</code>
<div class="block">Set the <code>CrudRepository</code> implementation
for persistence</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html#write-java.util.List-">write</a></span>(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Write all items to the data store via a Spring Data repository.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected static final&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RepositoryItemWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RepositoryItemWriter</h4>
<pre>public&nbsp;RepositoryItemWriter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setMethodName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMethodName</h4>
<pre>public&nbsp;void&nbsp;setMethodName(java.lang.String&nbsp;methodName)</pre>
<div class="block">Specifies what method on the repository to call. This method must the type of
object passed to this writer as the <em>sole</em> argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>methodName</code> - </dd>
</dl>
</li>
</ul>
<a name="setRepository-org.springframework.data.repository.CrudRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepository</h4>
<pre>public&nbsp;void&nbsp;setRepository(org.springframework.data.repository.CrudRepository&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>,?&gt;&nbsp;repository)</pre>
<div class="block">Set the <code>CrudRepository</code> implementation
for persistence</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repository</code> - the Spring Data repository to be set</dd>
</dl>
</li>
</ul>
<a name="write-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>&gt;&nbsp;items)
throws java.lang.Exception</pre>
<div class="block">Write all items to the data store via a Spring Data repository.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;<a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - items to be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if there are errors. The framework will catch the
exception and convert or rethrow it as appropriate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/springframework/batch/item/ItemWriter.html#write-java.util.List-"><code>ItemWriter.write(java.util.List)</code></a></dd>
</dl>
</li>
</ul>
<a name="doWrite-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doWrite</h4>
<pre>protected&nbsp;void&nbsp;doWrite(java.util.List&lt;? extends <a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="type parameter in RepositoryItemWriter">T</a>&gt;&nbsp;items)
throws java.lang.Exception</pre>
<div class="block">Performs the actual write to the repository. This can be overriden by
a subclass if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - the list of items to be persisted.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<div class="block">Check mandatory properties - there must be a repository.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</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="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/RepositoryItemWriter.html" target="_top">Frames</a></li>
<li><a href="RepositoryItemWriter.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>

View File

@@ -0,0 +1,245 @@
<!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_31) on Thu Mar 23 09:54:36 CDT 2017 -->
<title>SpELMappingGemfireItemWriter (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="SpELMappingGemfireItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" target="_top">Frames</a></li>
<li><a href="SpELMappingGemfireItemWriter.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="#fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.springframework.batch.item.data.GemfireItemWriter">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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.springframework.batch.item.data</div>
<h2 title="Class SpELMappingGemfireItemWriter" class="title">Class SpELMappingGemfireItemWriter&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">org.springframework.batch.item.KeyValueItemWriter</a>&lt;K,V&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data">org.springframework.batch.item.data.GemfireItemWriter</a>&lt;K,V&gt;</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.item.data.SpELMappingGemfireItemWriter&lt;K,V&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="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;V&gt;, org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SpELMappingGemfireItemWriter&lt;K,V&gt;</span>
extends <a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data">GemfireItemWriter</a>&lt;K,V&gt;</pre>
<div class="block">A convenient <a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><code>GemfireItemWriter</code></a> implementation that uses a <a href="../../../../../org/springframework/batch/item/SpELItemKeyMapper.html" title="class in org.springframework.batch.item"><code>SpELItemKeyMapper</code></a></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>David Turanski</dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a></h3>
<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#delete">delete</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#itemKeyMapper">itemKeyMapper</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.data.GemfireItemWriter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data">GemfireItemWriter</a></h3>
<code><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#init--">init</a>, <a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#setTemplate-org.springframework.data.gemfire.GemfireTemplate-">setTemplate</a>, <a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html#writeKeyValue-K-V-">writeKeyValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a></h3>
<code><a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#afterPropertiesSet--">afterPropertiesSet</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#setDelete-boolean-">setDelete</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#setItemKeyMapper-org.springframework.core.convert.converter.Converter-">setItemKeyMapper</a>, <a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html#write-java.util.List-">write</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></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="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" target="_top">Frames</a></li>
<li><a href="SpELMappingGemfireItemWriter.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="#fields.inherited.from.class.org.springframework.batch.item.KeyValueItemWriter">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.springframework.batch.item.data.GemfireItemWriter">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@@ -0,0 +1,29 @@
<!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_31) on Thu Mar 23 09:54:37 CDT 2017 -->
<title>org.springframework.batch.item.data (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../../../../org/springframework/batch/item/data/package-summary.html" target="classFrame">org.springframework.batch.item.data</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data" target="classFrame">AbstractNeo4jItemReader</a></li>
<li><a href="AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data" target="classFrame">AbstractPaginatedDataItemReader</a></li>
<li><a href="GemfireItemWriter.html" title="class in org.springframework.batch.item.data" target="classFrame">GemfireItemWriter</a></li>
<li><a href="MongoItemReader.html" title="class in org.springframework.batch.item.data" target="classFrame">MongoItemReader</a></li>
<li><a href="MongoItemWriter.html" title="class in org.springframework.batch.item.data" target="classFrame">MongoItemWriter</a></li>
<li><a href="Neo4jItemReader.html" title="class in org.springframework.batch.item.data" target="classFrame">Neo4jItemReader</a></li>
<li><a href="Neo4jItemWriter.html" title="class in org.springframework.batch.item.data" target="classFrame">Neo4jItemWriter</a></li>
<li><a href="RepositoryItemReader.html" title="class in org.springframework.batch.item.data" target="classFrame">RepositoryItemReader</a></li>
<li><a href="RepositoryItemWriter.html" title="class in org.springframework.batch.item.data" target="classFrame">RepositoryItemWriter</a></li>
<li><a href="SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data" target="classFrame">SpELMappingGemfireItemWriter</a></li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,222 @@
<!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_31) on Thu Mar 23 09:54:37 CDT 2017 -->
<title>org.springframework.batch.item.data (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="org.springframework.batch.item.data (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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="../../../../../org/springframework/batch/item/amqp/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/springframework/batch/item/database/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.springframework.batch.item.data</h1>
<div class="docSummary">
<div class="block">Spring Data related readers and writers.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
Restartable <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads objects from the graph database Neo4j
via a paging technique.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A base class that handles basic reading logic based on the paginated
semantics of Spring Data's paginated facilities.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data">GemfireItemWriter</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">An <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> that stores items in GemFire</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data">MongoItemReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
Restartable <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads documents from MongoDB
via a paging technique.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data">MongoItemWriter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
A <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> implementation that writes to a MongoDB store using an implementation of Spring Data's
<code>MongoOperations</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data">Neo4jItemReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
Extensions of the <a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data"><code>AbstractNeo4jItemReader</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data">Neo4jItemWriter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
A <a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> implementation that writes to a Neo4j database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data">RepositoryItemReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
A <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that reads records utilizing
a <code>PagingAndSortingRepository</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data">RepositoryItemWriter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">
A <a href="../../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> wrapper for a
<code>CrudRepository</code> from Spring Data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data">SpELMappingGemfireItemWriter</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A convenient <a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><code>GemfireItemWriter</code></a> implementation that uses a <a href="../../../../../org/springframework/batch/item/SpELItemKeyMapper.html" title="class in org.springframework.batch.item"><code>SpELItemKeyMapper</code></a></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.springframework.batch.item.data Description">Package org.springframework.batch.item.data Description</h2>
<div class="block">Spring Data related readers and writers.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Michael Minella</dd>
</dl>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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="../../../../../org/springframework/batch/item/amqp/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/springframework/batch/item/database/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@@ -0,0 +1,169 @@
<!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_31) on Thu Mar 23 09:54:37 CDT 2017 -->
<title>org.springframework.batch.item.data Class Hierarchy (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="org.springframework.batch.item.data Class Hierarchy (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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</li>
<li class="navBarCell1Rev">Tree</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/springframework/batch/item/amqp/package-tree.html">Prev</a></li>
<li><a href="../../../../../org/springframework/batch/item/database/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For Package org.springframework.batch.item.data</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item"><span class="typeNameLink">ItemStreamSupport</span></a> (implements org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a>)
<ul>
<li type="circle">org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support"><span class="typeNameLink">AbstractItemStreamItemReader</span></a>&lt;T&gt; (implements org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;)
<ul>
<li type="circle">org.springframework.batch.item.support.<a href="../../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support"><span class="typeNameLink">AbstractItemCountingItemStreamItemReader</span></a>&lt;T&gt;
<ul>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">AbstractPaginatedDataItemReader</span></a>&lt;T&gt;
<ul>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">AbstractNeo4jItemReader</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean)
<ul>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Neo4jItemReader</span></a>&lt;T&gt;</li>
</ul>
</li>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">MongoItemReader</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean)</li>
</ul>
</li>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">RepositoryItemReader</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean)</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li type="circle">org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item"><span class="typeNameLink">KeyValueItemWriter</span></a>&lt;K,V&gt; (implements org.springframework.beans.factory.InitializingBean, org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;)
<ul>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">GemfireItemWriter</span></a>&lt;K,V&gt;
<ul>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">SpELMappingGemfireItemWriter</span></a>&lt;K,V&gt;</li>
</ul>
</li>
</ul>
</li>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">MongoItemWriter</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean, org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;)</li>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">Neo4jItemWriter</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean, org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;)</li>
<li type="circle">org.springframework.batch.item.data.<a href="../../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data"><span class="typeNameLink">RepositoryItemWriter</span></a>&lt;T&gt; (implements org.springframework.beans.factory.InitializingBean, org.springframework.batch.item.<a href="../../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a>&lt;T&gt;)</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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</li>
<li class="navBarCell1Rev">Tree</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/springframework/batch/item/amqp/package-tree.html">Prev</a></li>
<li><a href="../../../../../org/springframework/batch/item/database/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/springframework/batch/item/data/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>