Package com.espertech.esper.common.internal.epl.dataflow.core

Class EPDataFlowServiceImpl

java.lang.Object

com.espertech.esper.common.internal.epl.dataflow.core.EPDataFlowServiceImpl

All Implemented Interfaces:

EPDataFlowService

public class EPDataFlowServiceImpl
extends Object
implements EPDataFlowService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OP_PACKAGE_NAME

Fields inherited from interface com.espertech.esper.common.client.dataflow.core.EPDataFlowService

EPTYPE_DATAFLOWSTATE

Constructor Summary

Constructors

Constructor	Description
EPDataFlowServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addDataflow(String deploymentId, DataflowDesc dataflow)
EPDataFlowDescriptor	getDataFlow(String deploymentId, String dataflowName)	Returns a descriptor for the given data flow, or null if the data flow has not been declared.
DeploymentIdNamePair[]	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 deploymentId, String dataflowName)	Instantiate a data flow.
EPDataFlowInstance	instantiate(String deploymentId, String dataFlowName, EPDataFlowInstantiationOptions options)	Instantiate a data flow, with options.
EPDataFlowInstance	instantiateSavedConfiguration(String configurationName)	Instantiate a data flow from a saved configuration.
void	removeDataflow(String deploymentId, DataflowDesc dataflow)
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 deploymentId, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OP_PACKAGE_NAME

public static final String OP_PACKAGE_NAME

See Also:

• Constant Field Values

Constructor Details

EPDataFlowServiceImpl

public EPDataFlowServiceImpl()

Method Details

getDataFlow

public EPDataFlowDescriptor getDataFlow(String deploymentId,
 String dataflowName)

Description copied from interface: EPDataFlowService

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

Specified by:

getDataFlow in interface EPDataFlowService

Parameters:

deploymentId - deployment id of dataflow (deployment id of create-dataflow statement)

dataflowName - data flow name

Returns:

data flow descriptor

getDataFlows

public DeploymentIdNamePair[] getDataFlows()

Description copied from interface: EPDataFlowService

Returns the names of all declared data flows.

Specified by:

getDataFlows in interface EPDataFlowService

Returns:

data flow names

instantiate

public EPDataFlowInstance instantiate(String deploymentId,
 String dataflowName)
                               throws EPDataFlowInstantiationException

Description copied from interface: EPDataFlowService

Instantiate a data flow.

Specified by:

instantiate in interface EPDataFlowService

Parameters:

deploymentId - deployment id of dataflow (deployment id of create-dataflow statement)

dataflowName - name of data flow to instantiate

Returns:

data flow instance

Throws:

EPDataFlowInstantiationException - when the instantiation failed

instantiate

public EPDataFlowInstance instantiate(String deploymentId,
 String dataFlowName,
 EPDataFlowInstantiationOptions options)
                               throws EPDataFlowInstantiationException

Description copied from interface: EPDataFlowService

Instantiate a data flow, with options.

Specified by:

instantiate in interface EPDataFlowService

Parameters:

deploymentId - deployment id of dataflow (deployment id of create-dataflow statement)

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

saveInstance

public void saveInstance(String instanceName,
 EPDataFlowInstance instance)
                  throws EPDataFlowAlreadyExistsException

Description copied from interface: EPDataFlowService

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

Specified by:

saveInstance in interface EPDataFlowService

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

public String[] getSavedInstances()

Description copied from interface: EPDataFlowService

Returns the instance names of a saved data flow instances.

Specified by:

getSavedInstances in interface EPDataFlowService

Returns:

data flow instance names

getSavedInstance

public EPDataFlowInstance getSavedInstance(String instanceName)

Description copied from interface: EPDataFlowService

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

Specified by:

getSavedInstance in interface EPDataFlowService

Parameters:

instanceName - to look for

Returns:

instance

removeSavedInstance

public boolean removeSavedInstance(String instanceName)

Description copied from interface: EPDataFlowService

Remove an instance previously saved.

Specified by:

removeSavedInstance in interface EPDataFlowService

Parameters:

instanceName - to be removed

Returns:

indicator whether found or not

addDataflow

public void addDataflow(String deploymentId,
 DataflowDesc dataflow)

removeDataflow

public void removeDataflow(String deploymentId,
 DataflowDesc dataflow)

saveConfiguration

public void saveConfiguration(String dataflowConfigName,
 String deploymentId,
 String dataFlowName,
 EPDataFlowInstantiationOptions options)

Description copied from interface: EPDataFlowService

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

Specified by:

saveConfiguration in interface EPDataFlowService

Parameters:

dataflowConfigName - configuration name to save, must be unique

deploymentId - deployment id

dataFlowName - data flow name

options - options object

getSavedConfigurations

public String[] getSavedConfigurations()

Description copied from interface: EPDataFlowService

Returns the names of a saved data flow configurations.

Specified by:

getSavedConfigurations in interface EPDataFlowService

Returns:

data flow configuration names

getSavedConfiguration

public EPDataFlowSavedConfiguration getSavedConfiguration(String configurationName)

Description copied from interface: EPDataFlowService

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

Specified by:

getSavedConfiguration in interface EPDataFlowService

Parameters:

configurationName - name to find

Returns:

data flow configuration

instantiateSavedConfiguration

public EPDataFlowInstance instantiateSavedConfiguration(String configurationName)
                                                 throws EPDataFlowInstantiationException

Description copied from interface: EPDataFlowService

Instantiate a data flow from a saved configuration.

Specified by:

instantiateSavedConfiguration in interface EPDataFlowService

Parameters:

configurationName - configuration name

Returns:

instance

Throws:

EPDataFlowInstantiationException - if the configuration name could not be found

removeSavedConfiguration

public boolean removeSavedConfiguration(String configurationName)

Description copied from interface: EPDataFlowService

Remove a previously saved data flow configuration.

Specified by:

removeSavedConfiguration in interface EPDataFlowService

Parameters:

configurationName - to remove

Returns:

indicator whether found and removed