Detailed Description

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:

Divert

Author: Sylvain Hallé

Since: 0.10

Definition at line 55 of file Divert.java.

Classes
class	DivertPushable
	Implementation of the `Pushable` interface for the `Divert` processor. More...
class	DivertPullable
	Implementation of the `Pullable` interface for the `Divert` processor. More...

Public Member Functions
	Divert ()
	Creates a new divert processor.
Divert	divertTo (int index)
	Diverts the downstream flow.
Divert	duplicate (boolean with_state)
	Duplicates an object.
synchronized void	setPushableOutput (int i, Pushable p)
	Assigns a `Pushable` to the processor's i-th output.
Pushable	getPushableInput (int index)
	Returns the `Pushable` corresponding to the processor's i-th input trace.
Pullable	getPullableOutput (int index)
	Returns the `Pullable` corresponding to the processor's i-th output trace.
Public Member Functions inherited from ca.uqac.lif.cep.Processor
	Processor (int in_arity, int out_arity)
	Initializes a processor.
final Object	getContext (String key)
	Retrieves an object from the processor's context.
Context	getContext ()
	Gets the context associated to this object.
void	setContext (String key, Object value)
	Adds an object to the object's context.
void	setContext (Context context)
	Adds a complete context to this object.
final int	hashCode ()
	Implementation of `hashCode()` specific to processors.
final boolean	equals (Object o)
	Implementation of `equals()` specific to processors.
final int	getId ()
	Fetches the processor instance's unique ID.
void	reset ()
	Resets the processor.
final Pushable	getPushableInput ()
	Returns the `Pushable` corresponding to the processor's first input trace.
final Pullable	getPullableOutput ()
	Returns the `Pullable` corresponding to the processor's first output trace.
void	setPullableInput (int i, Pullable p)
	Assigns a `Pullable` to the processor's i-th input.
Pullable	getPullableInput (int i)
	Returns the `Pullable` corresponding to the processor's i-th input.
Pushable	getPushableOutput (int i)
	Retrieves the `Pushable` associated to the processor's i-th output.
final int	getInputArity ()
	Returns the processor's input arity.
final int	getOutputArity ()
	Returns the processor's output arity.
void	duplicateInto (Processor p)
	Copies the contents and state of the current processor into another.
final Set< Class<?> >	getInputType (int index)
	Gets the type of events the processor accepts for its i-th input trace.
void	getInputTypesFor (Set< Class<?> > classes, int index)
	Populates the set of classes accepted by the processor for its i-th input.
Class<?>	getOutputType (int index)
	Returns the type of the events produced by the processor for its i-th output.
void	start ()
	Starts the processor.
void	stop ()
	Stops the processor.
final EventTracker	getEventTracker ()
	Gets the instance of event tracker associated to this processor.
Processor	setEventTracker (EventTracker tracker)
	Associates an event tracker to this processor.
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.
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.
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.
final int	getInputCount ()
	Gets the number of event fronts received so far by this processor.
final int	getOutputCount ()
	Gets the number of event fronts produced so far by this processor.
final Object	print (ObjectPrinter<?> printer) throws ProcessorException
	Prints the contents of this processor into an object printer.
final Processor	read (ObjectReader<?> reader, Object o) throws ProcessorException
	Reads the content of a processor from a serialized object.
final Processor	duplicate ()
	Duplicates an object and sets it to its initial state.
void	copyInputQueue (int index, Collection< Object > to)
	Copies the content of one of the processor's input queue to a collection.
void	copyOutputQueue (int index, Collection< Object > to)
	Copies the content of one of the processor's output queue to a collection.
Processor	or (Processor p)
	Connects the first output pipe of this processor to the first input pipe of another processor.
Processor	or (CallAfterConnect c)
	Operates similar to `or(Processor)`, but also calls a method after the connection has been established.
Processor	or (SelectedInputPipe p)
	Connects the output at index 0 of the current processor to the input of another processor.
PipeSelector	getAt (int index)
	Gets the `PipeSelector` object corresponding to the processor's input or output pipe for a given index.
Pushable	rightShift (int index)
Pullable	leftShift (int index)
Queue< Object >	getInputQueue (int index)
	Gets the content of the processor's input queue at a given index.
Queue< Object >	getOutputQueue (int index)
	Gets the content of the processor's output queue at a given index.

Protected Attributes
List< Pushable >	m_downstreamPushables
	The list of downstream `Pushable`s connected to this processor.
Pushable	m_inputPushable
	The `Pushable` connected to the upstream processor.
Pullable	m_outputPullable
	The instance of the special `Pullable` given to all downstream processors.
int	m_flowIndex = 0
	The index of the flow the input stream will be diverted to.
Protected Attributes inherited from ca.uqac.lif.cep.Processor
int	m_inputArity
	The processor's input arity, i.e.
int	m_outputArity
	The processor's output arity, i.e.
transient Queue< Object >[]	m_inputQueues
	An array of input event queues.
transient EventTracker	m_eventTracker = null
	An object that keeps track of the relationship between input and output events.
transient Queue< Object >[]	m_outputQueues
	An array of output event queues.
