Detailed Description

Joins multiple sources as a single one.

The splice processor is given multiple input traces. It feeds the events of the first one until it does not yield any new event. Then it starts feeding events of the second one, and so on.

Currently, the splicer is implemented as a 0:n processor, and the processors it is given must have an input arity of 0.

Author: Sylvain Hallé

Since: 0.3

Definition at line 37 of file Splice.java.

Public Member Functions
	Splice (Processor ... processors)
	Creates a new Splice processor.
void	reset ()
	Resets the processor.
void	setContext (Context context)
	Adds a complete context to this object.
void	setContext (String key, Object value)
	Adds an object to the object's context.
Splice	duplicate (boolean with_state)
	Duplicates an object.
void	stop ()
	Stops the processor.
Public Member Functions inherited from ca.uqac.lif.cep.tmf.Source
	Source (int out_arity)
final void	push ()
	Tells the source to push events into the pipeline.
Public Member Functions inherited from ca.uqac.lif.cep.SynchronousProcessor
	SynchronousProcessor (int in_arity, int out_arity)
	Initializes a processor.
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.
final SynchronousProcessor	setEventTracker (EventTracker tracker)
	Associates an event tracker to this processor.
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.
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.
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.
void	setPushableOutput (int i, Pushable p)
	Assigns a `Pushable` to the processor's i-th output.
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.
final EventTracker	getEventTracker ()
	Gets the instance of event tracker associated 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 Member Functions
void	setPullablesTo (int index)
boolean	compute (Object[] inputs, Queue< Object[]> outputs)
	Computes one or more output events from its input events.
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.

Protected Attributes
Processor[]	m_processors
	The list of processors to splice together.
int	m_processorIndex
	The index of the processor we are currently reading from.
transient Pullable[]	m_pullables
	The pullables of the processor we are currently reading from.
Protected Attributes inherited from ca.uqac.lif.cep.SynchronousProcessor
final transient Queue< Object[]>	m_tempQueue
	A queue object that will be passed to the `compute(Object[], Queue)` method.
final transient Pushable[]	m_inputPushables
	An array of input pushables.
transient Pullable[]	m_outputPullables
	An array of output pullables.
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.
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

◆ Splice()

ca.uqac.lif.cep.tmf.Splice.Splice ( Processor ... processors )

Creates a new Splice processor.

Parameters

processors A list of processors to splice

Definition at line 58 of file Splice.java.

Member Function Documentation

◆ compute()

boolean ca.uqac.lif.cep.tmf.Splice.compute	(	Object[]	inputs,
		Queue< Object[]>	outputs )

protected

Computes one or more output events from its input events.

Parameters

inputs	An array of input events; its length corresponds to the processor's input arity
outputs	A queue of arrays of objects. The processor should push arrays into this queue for every output front it produces. The size of each array should be equal to the processor's output arity, although this is not enforced.

Returns: true if this processor may output other events in the future, false otherwise

Reimplemented from ca.uqac.lif.cep.SynchronousProcessor.

Definition at line 110 of file Splice.java.

◆ duplicate()

Splice ca.uqac.lif.cep.tmf.Splice.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 152 of file Splice.java.

◆ reset()

void ca.uqac.lif.cep.tmf.Splice.reset ( )

Resets the processor.

This has for effect of flushing the contents of all input and output event queues. If the processor has an internal state, this should also reset this state to its "initial" settings (whatever that means in your context).

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

Definition at line 77 of file Splice.java.

◆ setContext() [1/2]

void ca.uqac.lif.cep.tmf.Splice.setContext ( Context context )

Adds a complete context to this object.

Parameters

context The context to add

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

Definition at line 89 of file Splice.java.

◆ setContext() [2/2]

void ca.uqac.lif.cep.tmf.Splice.setContext	(	String	key,
		Object	value )

Adds an object to the object's context.

Parameters

key	The key associated to that object
value	The object

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

Definition at line 99 of file Splice.java.

◆ setPullablesTo()

void ca.uqac.lif.cep.tmf.Splice.setPullablesTo ( int index )

protected

Definition at line 67 of file Splice.java.

◆ stop()

void ca.uqac.lif.cep.tmf.Splice.stop ( )

Stops the processor.

This has no effect, except for processors that use threads; in such a case, calling this method should stop the thread.

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

Definition at line 158 of file Splice.java.

Member Data Documentation

◆ m_processorIndex

int ca.uqac.lif.cep.tmf.Splice.m_processorIndex

protected

The index of the processor we are currently reading from.

Definition at line 47 of file Splice.java.

◆ m_processors

Processor [] ca.uqac.lif.cep.tmf.Splice.m_processors

protected

The list of processors to splice together.

Definition at line 42 of file Splice.java.

◆ m_pullables

transient Pullable [] ca.uqac.lif.cep.tmf.Splice.m_pullables

protected

The pullables of the processor we are currently reading from.

Definition at line 52 of file Splice.java.

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

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Splice()

Member Function Documentation

◆ compute()

◆ duplicate()

◆ reset()

◆ setContext() [1/2]

◆ setContext() [2/2]

◆ setPullablesTo()

◆ stop()

Member Data Documentation

◆ m_processorIndex

◆ m_processors

◆ m_pullables