org.orbeon.oxf.pipeline.api
Class ProcessorDefinition

java.lang.Object
  extended byorg.orbeon.oxf.pipeline.api.ProcessorDefinition

public class ProcessorDefinition
extends Object

ProcessorDefinition encapsulate a processor name and its associated inputs. A ProcessorDefinition object can then be used to instanciate and run the given processor.


Constructor Summary
ProcessorDefinition()
           
 
Method Summary
 void addInput(String name, Element element)
          Add an input with the given name and dom4j Element.
 void addInput(String name, String url)
          Add an input with the given name and URL.
 Map getEntries()
          Return the configured mappings for the processor inputs.
 QName getName()
          Return the qualified name of the processor.
 String getUri()
          Deprecated.  
 void setName(QName name)
          Set the qualified name of the processor, for example "oxf:xslt".
 void setUri(String uri)
          Deprecated.  
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProcessorDefinition

public ProcessorDefinition()
Method Detail

setName

public void setName(QName name)
Set the qualified name of the processor, for example "oxf:xslt".

Parameters:
name - the qualified name of the processor

setUri

public void setUri(String uri)
Deprecated.  


addInput

public void addInput(String name,
                     String url)
Add an input with the given name and URL.

Parameters:
name - the name of the input, for example "config"
url - the URL that will be connected to the input, for example "oxf:/my-file.xml"

addInput

public void addInput(String name,
                     Element element)
Add an input with the given name and dom4j Element.

Parameters:
name - the name of the input, for example "config"
element - the dom4j Element containing the XML document connected to the input

getEntries

public Map getEntries()
Return the configured mappings for the processor inputs. Keys are of type String and refer to input names. Values are of type String (which must be valid URLs) or dom4j Element (containing an XML document).

Returns:
Map of name -> String or Element processor inputs mappings

getName

public QName getName()
Return the qualified name of the processor.

Returns:
the qualified name of the processor

getUri

public String getUri()
Deprecated.  


toString

public String toString()