http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/crawl/StdProductCrawler.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/StdProductCrawler.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/StdProductCrawler.html new file mode 100644 index 0000000..d42fff9 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/StdProductCrawler.html @@ -0,0 +1,395 @@ +<!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_91) on Thu Jul 27 17:30:45 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StdProductCrawler (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="StdProductCrawler (Apache OODT 1.2-SNAPSHOT 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/StdProductCrawler.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="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/oodt/cas/crawl/StdProductCrawler.html" target="_top">Frames</a></li> +<li><a href="StdProductCrawler.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><a href="#fields.inherited.from.class.org.apache.oodt.cas.crawl.ProductCrawler">Field</a> | </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">org.apache.oodt.cas.crawl</div> +<h2 title="Class StdProductCrawler" class="title">Class StdProductCrawler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html" title="class in org.apache.oodt.cas.crawl.config">org.apache.oodt.cas.crawl.config.ProductCrawlerBean</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">org.apache.oodt.cas.crawl.ProductCrawler</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.StdProductCrawler</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/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html" title="interface in org.apache.oodt.cas.filemgr.metadata">CoreMetKeys</a>, <a href="../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">StdProductCrawler</span> +extends <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></pre> +<div class="block">A generic Product Crawler for Products. The Crawler is given a root Product + Path and it searches through all directories and sub-directories for .met + files, which it uses to determine products to ingest into the file manger. + The important .met file fields that this crawler requires are: + + <ul> + <li><code>FileLocation</code>: directory absolute path to location of product + file</li> + <li><code>Filename</code>: name of the product file to ingest</li> + <li><code>ProductType</code>: the ProductType that will be sent to the file + manager for the product file described by the .met file.</li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>mattmann (Chris Mattmann), bfoster (Brian Foster)</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.apache.oodt.cas.crawl.ProductCrawler"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.oodt.cas.crawl.<a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></h3> +<code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#actionRepo">actionRepo</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#DIR_FILTER">DIR_FILTER</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#FILE_FILTER">FILE_FILTER</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#ingester">ingester</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#ingestStatus">ingestStatus</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#LOG">LOG</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.oodt.cas.filemgr.metadata.CoreMetKeys"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.oodt.cas.filemgr.metadata.<a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html" title="interface in org.apache.oodt.cas.filemgr.metadata">CoreMetKeys</a></h3> +<code><a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#FILE_LOCATION">FILE_LOCATION</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#FILE_SIZE">FILE_SIZE</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#FILENAME">FILENAME</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#MIME_TYPE">MIME_TYPE</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#PRODUCT_ID">PRODUCT_ID</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#PRODUCT_NAME">PRODUCT_NAME</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#PRODUCT_RECEVIED_TIME">PRODUCT_RECEVIED_TIME</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#PRODUCT_STRUCTURE">PRODUCT_STRUCTURE</a>, <a href="../../../../../org/apache/oodt/cas/filemgr/metadata/CoreMetKeys.html#PRODUCT_TYPE">PRODUCT_TYPE< /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"> </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/apache/oodt/cas/crawl/StdProductCrawler.html#StdProductCrawler--">StdProductCrawler</a></span>()</code> </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>protected <a href="../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/crawl/StdProductCrawler.html#getMetadataForProduct-java.io.File-">getMetadataForProduct</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/crawl/StdProductCrawler.html#passesPreconditions-java.io.File-">passesPreconditions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/crawl/StdProductCrawler.html#renameProduct-java.io.File-org.apache.oodt.cas.metadata.Metadata-">renameProduct</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product, + <a href="../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> productMetadata)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/crawl/StdProductCrawler.html#setMetFileExtension-java.lang.String-">setMetFileExtension</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> metFileExtension)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.oodt.cas.crawl.ProductCrawler"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.oodt.cas.crawl.<a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></h3> +<code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#crawl--">crawl</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#crawl-java.io.File-">crawl</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#getIngestStatus--">getIngestStatus</a>, <a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#handleFile-java.io.File-">handleFile</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.oodt.cas.crawl.config.ProductCrawlerBean"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.oodt.cas.crawl.config.<a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html" title="class in org.apache.oodt.cas.crawl.config">ProductCrawlerBean</a></h3> +<code><a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getActionIds--">getActionIds</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getApplicationContext--">getApplicationContext</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getClientTransferer--">getClientTransferer</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getDaemonPort--">getDaemonPort</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getDaemonWait--">getDaemonWait</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getFilemgrUrl--">getFilemgrUrl</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getGlobalMetadata--">getGlobalMetadata</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getId--">getId</a>, <a href="../../../../../org/apache/oo dt/cas/crawl/config/ProductCrawlerBean.html#getProductPath--">getProductPath</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#getRequiredMetadata--">getRequiredMetadata</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#isCrawlForDirs--">isCrawlForDirs</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#isNoRecur--">isNoRecur</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#isSkipIngest--">isSkipIngest</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setActionIds-java.util.List-">setActionIds</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setApplicationContext-org.springframework.context.ApplicationContext-">setApplicationContext</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setClientTransferer-java.lang.String-">setClientTransf erer</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setCrawlForDirs-boolean-">setCrawlForDirs</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setDaemonPort-int-">setDaemonPort</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setDaemonWait-int-">setDaemonWait</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setFilemgrUrl-java.lang.String-">setFilemgrUrl</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setGlobalMetadata-org.apache.oodt.cas.metadata.Metadata-">setGlobalMetadata</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setId-java.lang.String-">setId</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setNoRecur-boolean-">setNoRecur</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setProdu ctPath-java.lang.String-">setProductPath</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setRequiredMetadata-java.util.List-">setRequiredMetadata</a>, <a href="../../../../../org/apache/oodt/cas/crawl/config/ProductCrawlerBean.html#setSkipIngest-boolean-">setSkipIngest</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</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="StdProductCrawler--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StdProductCrawler</h4> +<pre>public StdProductCrawler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMetadataForProduct-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMetadataForProduct</h4> +<pre>protected <a href="../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> getMetadataForProduct(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product) + throws <a href="../../../../../org/apache/oodt/cas/metadata/exceptions/MetExtractionException.html" title="class in org.apache.oodt.cas.metadata.exceptions">MetExtractionException</a></pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#getMetadataForProduct-java.io.File-">getMetadataForProduct</a></code> in class <code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/oodt/cas/metadata/exceptions/MetExtractionException.html" title="class in org.apache.oodt.cas.metadata.exceptions">MetExtractionException</a></code></dd> +</dl> +</li> +</ul> +<a name="passesPreconditions-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>passesPreconditions</h4> +<pre>protected boolean passesPreconditions(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#passesPreconditions-java.io.File-">passesPreconditions</a></code> in class <code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></code></dd> +</dl> +</li> +</ul> +<a name="renameProduct-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>renameProduct</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> renameProduct(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product, + <a href="../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> productMetadata)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html#renameProduct-java.io.File-org.apache.oodt.cas.metadata.Metadata-">renameProduct</a></code> in class <code><a href="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl">ProductCrawler</a></code></dd> +</dl> +</li> +</ul> +<a name="setMetFileExtension-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMetFileExtension</h4> +<pre>public void setMetFileExtension(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> metFileExtension)</pre> +</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/StdProductCrawler.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="../../../../../org/apache/oodt/cas/crawl/ProductCrawler.html" title="class in org.apache.oodt.cas.crawl"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/oodt/cas/crawl/StdProductCrawler.html" target="_top">Frames</a></li> +<li><a href="StdProductCrawler.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><a href="#fields.inherited.from.class.org.apache.oodt.cas.crawl.ProductCrawler">Field</a> | </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>Copyright © 1999–2017 <a href="http://oodt.apache.org/">Apache OODT</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerAction.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerAction.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerAction.html new file mode 100644 index 0000000..0e07246 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerAction.html @@ -0,0 +1,494 @@ +<!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_91) on Thu Jul 27 17:30:45 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CrawlerAction (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="CrawlerAction (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10,"i9":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="class-use/CrawlerAction.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>Prev Class</li> +<li><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/crawl/action/CrawlerAction.html" target="_top">Frames</a></li> +<li><a href="CrawlerAction.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">org.apache.oodt.cas.crawl.action</div> +<h2 title="Class CrawlerAction" class="title">Class CrawlerAction</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.action.CrawlerAction</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/oodt/cas/crawl/action/DeleteFile.html" title="class in org.apache.oodt.cas.crawl.action">DeleteFile</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/EmailNotification.html" title="class in org.apache.oodt.cas.crawl.action">EmailNotification</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/ExternAction.html" title="class in org.apache.oodt.cas.crawl.action">ExternAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html" title="class in org.apache.oodt.cas.crawl.action">FileBasedAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html" title="class in org.apache.oodt.cas.crawl.action">FilemgrUniquenessChecker</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/GroupAction.html" title="class in org.apache.oodt.cas.crawl.action">GroupAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/MimeTypeCrawlerAc tion.html" title="class in org.apache.oodt.cas.crawl.action">MimeTypeCrawlerAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/MoveFile.html" title="class in org.apache.oodt.cas.crawl.action">MoveFile</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/SolrIndexingAction.html" title="class in org.apache.oodt.cas.crawl.action">SolrIndexingAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/TernaryAction.html" title="class in org.apache.oodt.cas.crawl.action">TernaryAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/ToggleAction.html" title="class in org.apache.oodt.cas.crawl.action">ToggleAction</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/WorkflowMgrStatusUpdate.html" title="class in org.apache.oodt.cas.crawl.action">WorkflowMgrStatusUpdate</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">CrawlerAction</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></pre> +<div class="block">An action taken by the crawler during success or fail of one of its lifecycle + states: preIngest, postIngestSuccess, or postIngestFail .</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>bfoster (Brian Foster), mattmann (Chris Mattmann)</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"> </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>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#LOG">LOG</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#phases">phases</a></span></code> </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"> </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/apache/oodt/cas/crawl/action/CrawlerAction.html#CrawlerAction--">CrawlerAction</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getDescription--">getDescription</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getId--">getId</a></span>()</code> +<div class="block">Get a unique String id that represents this objects instance</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getPhases--">getPhases</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-">performAction</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product, + <a href="../../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> productMetadata)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setDescription-java.lang.String-">setDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setId-java.lang.String-">setId</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code> +<div class="block">Set a unique id that represents this objects instance</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/apache/oodt/cas/crawl/action/CrawlerAction.html#setPhases-java.util.List-">setPhases</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> phases)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#validate--">validate</a></span>()</code> </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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.ht ml?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</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="phases"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>phases</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> phases</pre> +</li> +</ul> +<a name="LOG"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LOG</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> LOG</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CrawlerAction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CrawlerAction</h4> +<pre>public CrawlerAction()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getId()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html#getId--">SpringSetIdInjectionType</a></code></span></div> +<div class="block">Get a unique String id that represents this objects instance</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html#getId--">getId</a></code> in interface <code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Unique String id</dd> +</dl> +</li> +</ul> +<a name="setId-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setId</h4> +<pre>public void setId(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html#setId-java.lang.String-">SpringSetIdInjectionType</a></code></span></div> +<div class="block">Set a unique id that represents this objects instance</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html#setId-java.lang.String-">setId</a></code> in interface <code><a href="../../../../../../org/apache/oodt/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - Unique String id</dd> +</dl> +</li> +</ul> +<a name="setPhases-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPhases</h4> +<pre>public void setPhases(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> phases)</pre> +</li> +</ul> +<a name="getPhases--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPhases</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPhases()</pre> +</li> +</ul> +<a name="setDescription-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDescription</h4> +<pre>public void setDescription(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre> +</li> +</ul> +<a name="getDescription--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDescription()</pre> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="validate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public void validate() + throws <a href="../../../../../../org/apache/oodt/cas/crawl/structs/exceptions/CrawlerActionException.html" title="class in org.apache.oodt.cas.crawl.structs.exceptions">CrawlerActionException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/structs/exceptions/CrawlerActionException.html" title="class in org.apache.oodt.cas.crawl.structs.exceptions">CrawlerActionException</a></code></dd> +</dl> +</li> +</ul> +<a name="performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>performAction</h4> +<pre>public abstract boolean performAction(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> product, + <a href="../../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> productMetadata) + throws <a href="../../../../../../org/apache/oodt/cas/crawl/structs/exceptions/CrawlerActionException.html" title="class in org.apache.oodt.cas.crawl.structs.exceptions">CrawlerActionException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/structs/exceptions/CrawlerActionException.html" title="class in org.apache.oodt.cas.crawl.structs.exceptions">CrawlerActionException</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CrawlerAction.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>Prev Class</li> +<li><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/crawl/action/CrawlerAction.html" target="_top">Frames</a></li> +<li><a href="CrawlerAction.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>Copyright © 1999–2017 <a href="http://oodt.apache.org/">Apache OODT</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html new file mode 100644 index 0000000..ee34ecf --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html @@ -0,0 +1,386 @@ +<!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_91) on Thu Jul 27 17:30:45 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CrawlerActionPhases (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="CrawlerActionPhases (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/CrawlerActionPhases.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="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionRepo.html" title="class in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" target="_top">Frames</a></li> +<li><a href="CrawlerActionPhases.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.apache.oodt.cas.crawl.action</div> +<h2 title="Enum CrawlerActionPhases" class="title">Enum CrawlerActionPhases</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.action.CrawlerActionPhases</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="typeNameLabel">CrawlerActionPhases</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a>></pre> +<div class="block">Supported Crawler Phases.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>mattmann (Chris Mattmann), bfoster (Brian Foster)</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#POST_INGEST_FAILURE">POST_INGEST_FAILURE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#POST_INGEST_SUCCESS">POST_INGEST_SUCCESS</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#PRE_INGEST">PRE_INGEST</a></span></code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#getName--">getName</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#getPhaseByName-java.lang.String-">getPhaseByName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="PRE_INGEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PRE_INGEST</h4> +<pre>public static final <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a> PRE_INGEST</pre> +</li> +</ul> +<a name="POST_INGEST_SUCCESS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>POST_INGEST_SUCCESS</h4> +<pre>public static final <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a> POST_INGEST_SUCCESS</pre> +</li> +</ul> +<a name="POST_INGEST_FAILURE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>POST_INGEST_FAILURE</h4> +<pre>public static final <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a> POST_INGEST_FAILURE</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (CrawlerActionPhases c : CrawlerActionPhases.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> +</li> +</ul> +<a name="getPhaseByName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPhaseByName</h4> +<pre>public static <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" title="enum in org.apache.oodt.cas.crawl.action">CrawlerActionPhases</a> getPhaseByName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +</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/CrawlerActionPhases.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="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerActionRepo.html" title="class in org.apache.oodt.cas.crawl.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/crawl/action/CrawlerActionPhases.html" target="_top">Frames</a></li> +<li><a href="CrawlerActionPhases.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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>Copyright © 1999–2017 <a href="http://oodt.apache.org/">Apache OODT</a>. All rights reserved.</small></p> +</body> +</html>
