com.espertech.esper.client.dataflow
Interface EPDataFlowInstance

All Known Implementing Classes:

EPDataFlowInstanceImpl

public interface EPDataFlowInstance

Data flow instanve.

Method Summary

void	cancel() Cancel execution.
java.lang.String	getDataFlowName() Returns the data flow name.
java.lang.String	getInstanceId() Returns the instance id associated, if any.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Returns runtime parameters provided at instantiation time, or null if none have been provided.
EPDataFlowState	getState() Returns the state.
EPDataFlowInstanceStatistics	getStatistics() Get data flow instance statistics, required instantiation with statistics option, use EPDataFlowInstantiationOptions to turn on stats.
java.lang.Object	getUserObject() Returns the user object associated, if any.
void	join() Join an executing data flow instance.
void	run() Blocking execution of the data flow instance.
void	start() Non-Blocking execution of the data flow instance.
EPDataFlowInstanceCaptive	startCaptive() Captive execution of the data flow instance.

Method Detail

getDataFlowName

java.lang.String getDataFlowName()

Returns the data flow name.

Returns:

name

getState

EPDataFlowState getState()

Returns the state.

Returns:

state

run

void run()
         throws java.lang.IllegalStateException,
                EPDataFlowExecutionException,
                EPDataFlowCancellationException

Blocking execution of the data flow instance.

Throws:

java.lang.IllegalStateException - thrown to indicate that the state is not instantiated.

EPDataFlowExecutionException - thrown when an execution exception occurs

EPDataFlowCancellationException - throw to indicate the data flow was cancelled.

start

void start()
           throws java.lang.IllegalStateException

Non-Blocking execution of the data flow instance.

Throws:

java.lang.IllegalStateException - thrown to indicate that the state is not instantiated.

startCaptive

EPDataFlowInstanceCaptive startCaptive()

Captive execution of the data flow instance.

Returns:

runnables and emitters

join

void join()
          throws java.lang.IllegalStateException,
                 java.lang.InterruptedException

Join an executing data flow instance.

Throws:

java.lang.IllegalStateException - thrown if it cannot be joined

java.lang.InterruptedException - thrown if interrupted

cancel

void cancel()

Cancel execution.

getStatistics

EPDataFlowInstanceStatistics getStatistics()

Get data flow instance statistics, required instantiation with statistics option, use EPDataFlowInstantiationOptions to turn on stats.

Returns:

stats

getUserObject

java.lang.Object getUserObject()

Returns the user object associated, if any. Use EPDataFlowInstantiationOptions to associate.

Returns:

user object

getInstanceId

java.lang.String getInstanceId()

Returns the instance id associated, if any. Use EPDataFlowInstantiationOptions to associate.

Returns:

instance if

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()

Returns runtime parameters provided at instantiation time, or null if none have been provided.

Returns:

runtime parameters