Package com.yahoo.docproc
Class Call
- java.lang.Object
-
- com.yahoo.docproc.Call
-
- All Implemented Interfaces:
java.lang.Cloneable
public class Call extends java.lang.Object implements java.lang.Cloneable
A document processor to call - an item on aCallStack
.- Author:
- bratseth, Einar M R Rosenvinge
-
-
Constructor Summary
Constructors Constructor Description Call(DocumentProcessor processor)
Call(DocumentProcessor processor, com.yahoo.statistics.Statistics manager, com.yahoo.jdisc.Metric metric)
Creates a new call to a processor with no arguments.Call(DocumentProcessor processor, java.lang.String chainName, com.yahoo.statistics.Statistics manager, com.yahoo.jdisc.Metric metric)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentProcessor.Progress
call(Processing processing)
Call the DocumentProcessor of this call.java.lang.Object
clone()
com.yahoo.document.DocumentPut
configDoc(DocumentProcessor docProc, com.yahoo.document.DocumentPut documentPut)
The Document object the proc should work on.DocumentProcessor
getDocumentProcessor()
Returns the processor to call.com.yahoo.component.ComponentId
getDocumentProcessorId()
Returns the ID of the processor to call.java.lang.String
toString()
-
-
-
Constructor Detail
-
Call
public Call(DocumentProcessor processor)
-
Call
public Call(DocumentProcessor processor, com.yahoo.statistics.Statistics manager, com.yahoo.jdisc.Metric metric)
Creates a new call to a processor with no arguments.- Parameters:
processor
- the document processor to call
-
Call
public Call(DocumentProcessor processor, java.lang.String chainName, com.yahoo.statistics.Statistics manager, com.yahoo.jdisc.Metric metric)
-
-
Method Detail
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
-
getDocumentProcessor
public DocumentProcessor getDocumentProcessor()
Returns the processor to call.- Returns:
- a reference to the processor to call
-
getDocumentProcessorId
public com.yahoo.component.ComponentId getDocumentProcessorId()
Returns the ID of the processor to call.- Returns:
- the ID of the processor to call
-
configDoc
public com.yahoo.document.DocumentPut configDoc(DocumentProcessor docProc, com.yahoo.document.DocumentPut documentPut)
The Document object the proc should work on. Normally the one in arguments, but could be a proxy object if schema mapping or @Accesses is in effect.Public for testing
-
call
public DocumentProcessor.Progress call(Processing processing)
Call the DocumentProcessor of this call.- Parameters:
processing
- the Processing object to use- Returns:
- the progress of the DocumentProcessor that was called
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-