transient Pullable[]	m_inputPullables
	An array of `Pullable`s, one for each input trace this processor receives.
transient Pushable[]	m_outputPushables
	An array of `Pushable`s, one for each output trace this processor produces.
int	m_inputCount = 0
	A counter incremented upon each input front processed.
int	m_outputCount = 0
	A counter incremented upon each output front processed.
Context	m_context = null
	The context in which the processor is instantiated.
boolean[]	m_hasBeenNotifiedOfEndOfTrace
	Indicates whether the processor has been notified of the end of trace or not.
boolean	m_notifiedEndOfTraceDownstream
	Indicates whether the processor has notified the end of the trace to the downstream processors it is connected to.

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.
static Queue< Object[]>	getEmptyQueue ()
	Gets an instance of an empty event queue.
static void	startAll (Processor ... procs)
	Starts all processors given as an argument.
static void	stopAll (Processor ... procs)
	Stops all processors given as an argument.
static List< ProvenanceNode >	getLeaves (ProvenanceNode root)
	Gets the leaves of a provenance tree.
Static Public Attributes inherited from ca.uqac.lif.cep.Processor
static final transient String	s_versionString = "0.11.2"
	A string used to identify the program's version.
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.
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.
final Context	newContext ()
	Creates a new empty context map.
boolean	onEndOfTrace (Queue< Object[]> outputs) throws ProcessorException
	Allows to describe a specific behavior when the trace of input fronts has reached its end.
Object	printState ()
	Produces an object that represents the state of the current processor.
Processor	readState (Object o)
	Reads the state of a processor and uses it to create a new instance.
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.

Constructor & Destructor Documentation

◆ Divert()

ca.uqac.lif.cep.tmf.Divert.Divert ( )

Creates a new divert processor.

Definition at line 81 of file Divert.java.

Member Function Documentation

◆ divertTo()

Divert ca.uqac.lif.cep.tmf.Divert.divertTo ( int index )

Diverts the downstream flow.

Parameters

index The index of the flow to divert the output to

Returns: This processor

Definition at line 94 of file Divert.java.

◆ duplicate()

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.

Parameters

with_state Set to true to replicate the object's state, false to create a new copy in the initial state.

Returns: Another object

Reimplemented from ca.uqac.lif.cep.Processor.

Definition at line 101 of file Divert.java.

◆ getPullableOutput()

Pullable ca.uqac.lif.cep.tmf.Divert.getPullableOutput ( int index )

Returns the Pullable corresponding to the processor's i-th output trace.

Parameters

index The index. Should be between 0 and the processor's output arity - 1 (since indices start at 0).

Returns: The pullable if the index is within the appropriate range, null otherwise.

Reimplemented from ca.uqac.lif.cep.Processor.

Definition at line 128 of file Divert.java.

◆ getPushableInput()

Pushable ca.uqac.lif.cep.tmf.Divert.getPushableInput ( int index )

Returns the Pushable corresponding to the processor's i-th input trace.

Parameters

index The index. Should be between 0 and the processor's input arity - 1 (since indices start at 0).

Returns: The pushable if the index is within the appropriate range. Outside of the range,

Reimplemented from ca.uqac.lif.cep.Processor.

Definition at line 113 of file Divert.java.

◆ setPushableOutput()

synchronized void ca.uqac.lif.cep.tmf.Divert.setPushableOutput	(	int	i,
		Pushable	p )

Assigns a Pushable to the processor's i-th output.

Parameters

i	The index of the output. Should be greater than 0 and less than the processor's output arity. Outside these bounds, an ArrayIndexOutOfBounds will be thrown.
p	The pushable to assign it to

Reimplemented from ca.uqac.lif.cep.Processor.

Definition at line 107 of file Divert.java.

Member Data Documentation

◆ m_downstreamPushables

List<Pushable> ca.uqac.lif.cep.tmf.Divert.m_downstreamPushables

protected

The list of downstream Pushables connected to this processor.

Definition at line 60 of file Divert.java.

◆ m_flowIndex

int ca.uqac.lif.cep.tmf.Divert.m_flowIndex = 0

protected

The index of the flow the input stream will be diverted to.

Definition at line 76 of file Divert.java.

◆ m_inputPushable

Pushable ca.uqac.lif.cep.tmf.Divert.m_inputPushable

protected

The Pushable connected to the upstream processor.

Definition at line 65 of file Divert.java.

◆ m_outputPullable

Pullable ca.uqac.lif.cep.tmf.Divert.m_outputPullable

protected

The instance of the special Pullable given to all downstream processors.

Definition at line 71 of file Divert.java.

The documentation for this class was generated from the following file:

/home/sylvain/Workspaces/beepbeep/core/src/ca/uqac/lif/cep/tmf/Divert.java

Detailed Description

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Divert()

Member Function Documentation

◆ divertTo()

◆ duplicate()

◆ getPullableOutput()

◆ getPushableInput()

◆ setPushableOutput()

Member Data Documentation

◆ m_downstreamPushables

◆ m_flowIndex

◆ m_inputPushable

◆ m_outputPullable