Package org.apache.manifoldcf.crawler.system

Class WorkerThread.DocumentReference

java.lang.Object

org.apache.manifoldcf.crawler.system.WorkerThread.DocumentReference

Enclosing class:

WorkerThread

protected static class WorkerThread.DocumentReference
extends java.lang.Object

Class describing document reference. Note: If the same document reference occurs multiple times, the data names and values should AGGREGATE, rather than the newer one replacing the older. Similar treatment will occur for prerequisites, although that's unlikely to be used.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.HashMap	data	This hashmap is keyed by data name and has a hashmap as a value (which contains the data values)
protected WorkerThread.DocumentBin	db
protected java.lang.String	localIdentifier
protected java.lang.String	localIdentifierHash
protected java.util.HashMap	prereqEvents	This hashmap contains the prerequisite event names

Constructor Summary

Constructors

Constructor	Description
DocumentReference(java.lang.String localIdentifierHash, java.lang.String localIdentifier, WorkerThread.DocumentBin db)

Method Summary

Modifier and Type	Method	Description
void	addData(java.lang.String[] dataNames, java.lang.Object[][] dataValues)
void	addData(java.lang.String dataName, java.lang.Object dataValue)
void	addData(java.lang.String dataName, java.lang.Object[] dataValues)
void	addPrerequisiteEvent(java.lang.String eventName)
void	addPrerequisiteEvents(java.lang.String[] eventNames)
void	discard()	Close all object data references.
boolean	equals(java.lang.Object o)
java.lang.String[]	getDataNames()
java.lang.Object[][]	getDataValues()
WorkerThread.DocumentBin	getKey()
java.lang.String	getLocalIdentifier()
java.lang.String	getLocalIdentifierHash()
java.lang.String[]	getPrerequisiteEventNames()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

localIdentifierHash

protected java.lang.String localIdentifierHash

localIdentifier

protected java.lang.String localIdentifier

db

protected WorkerThread.DocumentBin db

data

protected java.util.HashMap data

This hashmap is keyed by data name and has a hashmap as a value (which contains the data values)

prereqEvents

protected java.util.HashMap prereqEvents

This hashmap contains the prerequisite event names

Constructor Detail

DocumentReference

public DocumentReference(java.lang.String localIdentifierHash,
                         java.lang.String localIdentifier,
                         WorkerThread.DocumentBin db)

Method Detail

discard

public void discard()
             throws ManifoldCFException

Close all object data references. This should be called whenever a DocumentReference object is abandoned.

Throws:

ManifoldCFException

addData

public void addData(java.lang.String[] dataNames,
                    java.lang.Object[][] dataValues)

addData

public void addData(java.lang.String dataName,
                    java.lang.Object[] dataValues)

addData

public void addData(java.lang.String dataName,
                    java.lang.Object dataValue)

addPrerequisiteEvents

public void addPrerequisiteEvents(java.lang.String[] eventNames)

addPrerequisiteEvent

public void addPrerequisiteEvent(java.lang.String eventName)

getKey

public WorkerThread.DocumentBin getKey()

getLocalIdentifierHash

public java.lang.String getLocalIdentifierHash()

getLocalIdentifier

public java.lang.String getLocalIdentifier()

getPrerequisiteEventNames

public java.lang.String[] getPrerequisiteEventNames()

getDataNames

public java.lang.String[] getDataNames()

getDataValues

public java.lang.Object[][] getDataValues()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object