org.apache.manifoldcf.agents.interfaces

Class DocumentIngestStatusSet

java.lang.Object

org.apache.manifoldcf.agents.interfaces.DocumentIngestStatusSet

public class DocumentIngestStatusSet
extends java.lang.Object

This object contains statuses for the primary document and all component documents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected java.util.Map<java.lang.String,DocumentIngestStatus>	components
protected DocumentIngestStatus	primary

Constructor Summary

Constructors

Constructor and Description
DocumentIngestStatusSet() Constructor

Method Summary

Modifier and Type	Method and Description
void	addDocumentStatus(java.lang.String componentHash, DocumentIngestStatus status) Add document status.
java.util.Iterator<java.lang.String>	componentIterator() Iterate over components.
DocumentIngestStatus	getComponent(java.lang.String componentHash) Get component status.
DocumentIngestStatus	getPrimary() Get primary status.

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

primary

protected DocumentIngestStatus primary

components

protected final java.util.Map<java.lang.String,DocumentIngestStatus> components

Constructor Detail

DocumentIngestStatusSet

public DocumentIngestStatusSet()

Constructor

Method Detail

addDocumentStatus

public void addDocumentStatus(java.lang.String componentHash,
                              DocumentIngestStatus status)

Add document status.

Parameters:

componentHash - is the component identifier hash, or null.

status - is the document ingest status.

getPrimary

public DocumentIngestStatus getPrimary()

Get primary status.

Returns:

the primary status.

getComponent

public DocumentIngestStatus getComponent(java.lang.String componentHash)

Get component status.

Parameters:

componentHash - is the component identifier hash, or null.

Returns:

the component status.

componentIterator

public java.util.Iterator<java.lang.String> componentIterator()

Iterate over components.

Returns:

an iterator over component hashes.