|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Base interface implemented by all processors.
ProcessorImpl
Method Summary | |
org.orbeon.oxf.processor.ProcessorInput |
createInput(String name)
Creates a new input on this processor. |
org.orbeon.oxf.processor.ProcessorOutput |
createOutput(String name)
Creates a new output on this processor. |
void |
deleteInput(org.orbeon.oxf.processor.ProcessorInput name)
Deletes an input previously created with createInput(String
name) |
void |
deleteOutput(org.orbeon.oxf.processor.ProcessorOutput output)
Deletes an output previously created with createOutput(String
name) |
Map |
getConnectedInputs()
|
Map |
getConnectedOutputs()
|
String |
getId()
A processor may have an "identifier". |
org.orbeon.oxf.processor.ProcessorInput |
getInputByName(String name)
|
List |
getInputsInfo()
|
LocationData |
getLocationData()
When this processor is created based on a declaration in an XML document, the LocationData provides information about the location of this declaration. |
QName |
getName()
Name of the processor, if it has been created by a factory and that factory has a name. |
org.orbeon.oxf.processor.ProcessorOutput |
getOutputByName(String name)
|
List |
getOutputsInfo()
|
void |
reset(PipelineContext context)
Resets the processor. |
void |
setId(String id)
|
void |
setLocationData(LocationData locationData)
|
void |
setName(QName name)
|
void |
start(PipelineContext context)
This method is called to trigger the execution of this processor. |
Method Detail |
public String getId()
public void setId(String id)
id
- the new id of this processorgetId()
public LocationData getLocationData()
public void setLocationData(LocationData locationData)
locationData
- the new LocationData of this processorgetLocationData()
public QName getName()
public void setName(QName name)
name
- The new name of this processorgetName()
public org.orbeon.oxf.processor.ProcessorInput createInput(String name)
name
- Name of the input to create
public void deleteInput(org.orbeon.oxf.processor.ProcessorInput name)
createInput(String
name)
name
- Name of the input to deletecreateInput(java.lang.String)
public org.orbeon.oxf.processor.ProcessorInput getInputByName(String name)
name
- Name of the input
createInput(String name)
. Returns null
if there is no existing input with this name.createInput(java.lang.String)
public org.orbeon.oxf.processor.ProcessorOutput createOutput(String name)
name
- Name of the output to create. null is allowed.
public void deleteOutput(org.orbeon.oxf.processor.ProcessorOutput output)
createOutput(String
name)
output
- Name of the output to deletecreateOutput(java.lang.String)
public org.orbeon.oxf.processor.ProcessorOutput getOutputByName(String name)
name
- Name of the output
createOutput(String name)
. Returns
null
if there is no existing output with this name.createOutput(java.lang.String)
public List getInputsInfo()
ProcessorInputOutputInfo
objects
corresponding to the inputs that can be created on this
processor. This exposes the "input API" of this processor.public List getOutputsInfo()
ProcessorInputOutputInfo
objects
corresponding to the outputs that can be created on this
processor. This exposes the "outputs API" of this processor.public Map getConnectedInputs()
ProcessorInput
objects. This is particularly
useful to detect whether optional inputs are connected.public Map getConnectedOutputs()
ProcessorOutput
objects. This is particularly
useful to detect whether optional outputs are connected.public void start(PipelineContext context)
read
should be called on the outputs instead.
context
- Context in which the processor is executedpublic void reset(PipelineContext context)
read its outputs, or by calling
start
on the processor.
- Parameters:
context
- Context in which the processor is executed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |