Package com.yahoo.docproc

Class Call

java.lang.Object
com.yahoo.docproc.Call
All Implemented Interfaces:
Cloneable
public class Call extends Object implements Cloneable
A document processor to call - an item on a CallStack.
Author:
bratseth, Einar M R Rosenvinge

  • Constructor Details

    • Call

      public Call(DocumentProcessor processor)

    • Call

      public Call(DocumentProcessor processor, 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, String chainName, com.yahoo.jdisc.Metric metric)

  • Method Details

    • clone

      public Object clone()
      Overrides:
      clone in class 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 String toString()
      Overrides:
      toString in class Object