com.espertech.esper.client

Class ConfigurationPlugInSingleRowFunction

java.lang.Object

com.espertech.esper.client.ConfigurationPlugInSingleRowFunction

All Implemented Interfaces:

Serializable

public class ConfigurationPlugInSingleRowFunction
extends Object
implements Serializable

Configuration information for plugging in a custom single-row function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationPlugInSingleRowFunction.FilterOptimizable Controls whether a single-row function is eligible for optimization if it occurs in a filter expression.
static class	ConfigurationPlugInSingleRowFunction.ValueCache Enum for single-row function value cache setting.

Constructor Summary

Constructors

Constructor and Description
ConfigurationPlugInSingleRowFunction() Ctor.
ConfigurationPlugInSingleRowFunction(String name, String functionClassName, String functionMethodName, ConfigurationPlugInSingleRowFunction.ValueCache valueCache, ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable, boolean rethrowExceptions, String eventTypeName) Ctor.

Method Summary

Modifier and Type	Method and Description
String	getEventTypeName() Returns the event type name for functions that return EventBean instances.
ConfigurationPlugInSingleRowFunction.FilterOptimizable	getFilterOptimizable() Returns filter optimization settings.
String	getFunctionClassName() Returns the single-row function name.
String	getFunctionMethodName() Returns the name of the single-row function.
String	getName() Returns the single-row function name for use in EPL.
ConfigurationPlugInSingleRowFunction.ValueCache	getValueCache() Returns the setting for the cache behavior.
boolean	isRethrowExceptions() Returns indicator whether the engine re-throws exceptions thrown by the single-row function.
void	setEventTypeName(String eventTypeName) Sets the event type name for functions that return EventBean instances.
void	setFilterOptimizable(ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable) Sets filter optimization settings.
void	setFunctionClassName(String functionClassName) Sets the single-row function's implementation class name.
void	setFunctionMethodName(String functionMethodName) Sets the name of the single-row function.
void	setName(String name) Sets the single-row function name for use in EPL.
void	setRethrowExceptions(boolean rethrowExceptions) Sets indicator whether the engine re-throws exceptions thrown by the single-row function.
void	setValueCache(ConfigurationPlugInSingleRowFunction.ValueCache valueCache) Sets the cache behavior.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPlugInSingleRowFunction

public ConfigurationPlugInSingleRowFunction(String name,
                                            String functionClassName,
                                            String functionMethodName,
                                            ConfigurationPlugInSingleRowFunction.ValueCache valueCache,
                                            ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable,
                                            boolean rethrowExceptions,
                                            String eventTypeName)

Ctor.

Parameters:

name - UDF name

functionClassName - class name

functionMethodName - method name

valueCache - value cache

filterOptimizable - optimizable setting

rethrowExceptions - rethrow setting

eventTypeName - optional event type name

ConfigurationPlugInSingleRowFunction

public ConfigurationPlugInSingleRowFunction()

Ctor.

Method Detail

getName

public String getName()

Returns the single-row function name for use in EPL.

Returns:

single-row function name

setName

public void setName(String name)

Sets the single-row function name for use in EPL.

Parameters:

name - to set

getFunctionClassName

public String getFunctionClassName()

Returns the single-row function name.

Returns:

name

setFunctionClassName

public void setFunctionClassName(String functionClassName)

Sets the single-row function's implementation class name.

Parameters:

functionClassName - is the implementation class name

getFunctionMethodName

public String getFunctionMethodName()

Returns the name of the single-row function.

Returns:

function name

setFunctionMethodName

public void setFunctionMethodName(String functionMethodName)

Sets the name of the single-row function.

Parameters:

functionMethodName - single-row function name

getValueCache

public ConfigurationPlugInSingleRowFunction.ValueCache getValueCache()

Returns the setting for the cache behavior.

Returns:

cache behavior

setValueCache

public void setValueCache(ConfigurationPlugInSingleRowFunction.ValueCache valueCache)

Sets the cache behavior.

Parameters:

valueCache - cache behavior

getFilterOptimizable

public ConfigurationPlugInSingleRowFunction.FilterOptimizable getFilterOptimizable()

Returns filter optimization settings.

Returns:

filter optimization settings

setFilterOptimizable

public void setFilterOptimizable(ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable)

Sets filter optimization settings.

Parameters:

filterOptimizable - filter optimization settings

isRethrowExceptions

public boolean isRethrowExceptions()

Returns indicator whether the engine re-throws exceptions thrown by the single-row function. The default is false therefore the engine by default does not rethrow exceptions.

Returns:

indicator

setRethrowExceptions

public void setRethrowExceptions(boolean rethrowExceptions)

Sets indicator whether the engine re-throws exceptions thrown by the single-row function. The default is false therefore the engine by default does not rethrow exceptions.

Parameters:

rethrowExceptions - indicator

getEventTypeName

public String getEventTypeName()

Returns the event type name for functions that return EventBean instances.

Returns:

event type name

setEventTypeName

public void setEventTypeName(String eventTypeName)

Sets the event type name for functions that return EventBean instances.

Parameters:

eventTypeName - event type name