org.apache.manifoldcf.crawler.system

Class DocumentCleanupSet

java.lang.Object

org.apache.manifoldcf.crawler.system.DocumentCleanupSet

public class DocumentCleanupSet
extends java.lang.Object

This class is what's actually queued for cleanup threads. It represents an array of DocumentDescription objects, of an appropriate size to be a decent chunk. It will be processed by a single cleanup worker thread, in bulk.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected CleanupQueuedDocument[]	documents This is the array of documents to delete.
protected IJobDescription	jobDescription The job description for this set of documents.

Constructor Summary

Constructors

Constructor and Description
DocumentCleanupSet(CleanupQueuedDocument[] documents, IJobDescription jobDescription) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getCount() Get the number of documents.
CleanupQueuedDocument	getDocument(int index) Get the nth document.
IJobDescription	getJobDescription() Get the job description.

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

documents

protected CleanupQueuedDocument[] documents

This is the array of documents to delete.

jobDescription

protected IJobDescription jobDescription

The job description for this set of documents.

Constructor Detail

DocumentCleanupSet

public DocumentCleanupSet(CleanupQueuedDocument[] documents,
                          IJobDescription jobDescription)

Constructor.

Parameters:

documents - is the arraylist representing the documents for this chunk.

jobDescription - is the job description for all the documents.

Method Detail

getJobDescription

public IJobDescription getJobDescription()

Get the job description.

Returns:

the job description.

getCount

public int getCount()

Get the number of documents.

Returns:

the number.

getDocument

public CleanupQueuedDocument getDocument(int index)

Get the nth document.

Parameters:

index - is the document number.

Returns:

the document.