Package org.apache.manifoldcf.crawler.interfaces

Class DocumentDescription

java.lang.Object

org.apache.manifoldcf.crawler.interfaces.DocumentDescription

public class DocumentDescription
extends java.lang.Object

This class describes a document to be fetched and processes, plus the job it's being fetched as part of, and the time beyond which a failed fetch is considered to be a hard error. It is immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected java.lang.String	documentIdentifier
protected java.lang.String	documentIdentifierHash
protected int	failRetryCount
protected long	failTime
protected java.lang.Long	id
protected java.lang.Long	jobID

Constructor Summary

Constructors

Constructor	Description
DocumentDescription(java.lang.Long id, java.lang.Long jobID, java.lang.String documentIdentifierHash, java.lang.String documentIdentifier)	Constructor.
DocumentDescription(java.lang.Long id, java.lang.Long jobID, java.lang.String documentIdentifierHash, java.lang.String documentIdentifier, long failTime, int failRetryCount)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDocumentIdentifier()	Get document identifier.
java.lang.String	getDocumentIdentifierHash()	Get document identifier hash (primary key).
int	getFailRetryCount()	Get the hard fail retry count.
long	getFailTime()	Get the hard fail time.
java.lang.Long	getID()	Get the job queue id.
java.lang.Long	getJobID()	Get the job identifier.

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

id

protected final java.lang.Long id

jobID

protected final java.lang.Long jobID

documentIdentifierHash

protected final java.lang.String documentIdentifierHash

documentIdentifier

protected final java.lang.String documentIdentifier

failTime

protected final long failTime

failRetryCount

protected final int failRetryCount

Constructor Detail

DocumentDescription

public DocumentDescription(java.lang.Long id,
                           java.lang.Long jobID,
                           java.lang.String documentIdentifierHash,
                           java.lang.String documentIdentifier)

Constructor.

Parameters:

id - is the record id.

jobID - is the job identifier for a document to be processed.

documentIdentifierHash - is the document identifier hash (primary key).

documentIdentifier - is the document identifier.

DocumentDescription

public DocumentDescription(java.lang.Long id,
                           java.lang.Long jobID,
                           java.lang.String documentIdentifierHash,
                           java.lang.String documentIdentifier,
                           long failTime,
                           int failRetryCount)

Constructor.

Parameters:

id - is the record id.

jobID - is the job identifier for a document to be processed.

documentIdentifierHash - is the document identifier hash (primary key).

documentIdentifier - is the document identifier.

failTime - is the time beyond which a failed fetch will be considered a hard error.

Method Detail

getID

public java.lang.Long getID()

Get the job queue id.

Returns:

the id.

getJobID

public java.lang.Long getJobID()

Get the job identifier.

Returns:

the job id.

getDocumentIdentifierHash

public java.lang.String getDocumentIdentifierHash()

Get document identifier hash (primary key).

getDocumentIdentifier

public java.lang.String getDocumentIdentifier()

Get document identifier.

Returns:

the identifier.

getFailTime

public long getFailTime()

Get the hard fail time.

Returns:

the fail time in ms since epoch, or -1L if none.

getFailRetryCount

public int getFailRetryCount()

Get the hard fail retry count.

Returns:

the fail retry count, or -1 if none.