 |
0.10.8-alpha
|
|
0.10.8-alpha
|
Diverts an input stream to one of many downstream processor chains. More...
Classes | |
| class | DivertPullable |
| Implementation of the Pullable interface for the Divert processor. More... | |
| class | DivertPushable |
| Implementation of the Pushable interface for the Divert processor. More... | |
Public Member Functions | |
| Divert () | |
| Creates a new divert processor. More... | |
| Divert | divertTo (int index) |
| Diverts the downstream flow. More... | |
| Divert | duplicate (boolean with_state) |
| Duplicates an object. More... | |
| synchronized void | setPushableOutput (int i, Pushable p) |
| Pushable | getPushableInput (int index) |
| Pullable | getPullableOutput (int index) |
 Public Member Functions inherited from ca.uqac.lif.cep.Processor | |
| Processor (int in_arity, int out_arity) | |
| Initializes a processor. More... | |
| final synchronized Object | getContext (String key) |
| Retrieves an object from the processor's context. More... | |
| synchronized Context | getContext () |
| Gets the context associated to this object. More... | |
| synchronized void | setContext (String key, Object value) |
| Adds an object to the object's context. More... | |
| synchronized void | setContext (Context context) |
| Adds a complete context to this object. More... | |
| final int | hashCode () |
| Implementation of hashCode() specific to processors. More... | |
| final boolean | equals (Object o) |
| Implementation of equals() specific to processors. More... | |
| final int | getId () |
| Fetches the processor instance's unique ID. More... | |
| synchronized void | reset () |
| Resets the processor. More... | |
| abstract Pushable | getPushableInput (int index) |
| Returns the Pushable corresponding to the processor's i-th input trace. More... | |
| final synchronized Pushable | getPushableInput () |
| Returns the Pushable corresponding to the processor's first input trace. More... | |
| abstract Pullable | getPullableOutput (int index) |
| Returns the Pullable corresponding to the processor's i-th output trace. More... | |
| final synchronized Pullable | getPullableOutput () |
| Returns the Pullable corresponding to the processor's first output trace. More... | |
| synchronized void | setPullableInput (int i, Pullable p) |
| Assigns a Pullable to the processor's i-th input. More... | |
| synchronized Pullable | getPullableInput (int i) |
| Returns the Pullable corresponding to the processor's i-th input. More... | |
| synchronized void | setPushableOutput (int i, Pushable p) |
| Assigns a Pushable to the processor's i-th output. More... | |
| synchronized Pushable | getPushableOutput (int i) |
| Retrieves the Pushable associated to the processor's i-th output. More... | |
| final int | getInputArity () |
| Returns the processor's input arity. More... | |
| final int | getOutputArity () |
| Returns the processor's output arity. More... | |
| void | duplicateInto (Processor p) |
| Copies the contents and state of the current processor into another. More... | |
| final Set< Class<?> > | getInputType (int index) |
| Gets the type of events the processor accepts for its i-th input trace. More... | |
| void | getInputTypesFor (Set< Class<?>> classes, int index) |
| Populates the set of classes accepted by the processor for its i-th input. More... | |
| Class<?> | getOutputType (int index) |
| Returns the type of the events produced by the processor for its i-th output. More... | |
| void | start () |
| Starts the processor. More... | |
| void | stop () |
| Stops the processor. More... | |
| final EventTracker | getEventTracker () |
| Gets the instance of event tracker associated to this processor. More... | |
| Processor | setEventTracker (EventTracker tracker) |
| Associates an event tracker to this processor. More... | |
| void | associateToInput (int in_stream_index, int in_stream_pos, int out_stream_index, int out_stream_pos) |
| Associates an input event to an output event. More... | |
| void | associateTo (NodeFunction f, int out_stream_index, int out_stream_pos) |
| Associates a node function to a particular event of processor's output stream. More... | |
| void | associateToOutput (int in_stream_index, int in_stream_pos, int out_stream_index, int out_stream_pos) |
| Associates an input event to an output event. More... | |
| final int | getInputCount () |
| Gets the number of event fronts received so far by this processor. More... | |
| final int | getOutputCount () |
| Gets the number of event fronts produced so far by this processor. More... | |
| final Object | print (ObjectPrinter<?> printer) throws ProcessorException |
| Prints the contents of this processor into an object printer. More... | |
| final Processor | read (ObjectReader<?> reader, Object o) throws ProcessorException |
| Reads the content of a processor from a serialized object. More... | |
| final Processor | duplicate () |
| Duplicates an object and sets it to its initial state. More... | |
| void | copyInputQueue (int index, Collection< Object > to) |
| Copies the content of one of the processor's input queue to a collection. More... | |
| void | copyOutputQueue (int index, Collection< Object > to) |
| Copies the content of one of the processor's output queue to a collection. More... | |
| abstract Processor | duplicate (boolean with_state) |
| Duplicates an object. More... | |
| Processor | or (Processor p) |
| Connects the first output pipe of this processor to the first input pipe of another processor. More... | |
| Processor | or (Pushable p) |
| Connects the output at index 0 of the current processor to the input of another processor. More... | |
| Pushable | getAt (int index) |
| Gets the Pushable object corresponding to the processor's input pipe for a given index. More... | |
Protected Attributes | |
| List< Pushable > | m_downstreamPushables |
| The list of downstream Pushables connected to this processor. More... | |
| Pushable | m_inputPushable |
| The Pushable connected to the upstream processor. More... | |
| Pullable | m_outputPullable |
| The instance of the special Pullable given to all downstream processors. More... | |
| int | m_flowIndex = 0 |
| The index of the flow the input stream will be diverted to. More... | |
| Protected Attributes inherited from ca.uqac.lif.cep.Processor | |
| int | m_inputArity |
| The processor's input arity, i.e. More... | |
| int | m_outputArity |
| The processor's output arity, i.e. More... | |
| transient Queue< Object > [] | m_inputQueues |
| An array of input event queues. More... | |
| transient EventTracker | m_eventTracker = null |
| An object that keeps track of the relationship between input and output events. More... | |
| transient Queue< Object > [] | m_outputQueues |
| An array of output event queues. More... | |
| transient Pullable [] | m_inputPullables |
| An array of Pullables, one for each input trace this processor receives. More... | |
| transient Pushable [] | m_outputPushables |
| An array of Pushables, one for each output trace this processor produces. More... | |
| int | m_inputCount = 0 |
| A counter incremented upon each input front processed. More... | |
| int | m_outputCount = 0 |
| A counter incremented upon each output front processed. More... | |
| Context | m_context = null |
| The context in which the processor is instantiated. More... | |
| boolean [] | m_hasBeenNotifiedOfEndOfTrace |
| Indicates whether the processor has been notified of the end of trace or not. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ca.uqac.lif.cep.Processor | |
| static boolean | allNull (Object[] v) |
| Checks if all objects in the array are null. More... | |
| static Queue< Object[]> | getEmptyQueue () |
| Gets an instance of an empty event queue. More... | |
| static void | startAll (Processor ... procs) |
| Starts all processors given as an argument. More... | |
| static void | stopAll (Processor ... procs) |
| Stops all processors given as an argument. More... | |
| static List< ProvenanceNode > | getLeaves (ProvenanceNode root) |
| Gets the leaves of a provenance tree. More... | |
| Static Public Attributes inherited from ca.uqac.lif.cep.Processor | |
| static final transient String | s_versionString = "0.10.5" |
| A string used to identify the program's version. More... | |
| static final transient int | MAX_PULL_RETRIES = 10000000 |
| Number of times the Pullable#hasNext() method tries to produce an output from the input before giving up. More... | |
| Protected Member Functions inherited from ca.uqac.lif.cep.Processor | |
| boolean | allNotifiedEndOfTrace () |
| Determines if all the upstream pushables have sent the end of trace notification. More... | |
| final Context | newContext () |
| Creates a new empty context map. More... | |
| boolean | onEndOfTrace (Queue< Object[]> outputs) throws ProcessorException |
| Allows to describe a specific behavior when the trace of input fronts has reached its end. More... | |
| Object | printState () |
| Produces an object that represents the state of the current processor. More... | |
| Processor | readState (Object o) |
| Reads the state of a processor and uses it to create a new instance. More... | |
| Static Protected Member Functions inherited from ca.uqac.lif.cep.Processor | |
| static void | getLeaves (ProvenanceNode root, List< ProvenanceNode > leaves) |
| Accumulates the leaves of a provenance tree in a list. More... | |
Diverts an input stream to one of many downstream processor chains.
More specifically, the divert processor is a 1:1 processor, to which multiple downstream processors can be linked using calls to connect(). However, only a single of them is actually "active"; that is, if one pushes an event to the Divert processor, this event will be pushed to a single one of the downstream processors. Which one is determined by a number called the "flow index"; this index can be changed at runtime using divertTo(). As a rule, each processor connected downstream to the Divert processor is given an increasing integer flow index, starting at 0 for the first downstream processor.
On the contrary, any of the connected downstream processors can pull events. An event pulled by a downstream processor will be received by this processor only; the other downstream processors are not notified of this pull.
The processor is represented graphically as:
Definition at line 56 of file Divert.java.
| ca.uqac.lif.cep.tmf.Divert.Divert | ( | ) |
Creates a new divert processor.
Definition at line 82 of file Divert.java.
| Divert ca.uqac.lif.cep.tmf.Divert.divertTo | ( | int | index | ) |
Diverts the downstream flow.
| index | The index of the flow to divert the output to |
Definition at line 95 of file Divert.java.
| Divert ca.uqac.lif.cep.tmf.Divert.duplicate | ( | boolean | with_state | ) |
Duplicates an object.
Optionally, set the object into the same state as the source object.
| with_state | Set to true to replicate the object's state, false to create a new copy in the initial state. |
Implements ca.uqac.lif.cep.Duplicable.
Definition at line 102 of file Divert.java.
| Pullable ca.uqac.lif.cep.tmf.Divert.getPullableOutput | ( | int | index | ) |
Definition at line 129 of file Divert.java.
| Pushable ca.uqac.lif.cep.tmf.Divert.getPushableInput | ( | int | index | ) |
Definition at line 114 of file Divert.java.
| synchronized void ca.uqac.lif.cep.tmf.Divert.setPushableOutput | ( | int | i, |
| Pushable | p | ||
| ) |
Definition at line 108 of file Divert.java.
|
protected |
The list of downstream Pushables connected to this processor.
Definition at line 61 of file Divert.java.
|
protected |
The index of the flow the input stream will be diverted to.
Definition at line 77 of file Divert.java.
|
protected |
The Pushable connected to the upstream processor.
Definition at line 66 of file Divert.java.
|
protected |
The instance of the special Pullable given to all downstream processors.
Definition at line 72 of file Divert.java.
1.8.13