com.espertech.esper.client.dataflow

Interface EPDataFlowRuntime

All Known Subinterfaces:

DataFlowService

All Known Implementing Classes:

DataFlowServiceImpl

public interface EPDataFlowRuntime

Data flow runtime for instantiating data flows.

Method Summary

Modifier and Type	Method and Description
EPDataFlowDescriptor	getDataFlow(String dataFlowName) Returns a descriptor for the given data flow, or null if the data flow has not been declared.
String[]	getDataFlows() Returns the names of all declared data flows.
EPDataFlowSavedConfiguration	getSavedConfiguration(String configurationName) Returns a saved dataflow configuration or null if it is not found.
String[]	getSavedConfigurations() Returns the names of a saved data flow configurations.
EPDataFlowInstance	getSavedInstance(String instanceName) Returns a specific saved data flow instance, or null if it has not been found
String[]	getSavedInstances() Returns the instance names of a saved data flow instances.
EPDataFlowInstance	instantiate(String dataFlowName) Instantiate a data flow.
EPDataFlowInstance	instantiate(String dataFlowName, EPDataFlowInstantiationOptions options) Instantiate a data flow, with options.
EPDataFlowInstance	instantiateSavedConfiguration(String configurationName) Instantiate a data flow from a saved configuration.
boolean	removeSavedConfiguration(String configurationName) Remove a previously saved data flow configuration.
boolean	removeSavedInstance(String instanceName) Remove an instance previously saved.
void	saveConfiguration(String dataflowConfigName, String dataFlowName, EPDataFlowInstantiationOptions options) Save an existing data flow configuration (data flow name and its options) for later retrieval.
void	saveInstance(String instanceName, EPDataFlowInstance instance) Save an existing instance with the runtime, for later retrieval.

Method Detail

getDataFlow

EPDataFlowDescriptor getDataFlow(String dataFlowName)

Returns a descriptor for the given data flow, or null if the data flow has not been declared.

Parameters:

dataFlowName - data flow name

Returns:

data flow descriptor

getDataFlows

String[] getDataFlows()

Returns the names of all declared data flows.

Returns:

data flow names

instantiate

EPDataFlowInstance instantiate(String dataFlowName)
                        throws EPDataFlowInstantiationException

Instantiate a data flow.

Parameters:

dataFlowName - name of data flow to instantiate

Returns:

data flow instance

Throws:

EPDataFlowInstantiationException - when the instantiation failed

instantiate

EPDataFlowInstance instantiate(String dataFlowName,
                               EPDataFlowInstantiationOptions options)
                        throws EPDataFlowInstantiationException

Instantiate a data flow, with options.

Parameters:

dataFlowName - name of data flow to instantiate

options - populate options to control parameterization, instantiation etc.

Returns:

data flow instance

Throws:

EPDataFlowInstantiationException - when the instantiation failed

saveConfiguration

void saveConfiguration(String dataflowConfigName,
                       String dataFlowName,
                       EPDataFlowInstantiationOptions options)
                throws EPDataFlowAlreadyExistsException,
                       EPDataFlowNotFoundException

Save an existing data flow configuration (data flow name and its options) for later retrieval.

Parameters:

dataflowConfigName - configuration name to save, must be unique

dataFlowName - data flow name

options - options object

Throws:

EPDataFlowAlreadyExistsException - if the configuration name is already used

EPDataFlowNotFoundException - if the data flow by this name does not exist

getSavedConfigurations

String[] getSavedConfigurations()

Returns the names of a saved data flow configurations.

Returns:

data flow configuration names

getSavedConfiguration

EPDataFlowSavedConfiguration getSavedConfiguration(String configurationName)

Returns a saved dataflow configuration or null if it is not found.

Parameters:

configurationName - name to find

Returns:

data flow configuration

instantiateSavedConfiguration

EPDataFlowInstance instantiateSavedConfiguration(String configurationName)
                                          throws EPDataFlowInstantiationException

Instantiate a data flow from a saved configuration.

Parameters:

configurationName - configuration name

Returns:

instance

Throws:

EPDataFlowInstantiationException - if the configuration name could not be found

removeSavedConfiguration

boolean removeSavedConfiguration(String configurationName)

Remove a previously saved data flow configuration.

Parameters:

configurationName - to remove

Returns:

indicator whether found and removed

saveInstance

void saveInstance(String instanceName,
                  EPDataFlowInstance instance)
           throws EPDataFlowAlreadyExistsException

Save an existing instance with the runtime, for later retrieval.

Parameters:

instanceName - name to use to save, must be unique among currently saved instances

instance - saved

Throws:

EPDataFlowAlreadyExistsException - if an instance by this name already exists

getSavedInstances

String[] getSavedInstances()

Returns the instance names of a saved data flow instances.

Returns:

data flow instance names

getSavedInstance

EPDataFlowInstance getSavedInstance(String instanceName)

Returns a specific saved data flow instance, or null if it has not been found

Parameters:

instanceName - to look for

Returns:

instance

removeSavedInstance

boolean removeSavedInstance(String instanceName)

Remove an instance previously saved.

Parameters:

instanceName - to be removed

Returns:

indicator whether found or not