http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileBasedAction.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileBasedAction.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileBasedAction.html new file mode 100644 index 0000000..ffd6187 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileBasedAction.html @@ -0,0 +1,515 @@ +<!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>FileBasedAction (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="FileBasedAction (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"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/FileBasedAction.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/ExternAction.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/FilemgrUniquenessChecker.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/FileBasedAction.html" target="_top">Frames</a></li> +<li><a href="FileBasedAction.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 FileBasedAction" class="title">Class FileBasedAction</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/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">org.apache.oodt.cas.crawl.action.CrawlerAction</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.action.FileBasedAction</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/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/IngestAncillary.html" title="class in org.apache.oodt.cas.crawl.action">IngestAncillary</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">FileBasedAction</span> +extends <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></pre> +<div class="block">This class provides some basic support for actions revolving around files. It + allows action to support file selection based on configuration, metadata, or + the current file being handled by the crawler. In addition, it supports the + usage of FileSettings to provide conformance amongst extending actions. + Finally, it captures a flag for indicating whether the action should fail + should the file not exist.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>pramirez (Paul Ramirez), 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>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html#failMissingFile">failMissingFile</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <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/FileBasedAction.html#file">file</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/FileBasedAction.html#fileKey">fileKey</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html" title="class in org.apache.oodt.cas.crawl.action">FileSettings</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html#fileSettings">fileSettings</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.oodt.cas.crawl.action.CrawlerAction"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#LOG">LOG</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#phases">phases</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/action/FileBasedAction.html#FileBasedAction--">FileBasedAction</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><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/action/FileBasedAction.html#getSelectedFile-java.io.File-org.apache.oodt.cas.metadata.Metadata-">getSelectedFile</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> metadata)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.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> metadata)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html#performFileAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-">performFileAction</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> actionFile, + <a href="../../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> metadata)</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/action/FileBasedAction.html#setFailMissingFile-boolean-">setFailMissingFile</a></span>(boolean failMissingFile)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html#setFile-java.lang.String-">setFile</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> file)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileBasedAction.html#setFileExtension-java.lang.String-">setFileExtension</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> fileExtension)</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/FileBasedAction.html#setFileKey-java.lang.String-">setFileKey</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> fileKey)</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/FileBasedAction.html#setFilePrefix-java.lang.String-">setFilePrefix</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> filePrefix)</code> </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/FileBasedAction.html#setFileSuffix-java.lang.String-">setFileSuffix</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> fileSuffix)</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/FileBasedAction.html#setKeepExistingExtension-boolean-">setKeepExistingExtension</a></span>(boolean keepExistingExtension)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.oodt.cas.crawl.action.CrawlerAction"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getDescription--">getDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getId--">getId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getPhases--">getPhases</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setId-java.lang.String-">setId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setPhases-java.util.List-">setPhases</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.htm l#validate--">validate</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#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="file"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>file</h4> +<pre>protected <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> file</pre> +</li> +</ul> +<a name="fileKey"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fileKey</h4> +<pre>protected <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> fileKey</pre> +</li> +</ul> +<a name="fileSettings"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fileSettings</h4> +<pre>protected <a href="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html" title="class in org.apache.oodt.cas.crawl.action">FileSettings</a> fileSettings</pre> +</li> +</ul> +<a name="failMissingFile"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>failMissingFile</h4> +<pre>protected boolean failMissingFile</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FileBasedAction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileBasedAction</h4> +<pre>public FileBasedAction()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setFilePrefix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilePrefix</h4> +<pre>public void setFilePrefix(<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> filePrefix)</pre> +</li> +</ul> +<a name="setFileSuffix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileSuffix</h4> +<pre>public void setFileSuffix(<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> fileSuffix)</pre> +</li> +</ul> +<a name="setFileExtension-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileExtension</h4> +<pre>public void setFileExtension(<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> fileExtension)</pre> +</li> +</ul> +<a name="setKeepExistingExtension-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKeepExistingExtension</h4> +<pre>public void setKeepExistingExtension(boolean keepExistingExtension)</pre> +</li> +</ul> +<a name="setFile-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFile</h4> +<pre>public void setFile(<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> file)</pre> +</li> +</ul> +<a name="setFileKey-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileKey</h4> +<pre>public void setFileKey(<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> fileKey)</pre> +</li> +</ul> +<a name="setFailMissingFile-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailMissingFile</h4> +<pre>public void setFailMissingFile(boolean failMissingFile)</pre> +</li> +</ul> +<a name="getSelectedFile-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSelectedFile</h4> +<pre>public <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> getSelectedFile(<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> metadata)</pre> +</li> +</ul> +<a name="performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>performAction</h4> +<pre>public 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> metadata) + 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-">performAction</a></code> in class <code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></code></dd> +<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="performFileAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>performFileAction</h4> +<pre>public abstract boolean performFileAction(<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> actionFile, + <a href="../../../../../../org/apache/oodt/cas/metadata/Metadata.html" title="class in org.apache.oodt.cas.metadata">Metadata</a> metadata)</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/FileBasedAction.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/ExternAction.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/FilemgrUniquenessChecker.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/FileBasedAction.html" target="_top">Frames</a></li> +<li><a href="FileBasedAction.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/FileSettings.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileSettings.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileSettings.html new file mode 100644 index 0000000..3860451 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FileSettings.html @@ -0,0 +1,336 @@ +<!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>FileSettings (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="FileSettings (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FileSettings.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/FilemgrUniquenessChecker.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/GroupAction.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/FileSettings.html" target="_top">Frames</a></li> +<li><a href="FileSettings.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">org.apache.oodt.cas.crawl.action</div> +<h2 title="Class FileSettings" class="title">Class FileSettings</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.FileSettings</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FileSettings</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></pre> +<div class="block">This class captures settings used in FileBased actions and the FileExists + precondition. It specifies how to prepare a file string and provides + consistent features across the aforementioned. This preparation supports such + converting from something such as image.jpg to cool_image_ancillary.png. In + this scenario the filePrefix="cool_", fileSuffix="_ancillary", + fileExtension="png", and keepExistingExtension=true. This conversion could + take place by passing calling the getPreparedFileString method.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>pramirez (Paul Ramirez), mattmann (Chris Mattmann)</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="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html#FileSettings--">FileSettings</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><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/FileSettings.html#getPreparedFileString-java.io.File-">getPreparedFileString</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> file)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html#setFileExtension-java.lang.String-">setFileExtension</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> fileExtension)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html#setFilePrefix-java.lang.String-">setFilePrefix</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> filePrefix)</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/action/FileSettings.html#setFileSuffix-java.lang.String-">setFileSuffix</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> fileSuffix)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FileSettings.html#setKeepExistingExtension-boolean-">setKeepExistingExtension</a></span>(boolean keepExistingExtension)</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#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="FileSettings--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileSettings</h4> +<pre>public FileSettings()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setFilePrefix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilePrefix</h4> +<pre>public void setFilePrefix(<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> filePrefix)</pre> +</li> +</ul> +<a name="setFileSuffix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileSuffix</h4> +<pre>public void setFileSuffix(<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> fileSuffix)</pre> +</li> +</ul> +<a name="setFileExtension-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileExtension</h4> +<pre>public void setFileExtension(<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> fileExtension)</pre> +</li> +</ul> +<a name="setKeepExistingExtension-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKeepExistingExtension</h4> +<pre>public void setKeepExistingExtension(boolean keepExistingExtension)</pre> +</li> +</ul> +<a name="getPreparedFileString-java.io.File-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPreparedFileString</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> getPreparedFileString(<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> file)</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/FileSettings.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/FilemgrUniquenessChecker.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/GroupAction.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/FileSettings.html" target="_top">Frames</a></li> +<li><a href="FileSettings.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>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/FilemgrUniquenessChecker.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html new file mode 100644 index 0000000..7c23275 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html @@ -0,0 +1,351 @@ +<!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>FilemgrUniquenessChecker (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="FilemgrUniquenessChecker (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FilemgrUniquenessChecker.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/FileBasedAction.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/FileSettings.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/FilemgrUniquenessChecker.html" target="_top">Frames</a></li> +<li><a href="FilemgrUniquenessChecker.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.action.CrawlerAction">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.action</div> +<h2 title="Class FilemgrUniquenessChecker" class="title">Class FilemgrUniquenessChecker</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/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">org.apache.oodt.cas.crawl.action.CrawlerAction</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.action.FilemgrUniquenessChecker</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/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FilemgrUniquenessChecker</span> +extends <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></pre> +<div class="block">Check whether a product exists in the database already</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>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.action.CrawlerAction"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#LOG">LOG</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#phases">phases</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/action/FilemgrUniquenessChecker.html#FilemgrUniquenessChecker--">FilemgrUniquenessChecker</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.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="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html#setFilemgrUrl-java.lang.String-">setFilemgrUrl</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> filemgrUrl)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/FilemgrUniquenessChecker.html#validate--">validate</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.oodt.cas.crawl.action.CrawlerAction"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getDescription--">getDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getId--">getId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getPhases--">getPhases</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setId-java.lang.String-">setId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setPhases-java.util.List-">setPhases</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#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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FilemgrUniquenessChecker--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilemgrUniquenessChecker</h4> +<pre>public FilemgrUniquenessChecker()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>performAction</h4> +<pre>public 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-">performAction</a></code> in class <code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></code></dd> +<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="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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#validate--">validate</a></code> in class <code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></code></dd> +<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="setFilemgrUrl-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setFilemgrUrl</h4> +<pre>public void setFilemgrUrl(<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> filemgrUrl)</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/FilemgrUniquenessChecker.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/FileBasedAction.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/FileSettings.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/FilemgrUniquenessChecker.html" target="_top">Frames</a></li> +<li><a href="FilemgrUniquenessChecker.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.action.CrawlerAction">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/GroupAction.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/crawl/action/GroupAction.html b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/GroupAction.html new file mode 100644 index 0000000..73d4236 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/crawl/action/GroupAction.html @@ -0,0 +1,357 @@ +<!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>GroupAction (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="GroupAction (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GroupAction.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/FileSettings.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/IngestAncillary.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/GroupAction.html" target="_top">Frames</a></li> +<li><a href="GroupAction.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.action.CrawlerAction">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.action</div> +<h2 title="Class GroupAction" class="title">Class GroupAction</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/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">org.apache.oodt.cas.crawl.action.CrawlerAction</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.oodt.cas.crawl.action.GroupAction</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/commons/spring/SpringSetIdInjectionType.html" title="interface in org.apache.oodt.commons.spring">SpringSetIdInjectionType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GroupAction</span> +extends <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></pre> +<div class="block">Support of a GroupAction could go a ways to simplify command line + specification of actions to run. Instead of having to list actions to run one + would simply end up referencing the group. In addition, this may end up + opening up the possibility to customize the behavior of GroupActions such as + not continuing to run actions if one failed. Currently, the crawler continues + executing actions even if an action fails this could be a way to tailor that + behavior.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>pramirez (Paul Ramirez)</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.action.CrawlerAction"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#LOG">LOG</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#phases">phases</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/action/GroupAction.html#GroupAction--">GroupAction</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/GroupAction.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> metadata)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/GroupAction.html#setActionsToCall-java.util.List-">setActionsToCall</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="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a>> actionsToCall)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/crawl/action/GroupAction.html#validate--">validate</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.oodt.cas.crawl.action.CrawlerAction"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.oodt.cas.crawl.action.<a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></h3> +<code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getDescription--">getDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getId--">getId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#getPhases--">getPhases</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setId-java.lang.String-">setId</a>, <a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#setPhases-java.util.List-">setPhases</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#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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GroupAction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GroupAction</h4> +<pre>public GroupAction()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>performAction</h4> +<pre>public 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> metadata) + 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#performAction-java.io.File-org.apache.oodt.cas.metadata.Metadata-">performAction</a></code> in class <code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></code></dd> +<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="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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html#validate--">validate</a></code> in class <code><a href="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a></code></dd> +<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="setActionsToCall-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setActionsToCall</h4> +<pre>public void setActionsToCall(<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="../../../../../../org/apache/oodt/cas/crawl/action/CrawlerAction.html" title="class in org.apache.oodt.cas.crawl.action">CrawlerAction</a>> actionsToCall)</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/GroupAction.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/FileSettings.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/IngestAncillary.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/GroupAction.html" target="_top">Frames</a></li> +<li><a href="GroupAction.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.action.CrawlerAction">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>
