Package org.apache.manifoldcf.agents.interfaces

Class IngestStatuses

java.lang.Object

org.apache.manifoldcf.agents.interfaces.IngestStatuses

public class IngestStatuses
extends java.lang.Object

This object is part of the IIncrementalIngester API. It is an accumulator and organizer of DocumentIngestStatus records

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IngestStatuses.OutputKey

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected java.util.Map<IngestStatuses.OutputKey,DocumentIngestStatusSet>	statuses

Constructor Summary

Constructors

Constructor	Description
IngestStatuses()

Method Summary

Modifier and Type	Method	Description
void	addStatus(java.lang.String documentClass, java.lang.String documentIDHash, java.lang.String outputConnectionName, java.lang.String componentIDHash, DocumentIngestStatus status)	Add a status record.
DocumentIngestStatusSet	getStatus(java.lang.String documentClass, java.lang.String documentIDHash, java.lang.String outputConnectionName)	Retrieve a status record.

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

statuses

protected final java.util.Map<IngestStatuses.OutputKey,DocumentIngestStatusSet> statuses

Constructor Detail

IngestStatuses

public IngestStatuses()

Method Detail

addStatus

public void addStatus(java.lang.String documentClass,
                      java.lang.String documentIDHash,
                      java.lang.String outputConnectionName,
                      java.lang.String componentIDHash,
                      DocumentIngestStatus status)

Add a status record.

Parameters:

documentClass - is the document class.

documentIDHash - is the document id's hash value.

outputConnectionName - is the output connection name.

componentIDHash - is the component ID hash value.

status - is the status.

getStatus

public DocumentIngestStatusSet getStatus(java.lang.String documentClass,
                                         java.lang.String documentIDHash,
                                         java.lang.String outputConnectionName)

Retrieve a status record.

Parameters:

documentClass - is the document class.

documentIDHash - is the document id's hash value.

outputConnectionName - is the output connection name.

Returns:

the status record, if exists.