com.espertech.esper.common.client.configuration.compiler

Class ConfigurationCompilerPlugInSingleRowFunction

java.lang.Object

com.espertech.esper.common.client.configuration.compiler.ConfigurationCompilerPlugInSingleRowFunction

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationCompilerPlugInSingleRowFunction
extends java.lang.Object
implements java.io.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	ConfigurationCompilerPlugInSingleRowFunction.FilterOptimizable Controls whether a single-row function is eligible for optimization if it occurs in a filter expression.
static class	ConfigurationCompilerPlugInSingleRowFunction.ValueCache Enum for single-row function value cache setting.

Constructor Summary

Constructors

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

Method Summary

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

ConfigurationCompilerPlugInSingleRowFunction

public ConfigurationCompilerPlugInSingleRowFunction(java.lang.String name,
                                                    java.lang.String functionClassName,
                                                    java.lang.String functionMethodName,
                                                    ConfigurationCompilerPlugInSingleRowFunction.ValueCache valueCache,
                                                    ConfigurationCompilerPlugInSingleRowFunction.FilterOptimizable filterOptimizable,
                                                    boolean rethrowExceptions,
                                                    java.lang.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

ConfigurationCompilerPlugInSingleRowFunction

public ConfigurationCompilerPlugInSingleRowFunction()

Ctor.

Method Detail

getName

public java.lang.String getName()

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

Returns:

single-row function name

setName

public void setName(java.lang.String name)

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

Parameters:

name - to set

getFunctionClassName

public java.lang.String getFunctionClassName()

Returns the single-row function name.

Returns:

name

setFunctionClassName

public void setFunctionClassName(java.lang.String functionClassName)

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

Parameters:

functionClassName - is the implementation class name

getFunctionMethodName

public java.lang.String getFunctionMethodName()

Returns the name of the single-row function.

Returns:

function name

setFunctionMethodName

public void setFunctionMethodName(java.lang.String functionMethodName)

Sets the name of the single-row function.

Parameters:

functionMethodName - single-row function name

getValueCache

public ConfigurationCompilerPlugInSingleRowFunction.ValueCache getValueCache()

Returns the setting for the cache behavior.

Returns:

cache behavior

setValueCache

public void setValueCache(ConfigurationCompilerPlugInSingleRowFunction.ValueCache valueCache)

Sets the cache behavior.

Parameters:

valueCache - cache behavior

getFilterOptimizable

public ConfigurationCompilerPlugInSingleRowFunction.FilterOptimizable getFilterOptimizable()

Returns filter optimization settings.

Returns:

filter optimization settings

setFilterOptimizable

public void setFilterOptimizable(ConfigurationCompilerPlugInSingleRowFunction.FilterOptimizable filterOptimizable)

Sets filter optimization settings.

Parameters:

filterOptimizable - filter optimization settings

isRethrowExceptions

public boolean isRethrowExceptions()

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

Returns:

indicator

setRethrowExceptions

public void setRethrowExceptions(boolean rethrowExceptions)

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

Parameters:

rethrowExceptions - indicator

getEventTypeName

public java.lang.String getEventTypeName()

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

Returns:

event type name

setEventTypeName

public void setEventTypeName(java.lang.String eventTypeName)

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

Parameters:

eventTypeName - event type name