<!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>HarvestLog (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="HarvestLog (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/HarvestLog.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/HarvestListEditor.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/HarvestSiteSchedule.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/HarvestLog.html" target="_top">Frames</a></li>
<li><a href="HarvestLog.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 HarvestLog" class="title">Class HarvestLog</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.harvesterClient.HarvestLog</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">HarvestLog</span>
extends java.lang.Object</pre>
<div class="block">Manages log entries to be inserted to the HARVEST_LOG table.</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/HarvestLog.html#HarvestLog-edu.ucsb.nceas.metacat.harvesterClient.Harvester-java.sql.Connection-int-java.util.Date-int-java.lang.String-java.lang.String-int-">HarvestLog</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
java.sql.Connection conn,
int harvestLogID,
java.util.Date harvestDate,
int status,
java.lang.String message,
java.lang.String harvestOperationCode,
int siteScheduleID)</code>
<div class="block">Creates a new instance of HarvestLog.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestLog.html#HarvestLog-edu.ucsb.nceas.metacat.harvesterClient.Harvester-java.sql.Connection-int-int-java.util.Date-int-java.lang.String-java.lang.String-int-edu.ucsb.nceas.metacat.harvesterClient.HarvestDocument-java.lang.String-">HarvestLog</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
java.sql.Connection conn,
int harvestLogID,
int detailLogID,
java.util.Date harvestDate,
int status,
java.lang.String message,
java.lang.String harvestOperationCode,
int siteScheduleID,
<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">HarvestDocument</a> harvestDocument,
java.lang.String errorMessage)</code>
<div class="block">Creates a new instance of HarvestLog and inserts this entry to the
HARVEST_LOG table.</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestLog.html#getCodeLevelValue-java.lang.String-">getCodeLevelValue</a></span>(java.lang.String codeLevel)</code>
<div class="block">Maps each code level to an integer value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestLog.html#getExplanation-java.lang.String-">getExplanation</a></span>(java.lang.String harvestOperationCode)</code>
<div class="block">Returns an explanation string based on the value of a
harvestOperationCode string.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestLog.html#getHarvestOperationCodeLevel-java.lang.String-">getHarvestOperationCodeLevel</a></span>(java.lang.String harvestOperationCode)</code>
<div class="block">Returns a code level string based on a harvestOperationCode string.</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/HarvestLog.html#printOutput-java.io.PrintStream-java.lang.String-">printOutput</a></span>(java.io.PrintStream out,
java.lang.String maxLevel)</code>
<div class="block">Prints the contents of this HarvestLog 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="HarvestLog-edu.ucsb.nceas.metacat.harvesterClient.Harvester-java.sql.Connection-int-java.util.Date-int-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HarvestLog</h4>
<pre>public HarvestLog(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
java.sql.Connection conn,
int harvestLogID,
java.util.Date harvestDate,
int status,
java.lang.String message,
java.lang.String harvestOperationCode,
int siteScheduleID)</pre>
<div class="block">Creates a new instance of HarvestLog. This constructor is used when
creating log entries that do not involve an error on a harvest document.
(For that type of log entry, use the alternate constructor below.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>harvester</code> - the parent Harvester object</dd>
<dd><code>conn</code> - the database connection</dd>
<dd><code>harvestLogID</code> - the primary key in the HARVEST_LOG table</dd>
<dd><code>harvestDate</code> - the date of this harvest</dd>
<dd><code>status</code> - the status of the harvest operation</dd>
<dd><code>message</code> - the message text of the harvest operation</dd>
<dd><code>harvestOperationCode</code> - the harvest operation code</dd>
<dd><code>siteScheduleID</code> - the siteScheduleID for which this operation was
performed. 0 indicates that the operation did not
involve a particular harvest site.</dd>
</dl>
</li>
</ul>
<a name="HarvestLog-edu.ucsb.nceas.metacat.harvesterClient.Harvester-java.sql.Connection-int-int-java.util.Date-int-java.lang.String-java.lang.String-int-edu.ucsb.nceas.metacat.harvesterClient.HarvestDocument-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HarvestLog</h4>
<pre>public HarvestLog(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester,
java.sql.Connection conn,
int harvestLogID,
int detailLogID,
java.util.Date harvestDate,
int status,
java.lang.String message,
java.lang.String harvestOperationCode,
int siteScheduleID,
<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestDocument.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">HarvestDocument</a> harvestDocument,
java.lang.String errorMessage)</pre>
<div class="block">Creates a new instance of HarvestLog and inserts this entry to the
HARVEST_LOG table. This version of the constructor also instantiates a
HarvestDetailLog object and inserts it to the HARVEST_DETAIL_LOG table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>harvester</code> - the parent Harvester object</dd>
<dd><code>conn</code> - the database connection</dd>
<dd><code>harvestLogID</code> - the primary key in the HARVEST_LOG table</dd>
<dd><code>detailLogID</code> - the primary key in the HARVEST_DETAIL_LOG table</dd>
<dd><code>harvestDate</code> - the date of this harvest</dd>
<dd><code>status</code> - the status of the harvest operation</dd>
<dd><code>message</code> - the message text of the harvest operation</dd>
<dd><code>harvestOperationCode</code> - the harvest operation code</dd>
<dd><code>siteScheduleID</code> - the siteScheduleID for which this operation was
performed. 0 indicates that the operation did not
involve a particular harvest site.</dd>
<dd><code>harvestDocument</code> - the HarvestDocument involved in this operation</dd>
<dd><code>errorMessage</code> - the error message generated by this operation</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="getCodeLevelValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeLevelValue</h4>
<pre>public int getCodeLevelValue(java.lang.String codeLevel)</pre>
<div class="block">Maps each code level to an integer value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>codeLevel</code> - the code level: "error", "warning", "notice",
"info", or "debug"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>codeLevelValue the corresponding code level value</dd>
</dl>
</li>
</ul>
<a name="getExplanation-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExplanation</h4>
<pre>public java.lang.String getExplanation(java.lang.String harvestOperationCode)</pre>
<div class="block">Returns an explanation string based on the value of a
harvestOperationCode string. The explanation string is a description
of the harvest operation specified by the harvestOperationCode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>harvestOperationCode</code> - string value of the harvest operation code</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the explanation for this harvest operation, a String</dd>
</dl>
</li>
</ul>
<a name="getHarvestOperationCodeLevel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHarvestOperationCodeLevel</h4>
<pre>public java.lang.String getHarvestOperationCodeLevel(java.lang.String harvestOperationCode)</pre>
<div class="block">Returns a code level string based on a harvestOperationCode string.
The code level string is one of a set of possible code levels:
"error", "warning", "notice", "info", or "debug".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>harvestOperationCode</code> - string value of the harvest operation code</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the code level value, a String, one of the following:
"error", "warning", "notice", "info", or "debug"</dd>
</dl>
</li>
</ul>
<a name="printOutput-java.io.PrintStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>printOutput</h4>
<pre>public void printOutput(java.io.PrintStream out,
java.lang.String maxLevel)</pre>
<div class="block">Prints the contents of this HarvestLog object. Used in generating reports.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the PrintStream to write to</dd>
<dd><code>maxLevel</code> - the maximum code level to output. If this log entry has a
higher code level than the maxLevel, no output
is issued. For example, if the maxLevel is "error"
(level 1), then anything lower ("warning", "notice", etc.)
will not generate any output.</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/HarvestLog.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/HarvestListEditor.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/HarvestSiteSchedule.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/HarvestLog.html" target="_top">Frames</a></li>
<li><a href="HarvestLog.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>