You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2012/06/02 23:25:39 UTC
svn commit: r1345585 [20/33] - in /incubator/lcf/site/publish: ./ en_US/
ja_JP/ release/trunk/ release/trunk/api/activedirectory/
release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/
release/trunk/api/alfresc...
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimit.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimit.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimit.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimit.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
JobManager.ThrottleLimit
</TITLE>
@@ -295,7 +295,7 @@ This class provides the throttling limit
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimit.html#doesCompareWork()">doesCompareWork</A></B>()</CODE>
<BR>
- See if this class can be legitimately compared against another of
+ See if this class can be legitimately compared against another of
the same type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -503,7 +503,7 @@ JobManager.ThrottleLimit</H3>
public <B>JobManager.ThrottleLimit</B>(int n,
long prioritizationTime)</PRE>
<DL>
-<DD>Constructor.
+<DD>Constructor.
This class is built up piecemeal, so the constructor does nothing.
<P>
<DL>
@@ -580,7 +580,7 @@ public void <B>addLimit</B>(java.lang.St
java.lang.String regexp,
int upperLimit)</PRE>
<DL>
-<DD>Add a document limit for a specified connection. This is the limit across all matching bins; if any
+<DD>Add a document limit for a specified connection. This is the limit across all matching bins; if any
individual matching bin exceeds that limit, then documents that belong to that bin will be excluded.
<P>
<DD><DL>
@@ -614,7 +614,7 @@ doesCompareWork</H3>
<PRE>
public boolean <B>doesCompareWork</B>()</PRE>
<DL>
-<DD>See if this class can be legitimately compared against another of
+<DD>See if this class can be legitimately compared against another of
the same type.
<P>
<DD><DL>
@@ -632,9 +632,9 @@ duplicate</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ILimitChecker.html" title="interface in org.apache.manifoldcf.core.interfaces">ILimitChecker</A> <B>duplicate</B>()</PRE>
<DL>
-<DD>Create a duplicate of this class instance. All current state should be preserved.
- NOTE: Since doesCompareWork() returns false, queries using this limit checker cannot
- be cached, and therefore duplicate() is never called from the query executor. But it can
+<DD>Create a duplicate of this class instance. All current state should be preserved.
+ NOTE: Since doesCompareWork() returns false, queries using this limit checker cannot
+ be cached, and therefore duplicate() is never called from the query executor. But it can
be called from other places.
<P>
<DD><DL>
@@ -668,7 +668,7 @@ hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
-<DD>Find the hashcode for this class. This will only ever be used if
+<DD>Find the hashcode for this class. This will only ever be used if
doesCompareWork() returns true.
<P>
<DD><DL>
@@ -686,7 +686,7 @@ equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object object)</PRE>
<DL>
-<DD>Compare two objects and see if equal. This will only ever be used
+<DD>Compare two objects and see if equal. This will only ever be used
if doesCompareWork() returns true.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimitSpec.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimitSpec.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimitSpec.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.ThrottleLimitSpec.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
JobManager.ThrottleLimitSpec
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobManager.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
JobManager
</TITLE>
@@ -673,7 +673,7 @@ This is the main job manager. It provid
java.util.ArrayList modifiedJobs)</CODE>
<BR>
- Complete the sequence that resumes jobs, either from a pause or from a scheduling window
+ Complete the sequence that resumes jobs, either from a pause or from a scheduling window
wait.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -691,7 +691,7 @@ This is the main job manager. It provid
java.util.ArrayList modifiedJobs)</CODE>
<BR>
- Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
+ Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
window.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -914,7 +914,7 @@ This is the main job manager. It provid
java.lang.String outputConnectionName)</CODE>
<BR>
- Get a list of document identifiers that should actually be deleted from the index, from a list that
+ Get a list of document identifiers that should actually be deleted from the index, from a list that
might contain identifiers that are shared with other jobs, which are targeted to the same output connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1369,7 +1369,7 @@ This is the main job manager. It provid
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/jobs/JobManager.html#resetNotifyJob(java.lang.Long)">resetNotifyJob</A></B>(java.lang.Long jobID)</CODE>
<BR>
- Reset a job that is notifying back to "ready for notify"
+ Reset a job that is notifying back to "ready for notify"
state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1394,7 +1394,7 @@ This is the main job manager. It provid
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/jobs/JobManager.html#resetStartDeleteJob(java.lang.Long)">resetStartDeleteJob</A></B>(java.lang.Long jobID)</CODE>
<BR>
- Reset a job starting for delete back to "ready for delete"
+ Reset a job starting for delete back to "ready for delete"
state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1802,8 +1802,8 @@ noteConnectorDeregistration</H3>
public void <B>noteConnectorDeregistration</B>(java.lang.String[] connectionNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note the deregistration of a connector used by the specified connections.
- This method will be called when the connector is deregistered. Jobs that use these connections
+<DD>Note the deregistration of a connector used by the specified connections.
+ This method will be called when the connector is deregistered. Jobs that use these connections
must therefore enter appropriate states.
<P>
<DD><DL>
@@ -1842,8 +1842,8 @@ noteConnectorRegistration</H3>
public void <B>noteConnectorRegistration</B>(java.lang.String[] connectionNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note the registration of a connector used by the specified connections.
- This method will be called when a connector is registered, on which the specified
+<DD>Note the registration of a connector used by the specified connections.
+ This method will be called when a connector is registered, on which the specified
connections depend.
<P>
<DD><DL>
@@ -1882,8 +1882,8 @@ noteConnectionChange</H3>
public void <B>noteConnectionChange</B>(java.lang.String connectionName)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note a change in connection configuration.
- This method will be called whenever a connection's configuration is modified, or when an external repository change
+<DD>Note a change in connection configuration.
+ This method will be called whenever a connection's configuration is modified, or when an external repository change
is signalled.
<P>
<DD><DL>
@@ -1903,8 +1903,8 @@ noteOutputConnectorDeregistration</H3>
public void <B>noteOutputConnectorDeregistration</B>(java.lang.String[] connectionNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note the deregistration of an output connector used by the specified connections.
- This method will be called when the connector is deregistered. Jobs that use these connections
+<DD>Note the deregistration of an output connector used by the specified connections.
+ This method will be called when the connector is deregistered. Jobs that use these connections
must therefore enter appropriate states.
<P>
<DD><DL>
@@ -1943,8 +1943,8 @@ noteOutputConnectorRegistration</H3>
public void <B>noteOutputConnectorRegistration</B>(java.lang.String[] connectionNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note the registration of an output connector used by the specified connections.
- This method will be called when a connector is registered, on which the specified
+<DD>Note the registration of an output connector used by the specified connections.
+ This method will be called when a connector is registered, on which the specified
connections depend.
<P>
<DD><DL>
@@ -1983,8 +1983,8 @@ noteOutputConnectionChange</H3>
public void <B>noteOutputConnectionChange</B>(java.lang.String connectionName)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note a change in output connection configuration.
- This method will be called whenever a connection's configuration is modified, or when an external target config change
+<DD>Note a change in output connection configuration.
+ This method will be called whenever a connection's configuration is modified, or when an external target config change
is signalled.
<P>
<DD><DL>
@@ -2066,7 +2066,7 @@ public void <B>deleteJob</B>(java.lang.L
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#deleteJob(java.lang.Long)">deleteJob</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - is the job's identifier. This method will purge all the records belonging to the job from the database, as
+<DT><B>Parameters:</B><DD><CODE>id</CODE> - is the job's identifier. This method will purge all the records belonging to the job from the database, as
well as remove all documents indexed by the job from the index.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2200,12 +2200,12 @@ prepareForStart</H3>
public void <B>prepareForStart</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset the job queue immediately after starting up.
- If the system was shut down in the middle of a job, sufficient information should
- be around in the database to allow it to restart. However, BEFORE all the job threads
- are spun up, there needs to be a pass over the queue to bring things back to a "normal"
- state.
- Also, if a job's status is in a state that indicates it was being processed by a thread
+<DD>Reset the job queue immediately after starting up.
+ If the system was shut down in the middle of a job, sufficient information should
+ be around in the database to allow it to restart. However, BEFORE all the job threads
+ are spun up, there needs to be a pass over the queue to bring things back to a "normal"
+ state.
+ Also, if a job's status is in a state that indicates it was being processed by a thread
(which is now dead), then we have to set that status back to previous value.
<P>
<DD><DL>
@@ -2358,8 +2358,8 @@ deleteIngestedDocumentIdentifiers</H3>
public void <B>deleteIngestedDocumentIdentifiers</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>[] identifiers)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Delete ingested document identifiers (as part of deleting the owning job).
- The number of identifiers specified is guaranteed to be less than the maxInClauseCount
+<DD>Delete ingested document identifiers (as part of deleting the owning job).
+ The number of identifiers specified is guaranteed to be less than the maxInClauseCount
for the database.
<P>
<DD><DL>
@@ -2380,10 +2380,10 @@ public <A HREF="../../../../../org/apach
long currentTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get list of cleanable document descriptions. This list will take into account
- multiple jobs that may own the same document. All documents for which a description
- is returned will be transitioned to the "beingcleaned" state. Documents which are
- not in transition and are eligible, but are owned by other jobs, will have their
+<DD>Get list of cleanable document descriptions. This list will take into account
+ multiple jobs that may own the same document. All documents for which a description
+ is returned will be transitioned to the "beingcleaned" state. Documents which are
+ not in transition and are eligible, but are owned by other jobs, will have their
jobqueue entries deleted by this method.
<P>
<DD><DL>
@@ -2404,7 +2404,7 @@ makeCompositeID</H3>
protected static java.lang.String <B>makeCompositeID</B>(java.lang.String docIDHash,
java.lang.String connectionName)</PRE>
<DL>
-<DD>Create a composite document hash key. This consists of the document id hash plus the
+<DD>Create a composite document hash key. This consists of the document id hash plus the
connection name.
<P>
<DD><DL>
@@ -2423,10 +2423,10 @@ public <A HREF="../../../../../org/apach
long currentTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get list of deletable document descriptions. This list will take into account
- multiple jobs that may own the same document. All documents for which a description
- is returned will be transitioned to the "beingdeleted" state. Documents which are
- not in transition and are eligible, but are owned by other jobs, will have their
+<DD>Get list of deletable document descriptions. This list will take into account
+ multiple jobs that may own the same document. All documents for which a description
+ is returned will be transitioned to the "beingdeleted" state. Documents which are
+ not in transition and are eligible, but are owned by other jobs, will have their
jobqueue entries deleted by this method.
<P>
<DD><DL>
@@ -2449,8 +2449,8 @@ protected java.lang.String[] <B>getUnind
java.lang.String outputConnectionName)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get a list of document identifiers that should actually be deleted from the index, from a list that
- might contain identifiers that are shared with other jobs, which are targeted to the same output connection.
+<DD>Get a list of document identifiers that should actually be deleted from the index, from a list that
+ might contain identifiers that are shared with other jobs, which are targeted to the same output connection.
The input list is guaranteed to be smaller in size than maxInClauseCount for the database.
<P>
<DD><DL>
@@ -2472,14 +2472,14 @@ public <A HREF="../../../../../org/apach
int n)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get a list of already-processed documents to reprioritize. Documents in all jobs will be
+<DD>Get a list of already-processed documents to reprioritize. Documents in all jobs will be
returned by this method. Up to n document descriptions will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#getNextAlreadyProcessedReprioritizationDocuments(long, int)">getNextAlreadyProcessedReprioritizationDocuments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass. Avoid
+<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass. Avoid
picking up any documents that are labeled with this timestamp or after.<DD><CODE>n</CODE> - is the maximum number of document descriptions desired.
<DT><B>Returns:</B><DD>the document descriptions.
<DT><B>Throws:</B>
@@ -2495,14 +2495,14 @@ public <A HREF="../../../../../org/apach
int n)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get a list of not-yet-processed documents to reprioritize. Documents in all jobs will be
+<DD>Get a list of not-yet-processed documents to reprioritize. Documents in all jobs will be
returned by this method. Up to n document descriptions will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#getNextNotYetProcessedReprioritizationDocuments(long, int)">getNextNotYetProcessedReprioritizationDocuments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass. Avoid
+<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass. Avoid
picking up any documents that are labeled with this timestamp or after.<DD><CODE>n</CODE> - is the maximum number of document descriptions desired.
<DT><B>Returns:</B><DD>the document descriptions.
<DT><B>Throws:</B>
@@ -2519,7 +2519,7 @@ public void <B>writeDocumentPriorities</
double[] priorities)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Save a set of document priorities. In the case where a document was eligible to have its
+<DD>Save a set of document priorities. In the case where a document was eligible to have its
priority set, but it no longer is eligible, then the provided priority will not be written.
<P>
<DD><DL>
@@ -2540,9 +2540,9 @@ public <A HREF="../../../../../org/apach
long currentTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get up to the next n documents to be expired.
- This method marks the documents whose descriptions have been returned as "being processed", or active.
- The same marking is used as is used for documents that have been queued for worker threads. The model
+<DD>Get up to the next n documents to be expired.
+ This method marks the documents whose descriptions have been returned as "being processed", or active.
+ The same marking is used as is used for documents that have been queued for worker threads. The model
is thus identical.
<P>
<DD><DL>
@@ -2568,19 +2568,19 @@ public <A HREF="../../../../../org/apach
<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html" title="class in org.apache.manifoldcf.crawler.interfaces">DepthStatistics</A> scanRecord)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>/** Get up to the next n document(s) to be fetched and processed.
- This fetch returns records that contain the document identifier, plus all instructions
- pertaining to the document's handling (e.g. whether it should be refetched if the version
- has not changed).
+<DD>/** Get up to the next n document(s) to be fetched and processed.
+ This fetch returns records that contain the document identifier, plus all instructions
+ pertaining to the document's handling (e.g. whether it should be refetched if the version
+ has not changed).
This method also marks the documents whose descriptions have be returned as "being processed".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#getNextDocuments(int, long, long, org.apache.manifoldcf.crawler.interfaces.BlockingDocuments, org.apache.manifoldcf.crawler.interfaces.PerformanceStatistics, org.apache.manifoldcf.crawler.interfaces.DepthStatistics)">getNextDocuments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>n</CODE> - is the maximum number of records desired.<DD><CODE>currentTime</CODE> - is the current time; some fetches do not occur until a specific time.<DD><CODE>interval</CODE> - is the number of milliseconds that this set of documents should represent (for throttling).<DD><CODE>blockingDocuments</CODE> - is the place to record documents that were encountered, are eligible for reprioritization,
- but could not be queued due to throttling considerations.<DD><CODE>statistics</CODE> - are the current performance statistics per connection, which are used to balance the queue stuffing
- so that individual connections are not overwhelmed.<DD><CODE>scanRecord</CODE> - retains the bins from all documents encountered from the query, even those that were skipped due
+<DT><B>Parameters:</B><DD><CODE>n</CODE> - is the maximum number of records desired.<DD><CODE>currentTime</CODE> - is the current time; some fetches do not occur until a specific time.<DD><CODE>interval</CODE> - is the number of milliseconds that this set of documents should represent (for throttling).<DD><CODE>blockingDocuments</CODE> - is the place to record documents that were encountered, are eligible for reprioritization,
+ but could not be queued due to throttling considerations.<DD><CODE>statistics</CODE> - are the current performance statistics per connection, which are used to balance the queue stuffing
+ so that individual connections are not overwhelmed.<DD><CODE>scanRecord</CODE> - retains the bins from all documents encountered from the query, even those that were skipped due
to being overcommitted.
<DT><B>Returns:</B><DD>the array of document descriptions to fetch and process.
<DT><B>Throws:</B>
@@ -2618,7 +2618,7 @@ checkJobActive</H3>
public boolean <B>checkJobActive</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Verify that a specific job is indeed still active. This is used to permit abort or pause to be relatively speedy.
+<DD>Verify that a specific job is indeed still active. This is used to permit abort or pause to be relatively speedy.
The query done within MUST be cached in order to not cause undue performance degradation.
<P>
<DD><DL>
@@ -2658,7 +2658,7 @@ markDocumentCompletedMultiple</H3>
public void <B>markDocumentCompletedMultiple</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>[] documentDescriptions)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note completion of document processing by a job thread of a document.
+<DD>Note completion of document processing by a job thread of a document.
This method causes the state of the document to be marked as "completed".
<P>
<DD><DL>
@@ -2678,7 +2678,7 @@ markDocumentCompleted</H3>
public void <B>markDocumentCompleted</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A> documentDescription)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note completion of document processing by a job thread of a document.
+<DD>Note completion of document processing by a job thread of a document.
This method causes the state of the document to be marked as "completed".
<P>
<DD><DL>
@@ -2708,7 +2708,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentDescriptions</CODE> - are the set of description objects for the documents that were processed.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
to be requeued as a result of the change.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2789,7 +2789,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
to be requeued as a result of the change.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2805,9 +2805,9 @@ public void <B>requeueDocumentMultiple</
int[] actions)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Requeue a document for further processing in the future.
- This method is called after a document is processed, when the job is a "continuous" one.
- It is essentially equivalent to noting that the document processing is complete, except the
+<DD>Requeue a document for further processing in the future.
+ This method is called after a document is processed, when the job is a "continuous" one.
+ It is essentially equivalent to noting that the document processing is complete, except the
document remains on the queue.
<P>
<DD><DL>
@@ -2829,9 +2829,9 @@ public void <B>requeueDocument</B>(<A HR
int action)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Requeue a document for further processing in the future.
- This method is called after a document is processed, when the job is a "continuous" one.
- It is essentially equivalent to noting that the document processing is complete, except the
+<DD>Requeue a document for further processing in the future.
+ This method is called after a document is processed, when the job is a "continuous" one.
+ It is essentially equivalent to noting that the document processing is complete, except the
document remains on the queue.
<P>
<DD><DL>
@@ -2855,11 +2855,11 @@ public void <B>resetDocumentMultiple</B>
int failCount)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a set of documents for further processing in the future.
- This method is called after some unknown number of the documents were processed, but then a service interruption occurred.
- Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
- If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
- current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
+<DD>Reset a set of documents for further processing in the future.
+ This method is called after some unknown number of the documents were processed, but then a service interruption occurred.
+ Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
+ If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
+ current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
special logic is probably not worth it.
<P>
<DD><DL>
@@ -2880,11 +2880,11 @@ public void <B>resetCleaningDocumentMult
long checkTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a set of cleaning documents for further processing in the future.
- This method is called after some unknown number of the documents were cleaned, but then an ingestion service interruption occurred.
- Note well: The logic here basically presumes that we cannot know whether the documents were indeed cleaned or not.
- If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
- current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
+<DD>Reset a set of cleaning documents for further processing in the future.
+ This method is called after some unknown number of the documents were cleaned, but then an ingestion service interruption occurred.
+ Note well: The logic here basically presumes that we cannot know whether the documents were indeed cleaned or not.
+ If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
+ current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
special logic is probably not worth it.
<P>
<DD><DL>
@@ -2905,7 +2905,7 @@ public void <B>resetCleaningDocument</B>
long checkTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a cleaning document back to its former state.
+<DD>Reset a cleaning document back to its former state.
This gets done when a deleting thread sees a service interruption, etc., from the ingestion system.
<P>
<DD><DL>
@@ -2926,11 +2926,11 @@ public void <B>resetDeletingDocumentMult
long checkTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a set of deleting documents for further processing in the future.
- This method is called after some unknown number of the documents were deleted, but then an ingestion service interruption occurred.
- Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
- If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
- current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
+<DD>Reset a set of deleting documents for further processing in the future.
+ This method is called after some unknown number of the documents were deleted, but then an ingestion service interruption occurred.
+ Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
+ If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
+ current status and decide what the new status ought to be, based on a true rollback scenario. Such cases, however, are rare enough so that
special logic is probably not worth it.
<P>
<DD><DL>
@@ -2951,7 +2951,7 @@ public void <B>resetDeletingDocument</B>
long checkTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a deleting document back to its former state.
+<DD>Reset a deleting document back to its former state.
This gets done when a deleting thread sees a service interruption, etc., from the ingestion system.
<P>
<DD><DL>
@@ -2975,17 +2975,17 @@ public void <B>resetDocument</B>(<A HREF
int failCount)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset an active document back to its former state.
- This gets done when there's a service interruption and the document cannot be processed yet.
- Note well: This method formerly presumed that a perfect rollback was possible, and that there was zero chance of any
- processing activity occuring before it got called. That assumption appears incorrect, however, so I've opted to now
+<DD>Reset an active document back to its former state.
+ This gets done when there's a service interruption and the document cannot be processed yet.
+ Note well: This method formerly presumed that a perfect rollback was possible, and that there was zero chance of any
+ processing activity occuring before it got called. That assumption appears incorrect, however, so I've opted to now
presume that processing has perhaps occurred. Perfect rollback is thus no longer possible.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#resetDocument(org.apache.manifoldcf.crawler.interfaces.DocumentDescription, long, int, long, int)">resetDocument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>executeTime</CODE> - is the time that the document should be rescanned.<DD><CODE>failTime</CODE> - is the time that the document should be considered to have failed, if it has not been
+<DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>executeTime</CODE> - is the time that the document should be rescanned.<DD><CODE>failTime</CODE> - is the time that the document should be considered to have failed, if it has not been
successfully read until then.<DD><CODE>failCount</CODE> - is the number of permitted failures before a hard error is signalled.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3040,9 +3040,9 @@ public boolean[] <B>addDocumentsInitial<
java.lang.String[][] prereqEventNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Add an initial set of documents to the queue.
- This method is called during job startup, when the queue is being loaded.
- A set of document references is passed to this method, which updates the status of the document
+<DD>Add an initial set of documents to the queue.
+ This method is called during job startup, when the queue is being loaded.
+ A set of document references is passed to this method, which updates the status of the document
in the specified job's queue, according to specific state rules.
<P>
<DD><DL>
@@ -3066,9 +3066,9 @@ public void <B>addRemainingDocumentsInit
int hopcountMethod)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Add an initial set of remaining documents to the queue.
- This method is called during job startup, when the queue is being loaded, to list documents that
- were NOT included by calling addDocumentsInitial(). Documents listed here are simply designed to
+<DD>Add an initial set of remaining documents to the queue.
+ This method is called during job startup, when the queue is being loaded, to list documents that
+ were NOT included by calling addDocumentsInitial(). Documents listed here are simply designed to
enable the framework to get rid of old, invalid seeds. They are not queued for processing.
<P>
<DD><DL>
@@ -3091,15 +3091,15 @@ public void <B>doneDocumentsInitial</B>(
int hopcountMethod)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Signal that a seeding pass has been done.
- Call this method at the end of a seeding pass. It is used to perform the bookkeeping necessary to
+<DD>Signal that a seeding pass has been done.
+ Call this method at the end of a seeding pass. It is used to perform the bookkeeping necessary to
maintain the hopcount table.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#doneDocumentsInitial(java.lang.Long, java.lang.String[], boolean, int)">doneDocumentsInitial</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>isPartial</CODE> - is set if the seeds provided are only a partial list. Some connectors cannot
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>isPartial</CODE> - is set if the seeds provided are only a partial list. Some connectors cannot
supply a full list of seeds on every seeding iteration; this acknowledges that limitation.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3125,7 +3125,7 @@ public boolean[] <B>findHopCounts</B>(ja
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - are the hashes for the set of documents to find the hopcount for.<DD><CODE>linkType</CODE> - is the kind of link to find the hopcount for.<DD><CODE>limit</CODE> - is the limit, beyond which a negative distance may be returned.<DD><CODE>hopcountMethod</CODE> - is the method for managing hopcounts that is in effect.
-<DT><B>Returns:</B><DD>a vector of booleans corresponding to the documents requested. A true value is returned
+<DT><B>Returns:</B><DD>a vector of booleans corresponding to the documents requested. A true value is returned
if the document is within the specified limit, false otherwise.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3139,7 +3139,7 @@ getAllSeeds</H3>
public java.lang.String[] <B>getAllSeeds</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get all the current seeds.
+<DD>Get all the current seeds.
Returns the seed document identifiers for a job.
<P>
<DD><DL>
@@ -3171,17 +3171,17 @@ public boolean[] <B>addDocuments</B>(jav
java.lang.String[][] prereqEventNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Add documents to the queue in bulk.
- This method is called during document processing, when a set of document references are discovered.
- The document references are passed to this method, which updates the status of the document(s)
+<DD>Add documents to the queue in bulk.
+ This method is called during document processing, when a set of document references are discovered.
+ The document references are passed to this method, which updates the status of the document(s)
in the specified job's queue, according to specific state rules.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#addDocuments(java.lang.Long, java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String, java.lang.String, int, java.lang.String[][], java.lang.Object[][][], long, double[], java.lang.String[][])">addDocuments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - are the local document identifier hashes.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of this document. Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent. Pass null if there
- is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is the desired method for managing hopcounts.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above. If CharacterInput objects are passed in here,
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - are the local document identifier hashes.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of this document. Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent. Pass null if there
+ is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is the desired method for managing hopcounts.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above. If CharacterInput objects are passed in here,
it is the caller's responsibility to clean these up.<DD><CODE>currentTime</CODE> - is the time in milliseconds since epoch that will be recorded for this operation.<DD><CODE>documentPriorities</CODE> - are the desired document priorities for the documents.<DD><CODE>prereqEventNames</CODE> - are the events that must be completed before a document can be queued.<DD><CODE>docIDs</CODE> - are the local document identifiers.
<DT><B>Returns:</B><DD>an array of boolean values indicating whether or not the passed-in priority value was used or not for each doc id (true if used).
<DT><B>Throws:</B>
@@ -3207,16 +3207,16 @@ public boolean <B>addDocument</B>(java.l
java.lang.String[] prereqEventNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Add a document to the queue.
- This method is called during document processing, when a document reference is discovered.
- The document reference is passed to this method, which updates the status of the document
+<DD>Add a document to the queue.
+ This method is called during document processing, when a document reference is discovered.
+ The document reference is passed to this method, which updates the status of the document
in the specified job's queue, according to specific state rules.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#addDocument(java.lang.Long, java.lang.String[], java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, java.lang.String[], java.lang.Object[][], long, double, java.lang.String[])">addDocument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobManager</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHash</CODE> - is the local document identifier hash value.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of this document. Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent. Pass null if there
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHash</CODE> - is the local document identifier hash value.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of this document. Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent. Pass null if there
is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is the desired method for managing hopcounts.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above.<DD><CODE>currentTime</CODE> - is the time in milliseconds since epoch that will be recorded for this operation.<DD><CODE>priority</CODE> - is the desired document priority for the document.<DD><CODE>prereqEventNames</CODE> - are the events that must be completed before the document can be processed.
<DT><B>Returns:</B><DD>true if the priority value was used, false otherwise.
<DT><B>Throws:</B>
@@ -3234,7 +3234,7 @@ public <A HREF="../../../../../org/apach
int hopcountMethod)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Complete adding child documents to the queue, for a set of documents.
+<DD>Complete adding child documents to the queue, for a set of documents.
This method is called at the end of document processing, to help the hopcount tracking engine do its bookkeeping.
<P>
<DD><DL>
@@ -3242,7 +3242,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>parentIdentifierHashes</CODE> - are the document identifier hashes for whom child link extraction just took place.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation. These documents are likely
to be requeued as a result of the change.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3338,8 +3338,8 @@ public boolean[] <B>carrydownChangeDocum
double[] docPriorities)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Requeue a document set because of carrydown changes.
- This method is called when carrydown data is modified for a set of documents. The documents must be requeued for immediate reprocessing, even to the
+<DD>Requeue a document set because of carrydown changes.
+ This method is called when carrydown data is modified for a set of documents. The documents must be requeued for immediate reprocessing, even to the
extent that if one is *already* being processed, it will need to be done over again.
<P>
<DD><DL>
@@ -3362,8 +3362,8 @@ public boolean <B>carrydownChangeDocumen
double docPriority)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Requeue a document because of carrydown changes.
- This method is called when carrydown data is modified for a document. The document must be requeued for immediate reprocessing, even to the
+<DD>Requeue a document because of carrydown changes.
+ This method is called when carrydown data is modified for a document. The document must be requeued for immediate reprocessing, even to the
extent that if it is *already* being processed, it will need to be done over again.
<P>
<DD><DL>
@@ -3462,11 +3462,11 @@ public void <B>startJobs</B>(long c
java.util.ArrayList unwaitList)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Start all jobs in need of starting.
- This method marks all the appropriate jobs as "in progress", which is all that should be
- needed to start them.
- It's also the case that the start event should be logged in the event log. In order to make it possible for
- the caller to do this logging, a set of job ID's will be returned containing the jobs that
+<DD>Start all jobs in need of starting.
+ This method marks all the appropriate jobs as "in progress", which is all that should be
+ needed to start them.
+ It's also the case that the start event should be logged in the event log. In order to make it possible for
+ the caller to do this logging, a set of job ID's will be returned containing the jobs that
were started.
<P>
<DD><DL>
@@ -3506,7 +3506,7 @@ resetJobSchedule</H3>
public void <B>resetJobSchedule</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset job schedule. This re-evaluates whether the job should be started now. This method would typically
+<DD>Reset job schedule. This re-evaluates whether the job should be started now. This method would typically
be called after a job's scheduling window has been changed.
<P>
<DD><DL>
@@ -3541,7 +3541,7 @@ protected static java.lang.Long <B>check
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startTime</CODE> - is the start time.<DD><CODE>currentTimestamp</CODE> - is the end time.<DD><CODE>daysOfWeek</CODE> - is the enumerated days of the week, or null.<DD><CODE>daysOfMonth</CODE> - is the enumerated days of the month, or null.<DD><CODE>months</CODE> - is the enumerated months, or null.<DD><CODE>years</CODE> - is the enumerated years, or null.<DD><CODE>hours</CODE> - is the enumerated hours, or null.<DD><CODE>minutes</CODE> - is the enumerated minutes, or null.
-<DT><B>Returns:</B><DD>null if there is NO hit within the interval; otherwise the actual time of the hit in milliseconds
+<DT><B>Returns:</B><DD>null if there is NO hit within the interval; otherwise the actual time of the hit in milliseconds
from epoch is returned.</DL>
</DD>
</DL>
@@ -3553,8 +3553,8 @@ manualStart</H3>
public void <B>manualStart</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Manually start a job. The specified job will be run REGARDLESS of the timed windows, and
- will not cease until complete. If the job is already running, this operation will assure that
+<DD>Manually start a job. The specified job will be run REGARDLESS of the timed windows, and
+ will not cease until complete. If the job is already running, this operation will assure that
the job does not pause when its window ends. The job can be manually paused, or manually aborted.
<P>
<DD><DL>
@@ -3695,7 +3695,7 @@ manualAbort</H3>
public void <B>manualAbort</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Manually abort a running job. The job will be permanently stopped, and will not run again until
+<DD>Manually abort a running job. The job will be permanently stopped, and will not run again until
automatically started based on schedule, or manually started.
<P>
<DD><DL>
@@ -3715,7 +3715,7 @@ manualAbortRestart</H3>
public void <B>manualAbortRestart</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Manually restart a running job. The job will be stopped and restarted. Any schedule affinity will be lost,
+<DD>Manually restart a running job. The job will be stopped and restarted. Any schedule affinity will be lost,
until the job finishes on its own.
<P>
<DD><DL>
@@ -3801,7 +3801,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time in milliseconds since epoch.
-<DT><B>Returns:</B><DD>jobs that are active and are running in adaptive mode. These will be seeded
+<DT><B>Returns:</B><DD>jobs that are active and are running in adaptive mode. These will be seeded
based on what the connector says should be added to the queue.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3874,7 +3874,7 @@ resetStartDeleteJob</H3>
public void <B>resetStartDeleteJob</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a job starting for delete back to "ready for delete"
+<DD>Reset a job starting for delete back to "ready for delete"
state.
<P>
<DD><DL>
@@ -3894,7 +3894,7 @@ resetNotifyJob</H3>
public void <B>resetNotifyJob</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset a job that is notifying back to "ready for notify"
+<DD>Reset a job that is notifying back to "ready for notify"
state.
<P>
<DD><DL>
@@ -3952,7 +3952,7 @@ deleteJobsReadyForDelete</H3>
public void <B>deleteJobsReadyForDelete</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Delete jobs in need of being deleted (which are marked "ready for delete").
+<DD>Delete jobs in need of being deleted (which are marked "ready for delete").
This method is meant to be called periodically to perform delete processing on jobs.
<P>
<DD><DL>
@@ -4012,8 +4012,8 @@ public void <B>finishJobResumes</B>(long
java.util.ArrayList modifiedJobs)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Complete the sequence that resumes jobs, either from a pause or from a scheduling window
- wait. The logic will restore the job to an active state (many possibilities depending on
+<DD>Complete the sequence that resumes jobs, either from a pause or from a scheduling window
+ wait. The logic will restore the job to an active state (many possibilities depending on
connector status), and will record the jobs that have been so modified.
<P>
<DD><DL>
@@ -4034,8 +4034,8 @@ public void <B>finishJobStops</B>(long&n
java.util.ArrayList modifiedJobs)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
- window. The logic will move the job to its next state (INACTIVE, PAUSED, ACTIVEWAIT),
+<DD>Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
+ window. The logic will move the job to its next state (INACTIVE, PAUSED, ACTIVEWAIT),
and will record the jobs that have been so modified.
<P>
<DD><DL>
@@ -4056,10 +4056,10 @@ public void <B>resetJobs</B>(long c
java.util.ArrayList resetJobs)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset eligible jobs either back to the "inactive" state, or make them active again. The
- latter will occur if the cleanup phase of the job generated more pending documents.
-
- This method is used to pick up all jobs in the shutting down state
+<DD>Reset eligible jobs either back to the "inactive" state, or make them active again. The
+ latter will occur if the cleanup phase of the job generated more pending documents.
+
+ This method is used to pick up all jobs in the shutting down state
whose purgatory or being-cleaned records have been all processed.
<P>
<DD><DL>
@@ -4273,7 +4273,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>connectionName</CODE> - is the name of the connection.<DD><CODE>filterCriteria</CODE> - are the criteria used to limit the records considered for the report.<DD><CODE>sortOrder</CODE> - is the specified sort order of the final report.<DD><CODE>startRow</CODE> - is the first row to include.<DD><CODE>rowCount</CODE> - is the number of rows to include.
-<DT><B>Returns:</B><DD>the results, with the following columns: identifier, job, state, status, scheduled, action, retrycount, retrylimit. The "scheduled" column and the
+<DT><B>Returns:</B><DD>the results, with the following columns: identifier, job, state, status, scheduled, action, retrycount, retrylimit. The "scheduled" column and the
"retrylimit" column are long values representing a time; all other values will be user-friendly strings.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -4299,7 +4299,7 @@ public <A HREF="../../../../../org/apach
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>connectionName</CODE> - is the name of the connection.<DD><CODE>filterCriteria</CODE> - are the criteria used to limit the records considered for the report.<DD><CODE>sortOrder</CODE> - is the specified sort order of the final report.<DD><CODE>idBucketDescription</CODE> - is the bucket description for generating the identifier class.<DD><CODE>startRow</CODE> - is the first row to include.<DD><CODE>rowCount</CODE> - is the number of rows to include.
-<DT><B>Returns:</B><DD>the results, with the following columns: idbucket, inactive, processing, expiring, deleting,
+<DT><B>Returns:</B><DD>the results, with the following columns: idbucket, inactive, processing, expiring, deleting,
processready, expireready, processwaiting, expirewaiting
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -4316,8 +4316,8 @@ protected void <B>addBucketExtract</B>(j
java.lang.String columnName,
<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/BucketDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">BucketDescription</A> bucketDesc)</PRE>
<DL>
-<DD>Turn a bucket description into a return column.
- This is complicated by the fact that the extraction code is inherently case sensitive. So if case insensitive is
+<DD>Turn a bucket description into a return column.
+ This is complicated by the fact that the extraction code is inherently case sensitive. So if case insensitive is
desired, that means we whack the whole thing to lower case before doing the match.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.DuplicateFinder.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.DuplicateFinder.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.DuplicateFinder.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.DuplicateFinder.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
JobQueue.DuplicateFinder
</TITLE>
@@ -190,7 +190,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/jobs/JobQueue.DuplicateFinder.html#doesCompareWork()">doesCompareWork</A></B>()</CODE>
<BR>
- See if this class can be legitimately compared against another of
+ See if this class can be legitimately compared against another of
the same type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -291,7 +291,7 @@ doesCompareWork</H3>
<PRE>
public boolean <B>doesCompareWork</B>()</PRE>
<DL>
-<DD>See if this class can be legitimately compared against another of
+<DD>See if this class can be legitimately compared against another of
the same type.
<P>
<DD><DL>
@@ -309,8 +309,8 @@ duplicate</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ILimitChecker.html" title="interface in org.apache.manifoldcf.core.interfaces">ILimitChecker</A> <B>duplicate</B>()</PRE>
<DL>
-<DD>Create a duplicate of this class instance. All current state should be preserved.
- NOTE: Since doesCompareWork() returns false, queries using this limit checker cannot
+<DD>Create a duplicate of this class instance. All current state should be preserved.
+ NOTE: Since doesCompareWork() returns false, queries using this limit checker cannot
be cached, and therefore duplicate() is never called from the query executor.
<P>
<DD><DL>
@@ -328,7 +328,7 @@ hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
-<DD>Find the hashcode for this class. This will only ever be used if
+<DD>Find the hashcode for this class. This will only ever be used if
doesCompareWork() returns true.
<P>
<DD><DL>
@@ -346,7 +346,7 @@ equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object object)</PRE>
<DL>
-<DD>Compare two objects and see if equal. This will only ever be used
+<DD>Compare two objects and see if equal. This will only ever be used
if doesCompareWork() returns true.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/JobQueue.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
JobQueue
</TITLE>
@@ -101,26 +101,26 @@ java.lang.Object
</PRE>
<P>
-This is the job queue manager class. It is responsible for managing the jobqueue database table.
-
- <br><br>
- <b>jobqueue</b>
- <table border="1" cellpadding="3" cellspacing="0">
- <tr class="TableHeadingColor">
- <th>Field</th><th>Type</th><th>Description </th>
- <tr><td>id</td><td>BIGINT</td><td>Primary Key</td></tr>
- <tr><td>jobid</td><td>BIGINT</td><td>Reference:jobs.id</td></tr>
- <tr><td>dochash</td><td>VARCHAR(40)</td><td></td></tr>
- <tr><td>docid</td><td>LONGTEXT</td><td></td></tr>
- <tr><td>checktime</td><td>BIGINT</td><td></td></tr>
- <tr><td>failtime</td><td>BIGINT</td><td></td></tr>
- <tr><td>failcount</td><td>BIGINT</td><td></td></tr>
- <tr><td>status</td><td>CHAR(1)</td><td></td></tr>
- <tr><td>isseed</td><td>CHAR(1)</td><td></td></tr>
- <tr><td>docpriority</td><td>FLOAT</td><td></td></tr>
- <tr><td>priorityset</td><td>BIGINT</td><td></td></tr>
- <tr><td>checkaction</td><td>CHAR(1)</td><td></td></tr>
- </table>
+This is the job queue manager class. It is responsible for managing the jobqueue database table.
+
+ <br><br>
+ <b>jobqueue</b>
+ <table border="1" cellpadding="3" cellspacing="0">
+ <tr class="TableHeadingColor">
+ <th>Field</th><th>Type</th><th>Description </th>
+ <tr><td>id</td><td>BIGINT</td><td>Primary Key</td></tr>
+ <tr><td>jobid</td><td>BIGINT</td><td>Reference:jobs.id</td></tr>
+ <tr><td>dochash</td><td>VARCHAR(40)</td><td></td></tr>
+ <tr><td>docid</td><td>LONGTEXT</td><td></td></tr>
+ <tr><td>checktime</td><td>BIGINT</td><td></td></tr>
+ <tr><td>failtime</td><td>BIGINT</td><td></td></tr>
+ <tr><td>failcount</td><td>BIGINT</td><td></td></tr>
+ <tr><td>status</td><td>CHAR(1)</td><td></td></tr>
+ <tr><td>isseed</td><td>CHAR(1)</td><td></td></tr>
+ <tr><td>docpriority</td><td>FLOAT</td><td></td></tr>
+ <tr><td>priorityset</td><td>BIGINT</td><td></td></tr>
+ <tr><td>checkaction</td><td>CHAR(1)</td><td></td></tr>
+ </table>
<br><br>
<P>
@@ -1328,8 +1328,8 @@ restart</H3>
public void <B>restart</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Restart.
- This method should be called at initial startup time. It resets the status of all documents to something
+<DD>Restart.
+ This method should be called at initial startup time. It resets the status of all documents to something
reasonable, so the jobs can be restarted and work properly to completion.
<P>
<DD><DL>
@@ -1346,8 +1346,8 @@ clearFailTimes</H3>
public void <B>clearFailTimes</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Clear the failtimes for all documents associated with a job.
- This method is called when the system detects that a significant delaying event has occurred,
+<DD>Clear the failtimes for all documents associated with a job.
+ This method is called when the system detects that a significant delaying event has occurred,
and therefore the "failure clock" needs to be reset.
<P>
<DD><DL>
@@ -1364,9 +1364,9 @@ resetDocumentWorkerStatus</H3>
public void <B>resetDocumentWorkerStatus</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset as part of restoring document worker threads.
- This will get called if something went wrong that could have screwed up the
- status of a worker thread. The threads all die/end, and this method
+<DD>Reset as part of restoring document worker threads.
+ This will get called if something went wrong that could have screwed up the
+ status of a worker thread. The threads all die/end, and this method
resets any active documents back to the right state (waiting for stuffing).
<P>
<DD><DL>
@@ -1415,10 +1415,10 @@ prepareDeleteScan</H3>
public void <B>prepareDeleteScan</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Prepare for a job delete pass. This will not be called
- unless the job is in an INACTIVE state.
- Does the following:
- (1) Delete PENDING entries
+<DD>Prepare for a job delete pass. This will not be called
+ unless the job is in an INACTIVE state.
+ Does the following:
+ (1) Delete PENDING entries
(2) Maps PENDINGPURGATORY, PURGATORY, and COMPLETED entries to ELIGIBLEFORDELETE
<P>
<DD><DL>
@@ -1435,11 +1435,11 @@ prepareFullScan</H3>
public void <B>prepareFullScan</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Prepare for a "full scan" job. This will not be called
- unless the job is in the "INACTIVE" state.
- This does the following:
- (1) get rid of all PENDING entries.
- (2) map PENDINGPURGATORY entries to PURGATORY.
+<DD>Prepare for a "full scan" job. This will not be called
+ unless the job is in the "INACTIVE" state.
+ This does the following:
+ (1) get rid of all PENDING entries.
+ (2) map PENDINGPURGATORY entries to PURGATORY.
(4) map COMPLETED entries to PURGATORY.
<P>
<DD><DL>
@@ -1456,11 +1456,11 @@ prepareIncrementalScan</H3>
public void <B>prepareIncrementalScan</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Prepare for an "incremental" job. This is called ONLY when the job is inactive;
- that is, there should be no ACTIVE or ACTIVEPURGATORY entries at all.
-
- The preparation for starting an incremental job is to requeue all documents that are
- currently in the system that are marked "COMPLETE". These get marked as "PENDINGPURGATORY",
+<DD>Prepare for an "incremental" job. This is called ONLY when the job is inactive;
+ that is, there should be no ACTIVE or ACTIVEPURGATORY entries at all.
+
+ The preparation for starting an incremental job is to requeue all documents that are
+ currently in the system that are marked "COMPLETE". These get marked as "PENDINGPURGATORY",
since the idea is to queue them in such a way that we know they were ingested before.
<P>
<DD><DL>
@@ -1477,8 +1477,8 @@ deleteIngestedDocumentIdentifiers</H3>
public void <B>deleteIngestedDocumentIdentifiers</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>[] identifiers)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Delete ingested document identifiers (as part of deleting the owning job).
- The number of identifiers specified is guaranteed to be less than the maxInClauseCount
+<DD>Delete ingested document identifiers (as part of deleting the owning job).
+ The number of identifiers specified is guaranteed to be less than the maxInClauseCount
for the database.
<P>
<DD><DL>
@@ -1600,7 +1600,7 @@ public void <B>setStatus</B>(java.lang.L
int failCount)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Set the status on a record, including check time and priority.
+<DD>Set the status on a record, including check time and priority.
The status set MUST be a PENDING or PENDINGPURGATORY status.
<P>
<DD><DL>
@@ -1750,7 +1750,7 @@ public boolean <B>updateExistingRecordIn
java.lang.String[] prereqEvents)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Update an existing record (as the result of an initial add).
+<DD>Update an existing record (as the result of an initial add).
The record is presumed to exist and have been locked, via "FOR UPDATE".
<P>
<DD><DL>
@@ -1790,7 +1790,7 @@ public void <B>addRemainingDocumentsInit
java.lang.String[] docIDHashes)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Note the remaining documents that do NOT need to be queued. These are noted so that the
+<DD>Note the remaining documents that do NOT need to be queued. These are noted so that the
doneDocumentsInitial() method does not clean up seeds from previous runs wrongly.
<P>
<DD><DL>
@@ -1869,9 +1869,9 @@ public void <B>doneDocumentsInitial</B>(
boolean isPartial)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Complete the initial set of documents. This method converts the seeding statuses for the
- job to their steady-state values.
- SEEDSTATUS_SEED becomes SEEDSTATUS_NOTSEED, and SEEDSTATUS_NEWSEED becomes
+<DD>Complete the initial set of documents. This method converts the seeding statuses for the
+ job to their steady-state values.
+ SEEDSTATUS_SEED becomes SEEDSTATUS_NOTSEED, and SEEDSTATUS_NEWSEED becomes
SEEDSTATUS_SEED. If the seeding was partial, then all previous seeds are preserved as such.
<P>
<DD><DL>
@@ -1888,7 +1888,7 @@ getAllSeeds</H3>
public java.lang.String[] <B>getAllSeeds</B>(java.lang.Long jobID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get all the current seeds.
+<DD>Get all the current seeds.
Returns the seed document identifiers for a job.
<P>
<DD><DL>
@@ -1913,7 +1913,7 @@ public boolean <B>updateExistingRecord</
java.lang.String[] prereqEvents)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Update an existing record (as the result of a reference add).
+<DD>Update an existing record (as the result of a reference add).
The record is presumed to exist and have been locked, via "FOR UPDATE".
<P>
<DD><DL>
@@ -2050,7 +2050,7 @@ getHashCode</H3>
public static java.lang.String <B>getHashCode</B>(java.lang.String documentIdentifier)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Get a hash value from a document id string. This will convert the string into something that can fit in 20 characters.
+<DD>Get a hash value from a document id string. This will convert the string into something that can fit in 20 characters.
(Someday this will be an MD5 hash, but for now just use java hashing.)
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/Jobs.JobObjectDescription.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/Jobs.JobObjectDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/Jobs.JobObjectDescription.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/jobs/Jobs.JobObjectDescription.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:00 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:31 EDT 2012 -->
<TITLE>
Jobs.JobObjectDescription
</TITLE>
@@ -231,7 +231,7 @@ Job object description class. This clas
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/jobs/Jobs.JobObjectDescription.html#getObjectKeys()">getObjectKeys</A></B>()</CODE>
<BR>
- Get the cache keys for an object (which may or may not exist yet in
+ Get the cache keys for an object (which may or may not exist yet in
the cache).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -376,10 +376,10 @@ getCriticalSectionName</H3>
public java.lang.String <B>getCriticalSectionName</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheDescription.html#getCriticalSectionName()">ICacheDescription</A></CODE></B></DD>
-<DD>Get the critical section name for this description object.
- This is used to synchronize creation of the described object,
- and thus is used only for objects that will be cached. This
- method does not need to return decent results for objects that
+<DD>Get the critical section name for this description object.
+ This is used to synchronize creation of the described object,
+ and thus is used only for objects that will be cached. This
+ method does not need to return decent results for objects that
are never cached.
<P>
<DD><DL>
@@ -394,12 +394,12 @@ getObjectKeys</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/StringSet.html" title="class in org.apache.manifoldcf.core.interfaces">StringSet</A> <B>getObjectKeys</B>()</PRE>
<DL>
-<DD>Get the cache keys for an object (which may or may not exist yet in
+<DD>Get the cache keys for an object (which may or may not exist yet in
the cache). This method is called in order for cache manager to throw the correct locks.
<P>
<DD><DL>
-<DT><B>Returns:</B><DD>the object's cache keys, or null if the object should not
+<DT><B>Returns:</B><DD>the object's cache keys, or null if the object should not
be cached.</DL>
</DD>
</DL>