<!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_265) on Tue Aug 25 19:30:51 UTC 2020 -->
<title>HarvestDocument (MetaCat API)</title>
<meta name="date" content="2020-08-25">
<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="HarvestDocument (MetaCat 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="class-use/HarvestDocument.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDetailLog.html" title="class in edu.ucsb.nceas.metacat.harvesterClient"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html" target="_top">Frames</a></li>
<li><a href="HarvestDocument.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">edu.ucsb.nceas.metacat.harvesterClient</div>
<h2 title="Class HarvestDocument" class="title">Class HarvestDocument</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.harvesterClient.HarvestDocument</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">HarvestDocument</span>
extends java.lang.Object</pre>
<div class="block">HarvestDocument manages operations and data for a single document to be
harvested.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>costa</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"> </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="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#HarvestDocument-edu.ucsb.nceas.metacat.harvesterClient.Harvester-edu.ucsb.nceas.metacat.harvesterClient.HarvestSiteSchedule-java.lang.String-int-int-java.lang.String-java.lang.String-">HarvestDocument</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">HarvestSiteSchedule</a> harvestSiteSchedule,
java.lang.String scope,
int identifier,
int revision,
java.lang.String documentType,
java.lang.String documentURL)</code>
<div class="block">Creates a new instance of HarvestDocument.</div>
</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>java.io.StringReader</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#getSiteDocument--">getSiteDocument</a></span>()</code>
<div class="block">Retrieve the document from the site using its <documentURL> value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#harvestDocument--">harvestDocument</a></span>()</code>
<div class="block">Harvest the document from the site.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#metacatHighestRevision--">metacatHighestRevision</a></span>()</code>
<div class="block">Determines the highest revision that Metacat has for this document.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#prettyPrint-java.io.PrintStream-">prettyPrint</a></span>(java.io.PrintStream out)</code>
<div class="block">Print the document URL following by its scope.identifier.revision.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html#printOutput-java.io.PrintStream-">printOutput</a></span>(java.io.PrintStream out)</code>
<div class="block">Print the data fields and values in this HarvestDocument object.</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 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="HarvestDocument-edu.ucsb.nceas.metacat.harvesterClient.Harvester-edu.ucsb.nceas.metacat.harvesterClient.HarvestSiteSchedule-java.lang.String-int-int-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HarvestDocument</h4>
<pre>public HarvestDocument(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">HarvestSiteSchedule</a> harvestSiteSchedule,
java.lang.String scope,
int identifier,
int revision,
java.lang.String documentType,
java.lang.String documentURL)</pre>
<div class="block">Creates a new instance of HarvestDocument. Initialized with the data
that was read from a single <document> element in site document list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>harvester</code> - the parent Harvester object</dd>
<dd><code>harvestSiteSchedule</code> - the parent HarvestSiteSchedule object</dd>
<dd><code>scope</code> - the value of the <scope> element</dd>
<dd><code>identifier</code> - the value of the <identifier> element</dd>
<dd><code>revision</code> - the value of the <revision> element</dd>
<dd><code>documentType</code> - the value of the <documentType> element</dd>
<dd><code>documentURL</code> - the value of the <documentURL> element</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSiteDocument--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSiteDocument</h4>
<pre>public java.io.StringReader getSiteDocument()</pre>
<div class="block">Retrieve the document from the site using its <documentURL> value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A StringReader containing the document string.</dd>
</dl>
</li>
</ul>
<a name="harvestDocument--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>harvestDocument</h4>
<pre>public void harvestDocument()</pre>
<div class="block">Harvest the document from the site. Unless Metacat already has the
document, retrieve the document from the site and put (insert or
update) it to Metacat. If Metacat already has the document, determine
the highest revision stored in Metacat so that this can be reported
back to the user.</div>
</li>
</ul>
<a name="metacatHighestRevision--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metacatHighestRevision</h4>
<pre>public int metacatHighestRevision()</pre>
<div class="block">Determines the highest revision that Metacat has for this document.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int representing the highest revision for this document in
Metacat. Returns -1 if Metacat does not currently hold the
document.</dd>
</dl>
</li>
</ul>
<a name="printOutput-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printOutput</h4>
<pre>public void printOutput(java.io.PrintStream out)</pre>
<div class="block">Print the data fields and values in this HarvestDocument object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the PrintStream to write to</dd>
</dl>
</li>
</ul>
<a name="prettyPrint-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>prettyPrint</h4>
<pre>public void prettyPrint(java.io.PrintStream out)</pre>
<div class="block">Print the document URL following by its scope.identifier.revision.
Used for report generation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the PrintStream to write to</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="class-use/HarvestDocument.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDetailLog.html" title="class in edu.ucsb.nceas.metacat.harvesterClient"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html" target="_top">Frames</a></li>
<li><a href="HarvestDocument.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p>
</body>
</html>