org.apache.manifoldcf.crawler.interfaces

Interface ICarrydownActivity

All Known Subinterfaces:

IProcessActivity

All Known Implementing Classes:

WorkerThread.ProcessActivity

public interface ICarrydownActivity

This interface describes activities related to carry-down information.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	retrieveParentData(java.lang.String localIdentifier, java.lang.String dataName) Retrieve data passed from parents to a specified child document.
CharacterInput[]	retrieveParentDataAsFiles(java.lang.String localIdentifier, java.lang.String dataName) Retrieve data passed from parents to a specified child document.

Method Detail

retrieveParentData

java.lang.String[] retrieveParentData(java.lang.String localIdentifier,
                                      java.lang.String dataName)
                               throws ManifoldCFException

Retrieve data passed from parents to a specified child document.

Parameters:

localIdentifier - is the document identifier of the document we want the recorded data for.

dataName - is the name of the data items to retrieve.

Returns:

an array containing the unique data values passed from ALL parents. Note that these are in no particular order, and there will not be any duplicates.

Throws:

ManifoldCFException

retrieveParentDataAsFiles

CharacterInput[] retrieveParentDataAsFiles(java.lang.String localIdentifier,
                                           java.lang.String dataName)
                                    throws ManifoldCFException

Retrieve data passed from parents to a specified child document.

Parameters:

localIdentifier - is the document identifier of the document we want the recorded data for.

dataName - is the name of the data items to retrieve.

Returns:

an array containing the unique data values passed from ALL parents. Note that these are in no particular order, and there will not be any duplicates.

Throws:

ManifoldCFException