<!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>HarvestSiteSchedule (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="HarvestSiteSchedule (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/HarvestSiteSchedule.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/HarvestLog.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/LoginServlet.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/HarvestSiteSchedule.html" target="_top">Frames</a></li> <li><a href="HarvestSiteSchedule.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 HarvestSiteSchedule" class="title">Class HarvestSiteSchedule</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.harvesterClient.HarvestSiteSchedule</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">HarvestSiteSchedule</span> extends java.lang.Object</pre> <div class="block">HarvestSiteSchedule manages a single entry in the HARVEST_SITE_SCHEDULE table, determining when and how to harvest the documents for a given site.</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/HarvestSiteSchedule.html#HarvestSiteSchedule-edu.ucsb.nceas.metacat.harvesterClient.Harvester-int-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-">HarvestSiteSchedule</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester, int siteScheduleID, java.lang.String documentListURL, java.lang.String ldapDN, java.lang.String ldapPwd, java.lang.String dateNextHarvest, java.lang.String dateLastHarvest, int updateFrequency, java.lang.String unit, java.lang.String contactEmail)</code> <div class="block">Creates a new instance of HarvestSiteSchedule.</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>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html#dueForHarvest--">dueForHarvest</a></span>()</code> <div class="block">Boolean to determine whether this site is currently due for its next harvest.</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/HarvestSiteSchedule.html#getSchemaLocation--">getSchemaLocation</a></span>()</code> <div class="block">Accessor method for the schemaLocation field.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html#harvestDocumentList--">harvestDocumentList</a></span>()</code> <div class="block">Harvests each document in the site document list.</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/HarvestSiteSchedule.html#metacatLogin--">metacatLogin</a></span>()</code> <div class="block">Login to Metacat using the ldapDN and ldapPwd</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html#parseHarvestList--">parseHarvestList</a></span>()</code> <div class="block">Parses the site harvest list XML file to find out which documents to harvest.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html#printOutput-java.io.PrintStream-">printOutput</a></span>(java.io.PrintStream out)</code> <div class="block">Prints the data that is stored in this HarvestSiteSchedule object.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/HarvestSiteSchedule.html#setSchemaLocation-java.lang.String-">setSchemaLocation</a></span>(java.lang.String schemaLocation)</code> <div class="block">Accessor method for setting the value of the schemaLocation field.</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="HarvestSiteSchedule-edu.ucsb.nceas.metacat.harvesterClient.Harvester-int-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>HarvestSiteSchedule</h4> <pre>public HarvestSiteSchedule(<a href="../../../../../edu/ucsb/nceas/metacat/harvesterClient/Harvester.html" title="class in edu.ucsb.nceas.metacat.harvesterClient">Harvester</a> harvester, int siteScheduleID, java.lang.String documentListURL, java.lang.String ldapDN, java.lang.String ldapPwd, java.lang.String dateNextHarvest, java.lang.String dateLastHarvest, int updateFrequency, java.lang.String unit, java.lang.String contactEmail)</pre> <div class="block">Creates a new instance of HarvestSiteSchedule. Initialized with the data that was read from a single row in the HARVEST_SITE_SCHEDULE table.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>harvester</code> - the parent Harvester object</dd> <dd><code>siteScheduleID</code> - the value of the SITE_SCHEDULE_ID field</dd> <dd><code>documentListURL</code> - the value of the DOCUMENTLISTURL field</dd> <dd><code>ldapDN</code> - the value of the LDAPDN field</dd> <dd><code>ldapPwd</code> - the value of the LDAPPASSWORD field</dd> <dd><code>dateNextHarvest</code> - the value of the DATENEXTHARVEST field</dd> <dd><code>dateLastHarvest</code> - the value of the DATELASTHARVEST field</dd> <dd><code>updateFrequency</code> - the value of the UPDATEFREQUENCY field</dd> <dd><code>unit</code> - the value of the UNIT field</dd> <dd><code>contactEmail</code> - the value of the CONTACT_EMAIL field</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="dueForHarvest--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>dueForHarvest</h4> <pre>public boolean dueForHarvest()</pre> <div class="block">Boolean to determine whether this site is currently due for its next harvest.</div> </li> </ul> <a name="getSchemaLocation--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSchemaLocation</h4> <pre>public java.lang.String getSchemaLocation()</pre> <div class="block">Accessor method for the schemaLocation field.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>schemaLocation the schema location string</dd> </dl> </li> </ul> <a name="harvestDocumentList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>harvestDocumentList</h4> <pre>public void harvestDocumentList()</pre> <div class="block">Harvests each document in the site document list.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></dd> <dd><code>java.io.IOException</code></dd> <dd><code>javax.xml.parsers.ParserConfigurationException</code></dd> </dl> </li> </ul> <a name="metacatLogin--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>metacatLogin</h4> <pre>public void metacatLogin()</pre> <div class="block">Login to Metacat using the ldapDN and ldapPwd</div> </li> </ul> <a name="parseHarvestList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>parseHarvestList</h4> <pre>public boolean parseHarvestList() throws javax.xml.parsers.ParserConfigurationException</pre> <div class="block">Parses the site harvest list XML file to find out which documents to harvest.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if successful, otherwise false</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>javax.xml.parsers.ParserConfigurationException</code></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">Prints the data that is stored in this HarvestSiteSchedule 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="setSchemaLocation-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>setSchemaLocation</h4> <pre>public void setSchemaLocation(java.lang.String schemaLocation)</pre> <div class="block">Accessor method for setting the value of the schemaLocation field.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>schemaLocation</code> - the new value of the schemaLocation field</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/HarvestSiteSchedule.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/HarvestLog.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/LoginServlet.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/HarvestSiteSchedule.html" target="_top">Frames</a></li> <li><a href="HarvestSiteSchedule.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>