0.10.8-alpha
ca.uqac.lif.cep.tmf.Slice Class Reference

Concrete version of AbstractSlice whose output is an associative map between slice IDs and the last event produced by that slice processor. More...

Public Member Functions

 Slice (Function func, Processor proc, Function clean_func)
 Creates a new Slice processor. More...
 
 Slice (Function func, Processor proc)
 Creates a new Slice processor. More...
 
Object printState ()
 
Slice readState (Object o) throws ProcessorException
 
Slice duplicate (boolean with_state)
 Duplicates an object. More...
 
void reset ()
 
- Public Member Functions inherited from ca.uqac.lif.cep.tmf.AbstractSlice
 AbstractSlice (Function func, Processor proc, Function clean_func)
 Creates a new AbstractSlice processor. More...
 
AbstractSlice setProcessor (Processor p)
 Sets the processor that will be executed on each slice. More...
 
AbstractSlice explodeCollections (boolean b)
 Sets whether a slice function that returns a collection of values must be handled as individual slice IDs. More...
 
void addContextFromSlice (Processor p, Object slice)
 Adds elements to the context of a newly created slice. More...
 
void reset ()
 
int getActiveSliceCount ()
 Gets the number of slices the slicer currently handles. More...
 
Object getState ()
 
- Public Member Functions inherited from ca.uqac.lif.cep.SynchronousProcessor
 SynchronousProcessor (int in_arity, int out_arity)
 Initializes a processor. More...
 
synchronized Pushable getPushableInput (int index)
 
synchronized Pullable getPullableOutput (int index)
 
final SynchronousProcessor setEventTracker (EventTracker tracker)
 
- 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 Member Functions

 Slice ()
 Creates a dummy slice processor. More...
 
boolean produceReturn (Queue< Object[]> outputs)
 
void handleNewSliceValue (Object slice_id, Object value, Queue< Object[]> outputs)
 
- Protected Member Functions inherited from ca.uqac.lif.cep.tmf.AbstractSlice
 AbstractSlice ()
 Creates a dummy abstract slice. More...
 
boolean compute (Object[] inputs, Queue< Object[]> outputs)
 
void copyInto (AbstractSlice as, boolean with_state)
 Copies the content of the current abstract slice processor into another instance. More...
 
abstract boolean produceReturn (Queue< Object[]> outputs)
 Produces a final return value for the slice processor. More...
 
abstract void handleNewSliceValue (Object slice_id, Object value, Queue< Object[]> outputs)
 Handles the situation where one of the slices produces a new event. More...
 
- Protected Member Functions inherited from ca.uqac.lif.cep.SynchronousProcessor
abstract boolean compute (Object[] inputs, Queue< Object[]> outputs)
 Computes one or more output events from its input events. 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...
 

Protected Attributes

HashMap< Object, Object > m_lastValues
 The last value output by the processor for each slice. More...
 
- Protected Attributes inherited from ca.uqac.lif.cep.tmf.AbstractSlice
Function m_slicingFunction
 The slicing function. More...
 
Processor m_processor
 The internal processor. More...
 
Function m_cleaningFunction = null
 The cleaning function. More...
 
HashMap< Object, Processorm_slices
 A map associating slice IDs to the instance of processor associated to them. More...
 
HashMap< Object, QueueSinkm_sinks
 A map associating slice IDs to the sink that receives the events from their corresponding processor. More...
 
HashMap< Object, List< Integer > > m_sliceIndices
 A map associating slice IDs to the event positions in the input stream that have been given to each slice's processor. More...
 
boolean m_explodeArrays = false
 If the slicing function returns a collection, treat each element of the collection as a slice id. More...
 
- 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. More...
 
final transient Pushable [] m_inputPushables
 An array of input pushables. More...
 
transient Pullable [] m_outputPullables
 An array of output pullables. 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...
 
- 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...
 

Detailed Description

Concrete version of AbstractSlice whose output is an associative map between slice IDs and the last event produced by that slice processor.

Author
Sylvain Hallé
Since
0.3

Definition at line 37 of file Slice.java.

Constructor & Destructor Documentation

◆ Slice() [1/3]

ca.uqac.lif.cep.tmf.Slice.Slice ( )
protected

Creates a dummy slice processor.

This constructor is only used for deserialization purposes.

Definition at line 48 of file Slice.java.

◆ Slice() [2/3]

ca.uqac.lif.cep.tmf.Slice.Slice ( Function  func,
Processor  proc,
Function  clean_func 
)

Creates a new Slice processor.

Parameters
funcThe slicing function
procThe processor to apply on each slice
clean_funcThe cleaning function

Definition at line 60 of file Slice.java.

◆ Slice() [3/3]

ca.uqac.lif.cep.tmf.Slice.Slice ( Function  func,
Processor  proc 
)

Creates a new Slice processor.

Parameters
funcThe slicing function
procThe processor to apply on each slice

Definition at line 72 of file Slice.java.

Member Function Documentation

◆ duplicate()

Slice ca.uqac.lif.cep.tmf.Slice.duplicate ( boolean  with_state)

Duplicates an object.

Optionally, set the object into the same state as the source object.

Parameters
with_stateSet to true to replicate the object's state, false to create a new copy in the initial state.
Returns
Another object

Implements ca.uqac.lif.cep.Duplicable.

Definition at line 125 of file Slice.java.

◆ handleNewSliceValue()

void ca.uqac.lif.cep.tmf.Slice.handleNewSliceValue ( Object  slice_id,
Object  value,
Queue< Object[]>  outputs 
)
protected

Definition at line 161 of file Slice.java.

◆ printState()

Object ca.uqac.lif.cep.tmf.Slice.printState ( )
Since
0.10.2

Definition at line 81 of file Slice.java.

◆ produceReturn()

boolean ca.uqac.lif.cep.tmf.Slice.produceReturn ( Queue< Object[]>  outputs)
protected

Definition at line 153 of file Slice.java.

◆ readState()

Slice ca.uqac.lif.cep.tmf.Slice.readState ( Object  o) throws ProcessorException
Since
0.10.2

Definition at line 99 of file Slice.java.

◆ reset()

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

Definition at line 146 of file Slice.java.

Member Data Documentation

◆ m_lastValues

HashMap<Object, Object> ca.uqac.lif.cep.tmf.Slice.m_lastValues
protected

The last value output by the processor for each slice.

Definition at line 42 of file Slice.java.


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