org.apache.manifoldcf.crawler.system

Class DeleteQueuedDocument

java.lang.Object

org.apache.manifoldcf.crawler.system.DeleteQueuedDocument

Direct Known Subclasses:

CleanupQueuedDocument

public class DeleteQueuedDocument
extends java.lang.Object

This class represents a document that will be placed on the document delete queue, and will be processed by a delete or expire worker thread. The reason that DocumentDescription by itself is not used has to do with the fact that a good deal more information about the document must be obtained in order to find the last version ingested (which must be done in bulk, for performance reasons). Since we are finding everything anyway, it makes sense to put what we have in a structure so that the worker threads don't need to repeat what the stuffer thread did.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected DocumentDescription	documentDescription The document description.
protected boolean	wasProcessed This flag indicates whether the document has been processed or not.

Constructor Summary

Constructors

Constructor and Description
DeleteQueuedDocument(DocumentDescription documentDescription) Constructor.

Method Summary

Modifier and Type	Method and Description
DocumentDescription	getDocumentDescription() Get the document description.
void	setProcessed() Note that the document was processed in some way.
boolean	wasProcessed() Check if document has been processed yet.

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

documentDescription

protected DocumentDescription documentDescription

The document description.

wasProcessed

protected boolean wasProcessed

This flag indicates whether the document has been processed or not.

Constructor Detail

DeleteQueuedDocument

public DeleteQueuedDocument(DocumentDescription documentDescription)

Constructor.

Parameters:

documentDescription - is the document description.

Method Detail

getDocumentDescription

public DocumentDescription getDocumentDescription()

Get the document description.

Returns:

the document description.

wasProcessed

public boolean wasProcessed()

Check if document has been processed yet.

Returns:

true if processed, false if not.

setProcessed

public void setProcessed()

Note that the document was processed in some way.