|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Processor
Base interface implemented by all processors.
ProcessorImpl
Method Summary | |
---|---|
ProcessorInput |
createInput(String name)
Creates a new input on this processor. |
ProcessorOutput |
createOutput(String name)
Creates a new output on this processor. |
void |
deleteInput(ProcessorInput name)
Deletes an input previously created with createInput(String
name) |
void |
deleteOutput(ProcessorOutput output)
Deletes an output previously created with createOutput(String
name) |
Map<String,List<ProcessorInput>> |
getConnectedInputs()
|
Map<String,ProcessorOutput> |
getConnectedOutputs()
|
String |
getId()
A processor may have an "identifier". |
ProcessorInput |
getInputByName(String name)
|
Set<String> |
getInputNames()
|
List<ProcessorInputOutputInfo> |
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. |
org.dom4j.QName |
getName()
Name of the processor, if it has been created by a factory and that factory has a name. |
ProcessorOutput |
getOutputByName(String name)
|
List<ProcessorInputOutputInfo> |
getOutputsInfo()
|
int |
getSequenceNumber()
TODO |
Object |
getState(PipelineContext pipelineContext)
TODO |
boolean |
isInputInCache(PipelineContext context,
String inputName)
TODO |
void |
reset(PipelineContext context)
Resets the processor. |
void |
setId(String id)
|
void |
setLocationData(LocationData locationData)
|
void |
setName(org.dom4j.QName name)
|
void |
start(PipelineContext context)
This method is called to trigger the execution of this processor. |
Method Detail |
---|
String getId()
void setId(String id)
id
- the new id of this processorgetId()
LocationData getLocationData()
void setLocationData(LocationData locationData)
locationData
- the new LocationData of this processorgetLocationData()
org.dom4j.QName getName()
void setName(org.dom4j.QName name)
name
- The new name of this processorgetName()
ProcessorInput createInput(String name)
name
- Name of the input to create
void deleteInput(ProcessorInput name)
createInput(String
name)
name
- Name of the input to deletecreateInput(java.lang.String)
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)
ProcessorOutput createOutput(String name)
name
- Name of the output to create. null is allowed.
void deleteOutput(ProcessorOutput output)
createOutput(String
name)
output
- Name of the output to deletecreateOutput(java.lang.String)
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)
List<ProcessorInputOutputInfo> getInputsInfo()
ProcessorInputOutputInfo
objects
corresponding to the inputs that can be created on this
processor. This exposes the "input API" of this processor.List<ProcessorInputOutputInfo> getOutputsInfo()
ProcessorInputOutputInfo
objects
corresponding to the outputs that can be created on this
processor. This exposes the "outputs API" of this processor.Set<String> getInputNames()
Map<String,List<ProcessorInput>> getConnectedInputs()
ProcessorInput
objects. This is particularly
useful to detect whether optional inputs are connected.Map<String,ProcessorOutput> getConnectedOutputs()
ProcessorOutput
objects. This is particularly
useful to detect whether optional outputs are connected.boolean isInputInCache(PipelineContext context, String inputName)
context
- inputName
-
Object getState(PipelineContext pipelineContext)
pipelineContext
-
void start(PipelineContext context)
read
should be called on the outputs instead.
context
- Context in which the processor is executedvoid reset(PipelineContext context)
read its outputs, or by calling
start
on the processor.
- Parameters:
context
- Context in which the processor is executed
int getSequenceNumber()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |