org.apache.manifoldcf.crawler.system
Class CleanupQueuedDocument

java.lang.Object
  extended by org.apache.manifoldcf.crawler.system.DeleteQueuedDocument
      extended by org.apache.manifoldcf.crawler.system.CleanupQueuedDocument

public class CleanupQueuedDocument
extends DeleteQueuedDocument

This class represents a document that will be placed on the document cleanup queue, and will be processed by a cleanup worker thread.


Field Summary
static java.lang.String _rcsid
           
protected  boolean deleteFromIndex
          Flag indicating whether we should delete the document from the index or not.
 
Fields inherited from class org.apache.manifoldcf.crawler.system.DeleteQueuedDocument
documentDescription, wasProcessed
 
Constructor Summary
CleanupQueuedDocument(DocumentDescription documentDescription, boolean deleteFromIndex)
          Constructor.
 
Method Summary
 boolean shouldBeRemovedFromIndex()
          Check if document should be removed from the index.
 
Methods inherited from class org.apache.manifoldcf.crawler.system.DeleteQueuedDocument
getDocumentDescription, setProcessed, wasProcessed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_rcsid

public static final java.lang.String _rcsid
See Also:
Constant Field Values

deleteFromIndex

protected boolean deleteFromIndex
Flag indicating whether we should delete the document from the index or not.

Constructor Detail

CleanupQueuedDocument

public CleanupQueuedDocument(DocumentDescription documentDescription,
                             boolean deleteFromIndex)
Constructor.

Parameters:
documentDescription - is the document description.
Method Detail

shouldBeRemovedFromIndex

public boolean shouldBeRemovedFromIndex()
Check if document should be removed from the index.

Returns:
true if it should be removed.