EngineImportServiceImpl (Esper API Documentation)

java.lang.Object
- com.espertech.esper.epl.core.EngineImportServiceImpl

All Implemented Interfaces:: ClassLoaderProvider, EngineImportService

public class EngineImportServiceImpl
extends Object
implements EngineImportService, ClassLoaderProvider

Implementation for engine-level imports.

Field Summary
- Fields inherited from interface com.espertech.esper.epl.core.EngineImportService
  EXT_SINGLEROW_FUNCTION_TRANSPOSE
- Fields inherited from interface com.espertech.esper.client.util.ClassLoaderProvider
  NAME

Constructor Summary

Constructors
Constructor and Description
`EngineImportServiceImpl(boolean allowExtendedAggregationFunc, boolean isUdfCache, boolean isDuckType, boolean sortUsingCollator, MathContext optionalDefaultMathContext, TimeZone timeZone, TimeAbacus timeAbacus, ConfigurationEngineDefaults.ThreadingProfile threadingProfile, Map<String,Object> transientConfiguration, AggregationFactoryFactory aggregationFactoryFactory, ConfigurationEngineDefaults.CodeGeneration codeGeneration, String engineURI, CodegenCompiler codegenCompiler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAggregation(String functionName, ConfigurationPlugInAggregationFunction aggregationDesc)` Add an aggregation function.
`void`	`addAggregationMultiFunction(ConfigurationPlugInAggregationMultiFunction desc)`
`void`	`addAnnotationImport(String importName)` Add an import for annotation-only use, such as "com.mypackage.*" or "com.mypackage.MyClass".
`void`	`addImport(String importName)` Add an import, such as "com.mypackage.*" or "com.mypackage.MyClass".
`void`	`addMethodRefs(Map<String,ConfigurationMethodRef> configs)` Adds cache configs for method invocations for from-clause.
`void`	`addSingleRow(String functionName, String singleRowFuncClass, String methodName, ConfigurationPlugInSingleRowFunction.ValueCache valueCache, ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable, boolean rethrowExceptions, String optionalEventTypeName)` Add an single-row function.
`ClassLoader`	`classloader()` Returns the classloader.
`EventPropertyGetterIndexed`	`codegenGetter(EventPropertyGetterIndexedSPI getterSPI, String eventTypeName, String propertyExpression)`
`EventPropertyGetterMapped`	`codegenGetter(EventPropertyGetterMappedSPI getterSPI, String eventTypeName, String propertyExpression)`
`EventPropertyGetter`	`codegenGetter(EventPropertyGetterSPI getterSPI, String eventTypeName, String propertyExpression)`
`AggregationFactoryFactory`	`getAggregationFactoryFactory()`
`ClassForNameProvider`	`getClassForNameProvider()`
`ClassLoader`	`getClassLoader()`
`CodegenCompiler`	`getCodegenCompiler()`
`ConfigurationEngineDefaults.CodeGeneration`	`getCodeGeneration()`
`ConfigurationMethodRef`	`getConfigurationMethodRef(String className)` Returns the method invocation caches for the from-clause for a class.
`MathContext`	`getDefaultMathContext()`
`String`	`getEngineURI()`
`ClassLoader`	`getFastClassClassLoader(Class clazz)`
`protected String[]`	`getImports()` For testing, returns imports.
`ConfigurationEngineDefaults.ThreadingProfile`	`getThreadingProfile()`
`TimeAbacus`	`getTimeAbacus()`
`TimeZone`	`getTimeZone()`
`boolean`	`isCodegenEventPropertyGetters()`
`boolean`	`isDuckType()`
`boolean`	`isSortUsingCollator()`
`boolean`	`isUdfCache()`
`AdvancedIndexFactoryProvider`	`resolveAdvancedIndexProvider(String indexTypeName)`
`ExprNode`	`resolveAggExtendedBuiltin(String name, boolean isDistinct)` Resolve an extended (non-SQL std) builtin aggregation.
`AggregationFunctionFactory`	`resolveAggregationFactory(String name)` Used at statement compile-time to try and resolve a given function name into an aggregation method.
`ConfigurationPlugInAggregationMultiFunction`	`resolveAggregationMultiFunction(String name)`
`Class`	`resolveAnnotation(String className)` Resolves a given class name, either fully qualified and simple and imported to a annotation.
`Class`	`resolveClass(String className, boolean forAnnotation)` Resolves a given class name, either fully qualified and simple and imported to a class.
`protected Class`	`resolveClassInternal(String className, boolean requireAnnotation, boolean forAnnotationUse)` Finds a class by class name using the auto-import information provided.
`Constructor`	`resolveCtor(Class clazz, Class[] paramTypes)` Resolves a constructor matching list of parameter types.
`Method`	`resolveMethod(Class clazz, String methodName, Class[] paramTypes, boolean[] allowEventBeanType, boolean[] allowEventBeanCollType)` Resolves a given method name and list of parameter types to an instance or static method exposed by the given class.
`Method`	`resolveMethodOverloadChecked(Class clazz, String methodName)`
`Method`	`resolveMethodOverloadChecked(String className, String methodName)` Resolves a given class and method name to a static method, expecting the method to exist exactly once and not be overloaded, with any parameters.
`Method`	`resolveMethodOverloadChecked(String className, String methodName, Class[] paramTypes, boolean[] allowEventBeanType, boolean[] allowEventBeanCollType)` Resolves a given class, method and list of parameter types to a static method.
`Method`	`resolveNonStaticMethodOverloadChecked(Class clazz, String methodName)` Resolves a given class and method name to a non-static method, expecting the method to exist exactly once and not be overloaded, with any parameters.
`Pair<Class,EngineImportSingleRowDesc>`	`resolveSingleRow(String name)` Used at statement compile-time to try and resolve a given function name into an single-row function.
`ExprNode`	`resolveSingleRowExtendedBuiltin(String name)` Resolve an extended (non-SQL std) single-row function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EngineImportServiceImpl
```
public EngineImportServiceImpl(boolean allowExtendedAggregationFunc,
                               boolean isUdfCache,
                               boolean isDuckType,
                               boolean sortUsingCollator,
                               MathContext optionalDefaultMathContext,
                               TimeZone timeZone,
                               TimeAbacus timeAbacus,
                               ConfigurationEngineDefaults.ThreadingProfile threadingProfile,
                               Map<String,Object> transientConfiguration,
                               AggregationFactoryFactory aggregationFactoryFactory,
                               ConfigurationEngineDefaults.CodeGeneration codeGeneration,
                               String engineURI,
                               CodegenCompiler codegenCompiler)
```
- Method Detail
  - isUdfCache
```
public boolean isUdfCache()
```
    Specified by:
    
    isUdfCache in interface EngineImportService
  - isDuckType
```
public boolean isDuckType()
```
    Specified by:
    
    isDuckType in interface EngineImportService
  - getConfigurationMethodRef
```
public ConfigurationMethodRef getConfigurationMethodRef(String className)
```
    Description copied from interface: EngineImportService
    
    Returns the method invocation caches for the from-clause for a class.
    
    Specified by:
    
    getConfigurationMethodRef in interface EngineImportService
    
    Parameters:
    
    className - the class name providing the method
    
    Returns:
    
    cache configs
  - getClassForNameProvider
```
public ClassForNameProvider getClassForNameProvider()
```
    Specified by:
    
    getClassForNameProvider in interface EngineImportService
  - getFastClassClassLoader
```
public ClassLoader getFastClassClassLoader(Class clazz)
```
    Specified by:
    
    getFastClassClassLoader in interface EngineImportService
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface EngineImportService
  - classloader
```
public ClassLoader classloader()
```
    Description copied from interface: ClassLoaderProvider
    
    Returns the classloader.
    
    Specified by:
    
    classloader in interface ClassLoaderProvider
    
    Returns:
    
    classloader
  - addMethodRefs
```
public void addMethodRefs(Map<String,ConfigurationMethodRef> configs)
```
    Adds cache configs for method invocations for from-clause.
    
    Parameters:
    
    configs - cache configs
  - addImport
```
public void addImport(String importName)
               throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Add an import, such as "com.mypackage.*" or "com.mypackage.MyClass".
    
    Specified by:
    
    addImport in interface EngineImportService
    
    Parameters:
    
    importName - is the import to add
    
    Throws:
    
    EngineImportException - if the information or format is invalid
  - addAnnotationImport
```
public void addAnnotationImport(String importName)
                         throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Add an import for annotation-only use, such as "com.mypackage.*" or "com.mypackage.MyClass".
    
    Specified by:
    
    addAnnotationImport in interface EngineImportService
    
    Parameters:
    
    importName - is the import to add
    
    Throws:
    
    EngineImportException - if the information or format is invalid
  - addAggregation
```
public void addAggregation(String functionName,
                           ConfigurationPlugInAggregationFunction aggregationDesc)
                    throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Add an aggregation function.
    
    Specified by:
    
    addAggregation in interface EngineImportService
    
    Parameters:
    
    functionName - is the name of the function to make known.
    
    aggregationDesc - is the descriptor for the aggregation function
    
    Throws:
    
    EngineImportException - throw if format or information is invalid
  - addSingleRow
```
public void addSingleRow(String functionName,
                         String singleRowFuncClass,
                         String methodName,
                         ConfigurationPlugInSingleRowFunction.ValueCache valueCache,
                         ConfigurationPlugInSingleRowFunction.FilterOptimizable filterOptimizable,
                         boolean rethrowExceptions,
                         String optionalEventTypeName)
                  throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Add an single-row function.
    
    Specified by:
    
    addSingleRow in interface EngineImportService
    
    Parameters:
    
    functionName - is the name of the function to make known.
    
    singleRowFuncClass - is the class that provides the single row function
    
    methodName - is the name of the public static method provided by the class that provides the single row function
    
    valueCache - setting to control value cache behavior which may cache a result value when constant parameters are passed
    
    filterOptimizable - filter behavior setting
    
    rethrowExceptions - for whether to rethrow
    
    optionalEventTypeName - event type name when provided
    
    Throws:
    
    EngineImportException - throw if format or information is invalid
  - resolveAggregationFactory
```
public AggregationFunctionFactory resolveAggregationFactory(String name)
                                                     throws EngineImportUndefinedException,
                                                            EngineImportException
```
    Description copied from interface: EngineImportService
    
    Used at statement compile-time to try and resolve a given function name into an aggregation method. Matches function name case-neutral.
    
    Specified by:
    
    resolveAggregationFactory in interface EngineImportService
    
    Parameters:
    
    name - is the function name
    
    Returns:
    
    aggregation provider
    
    Throws:
    
    EngineImportUndefinedException - if the function is not a configured aggregation function
    
    EngineImportException - if the aggregation providing class could not be loaded or doesn't match
  - addAggregationMultiFunction
```
public void addAggregationMultiFunction(ConfigurationPlugInAggregationMultiFunction desc)
                                 throws EngineImportException
```
    Specified by:
    
    addAggregationMultiFunction in interface EngineImportService
    
    Throws:
    
    EngineImportException
  - resolveAggregationMultiFunction
```
public ConfigurationPlugInAggregationMultiFunction resolveAggregationMultiFunction(String name)
```
    Specified by:
    
    resolveAggregationMultiFunction in interface EngineImportService
  - resolveSingleRow
```
public Pair<Class,EngineImportSingleRowDesc> resolveSingleRow(String name)
                                                       throws EngineImportException,
                                                              EngineImportUndefinedException
```
    Description copied from interface: EngineImportService
    
    Used at statement compile-time to try and resolve a given function name into an single-row function. Matches function name case-neutral.
    
    Specified by:
    
    resolveSingleRow in interface EngineImportService
    
    Parameters:
    
    name - is the function name
    
    Returns:
    
    class name and method name pair
    
    Throws:
    
    EngineImportException - if the function providing class could not be loaded or doesn't match
    
    EngineImportUndefinedException - if the function is not a configured single-row function
  - resolveMethodOverloadChecked
```
public Method resolveMethodOverloadChecked(String className,
                                           String methodName,
                                           Class[] paramTypes,
                                           boolean[] allowEventBeanType,
                                           boolean[] allowEventBeanCollType)
                                    throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given class, method and list of parameter types to a static method.
    
    Specified by:
    
    resolveMethodOverloadChecked in interface EngineImportService
    
    Parameters:
    
    className - is the class name to use
    
    methodName - is the method name
    
    paramTypes - is parameter types match expression sub-nodes
    
    allowEventBeanType - flag for whether event bean is allowed
    
    allowEventBeanCollType - flag for whether event bean array is allowed
    
    Returns:
    
    method this resolves to
    
    Throws:
    
    EngineImportException - if the method cannot be resolved to a visible static method
  - resolveCtor
```
public Constructor resolveCtor(Class clazz,
                               Class[] paramTypes)
                        throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a constructor matching list of parameter types.
    
    Specified by:
    
    resolveCtor in interface EngineImportService
    
    Parameters:
    
    clazz - is the class to use
    
    paramTypes - is parameter types match expression sub-nodes
    
    Returns:
    
    method this resolves to
    
    Throws:
    
    EngineImportException - if the ctor cannot be resolved
  - resolveMethodOverloadChecked
```
public Method resolveMethodOverloadChecked(String className,
                                           String methodName)
                                    throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given class and method name to a static method, expecting the method to exist exactly once and not be overloaded, with any parameters.
    
    Specified by:
    
    resolveMethodOverloadChecked in interface EngineImportService
    
    Parameters:
    
    className - is the class name to use
    
    methodName - is the method name
    
    Returns:
    
    method this resolves to
    
    Throws:
    
    EngineImportException - if the method cannot be resolved to a visible static method, or if the method is overloaded
  - resolveMethodOverloadChecked
```
public Method resolveMethodOverloadChecked(Class clazz,
                                           String methodName)
                                    throws EngineImportException
```
    Specified by:
    
    resolveMethodOverloadChecked in interface EngineImportService
    
    Throws:
    
    EngineImportException
  - resolveNonStaticMethodOverloadChecked
```
public Method resolveNonStaticMethodOverloadChecked(Class clazz,
                                                    String methodName)
                                             throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given class and method name to a non-static method, expecting the method to exist exactly once and not be overloaded, with any parameters.
    
    Specified by:
    
    resolveNonStaticMethodOverloadChecked in interface EngineImportService
    
    Parameters:
    
    clazz - is the class
    
    methodName - is the method name
    
    Returns:
    
    method this resolves to
    
    Throws:
    
    EngineImportException - if the method cannot be resolved to a visible static method, or if the method is overloaded
  - resolveClass
```
public Class resolveClass(String className,
                          boolean forAnnotation)
                   throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given class name, either fully qualified and simple and imported to a class.
    
    Specified by:
    
    resolveClass in interface EngineImportService
    
    Parameters:
    
    className - is the class name to use
    
    forAnnotation - whether we are resolving an annotation
    
    Returns:
    
    class this resolves to
    
    Throws:
    
    EngineImportException - if there was an error resolving the class
  - resolveAnnotation
```
public Class resolveAnnotation(String className)
                        throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given class name, either fully qualified and simple and imported to a annotation.
    
    Specified by:
    
    resolveAnnotation in interface EngineImportService
    
    Parameters:
    
    className - is the class name to use
    
    Returns:
    
    annotation class this resolves to
    
    Throws:
    
    EngineImportException - if there was an error resolving the class
  - resolveClassInternal
```
protected Class resolveClassInternal(String className,
                                     boolean requireAnnotation,
                                     boolean forAnnotationUse)
                              throws ClassNotFoundException
```
    Finds a class by class name using the auto-import information provided.
    
    Parameters:
    
    className - is the class name to find
    
    requireAnnotation - whether the class must be an annotation
    
    forAnnotationUse - whether resolving class for use with annotations
    
    Returns:
    
    class
    
    Throws:
    
    ClassNotFoundException - if the class cannot be loaded
  - resolveMethod
```
public Method resolveMethod(Class clazz,
                            String methodName,
                            Class[] paramTypes,
                            boolean[] allowEventBeanType,
                            boolean[] allowEventBeanCollType)
                     throws EngineImportException
```
    Description copied from interface: EngineImportService
    
    Resolves a given method name and list of parameter types to an instance or static method exposed by the given class.
    
    Specified by:
    
    resolveMethod in interface EngineImportService
    
    Parameters:
    
    clazz - is the class to look for a fitting method
    
    methodName - is the method name
    
    paramTypes - is parameter types match expression sub-nodes
    
    allowEventBeanType - whether EventBean footprint is allowed
    
    allowEventBeanCollType - whether EventBean array footprint is allowed
    
    Returns:
    
    method this resolves to
    
    Throws:
    
    EngineImportException - if the method cannot be resolved to a visible static or instance method
  - resolveSingleRowExtendedBuiltin
```
public ExprNode resolveSingleRowExtendedBuiltin(String name)
```
    Description copied from interface: EngineImportService
    
    Resolve an extended (non-SQL std) single-row function.
    
    Specified by:
    
    resolveSingleRowExtendedBuiltin in interface EngineImportService
    
    Parameters:
    
    name - of func
    
    Returns:
    
    node or null
  - resolveAggExtendedBuiltin
```
public ExprNode resolveAggExtendedBuiltin(String name,
                                          boolean isDistinct)
```
    Description copied from interface: EngineImportService
    
    Resolve an extended (non-SQL std) builtin aggregation.
    
    Specified by:
    
    resolveAggExtendedBuiltin in interface EngineImportService
    
    Parameters:
    
    name - of func
    
    isDistinct - indicator
    
    Returns:
    
    aggregation func node
  - getDefaultMathContext
```
public MathContext getDefaultMathContext()
```
    Specified by:
    
    getDefaultMathContext in interface EngineImportService
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface EngineImportService
  - getTimeAbacus
```
public TimeAbacus getTimeAbacus()
```
    Specified by:
    
    getTimeAbacus in interface EngineImportService
  - getThreadingProfile
```
public ConfigurationEngineDefaults.ThreadingProfile getThreadingProfile()
```
    Specified by:
    
    getThreadingProfile in interface EngineImportService
  - isSortUsingCollator
```
public boolean isSortUsingCollator()
```
    Specified by:
    
    isSortUsingCollator in interface EngineImportService
  - getAggregationFactoryFactory
```
public AggregationFactoryFactory getAggregationFactoryFactory()
```
    Specified by:
    
    getAggregationFactoryFactory in interface EngineImportService
  - resolveAdvancedIndexProvider
```
public AdvancedIndexFactoryProvider resolveAdvancedIndexProvider(String indexTypeName)
                                                          throws EngineImportException
```
    Specified by:
    
    resolveAdvancedIndexProvider in interface EngineImportService
    
    Throws:
    
    EngineImportException
  - isCodegenEventPropertyGetters
```
public boolean isCodegenEventPropertyGetters()
```
    Specified by:
    
    isCodegenEventPropertyGetters in interface EngineImportService
  - getCodeGeneration
```
public ConfigurationEngineDefaults.CodeGeneration getCodeGeneration()
```
    Specified by:
    
    getCodeGeneration in interface EngineImportService
  - codegenGetter
```
public EventPropertyGetter codegenGetter(EventPropertyGetterSPI getterSPI,
                                         String eventTypeName,
                                         String propertyExpression)
```
    Specified by:
    
    codegenGetter in interface EngineImportService
  - codegenGetter
```
public EventPropertyGetterIndexed codegenGetter(EventPropertyGetterIndexedSPI getterSPI,
                                                String eventTypeName,
                                                String propertyExpression)
```
    Specified by:
    
    codegenGetter in interface EngineImportService
  - codegenGetter
```
public EventPropertyGetterMapped codegenGetter(EventPropertyGetterMappedSPI getterSPI,
                                               String eventTypeName,
                                               String propertyExpression)
```
    Specified by:
    
    codegenGetter in interface EngineImportService
  - getEngineURI
```
public String getEngineURI()
```
    Specified by:
    
    getEngineURI in interface EngineImportService
  - getCodegenCompiler
```
public CodegenCompiler getCodegenCompiler()
```
    Specified by:
    
    getCodegenCompiler in interface EngineImportService
  - getImports
```
protected String[] getImports()
```
    For testing, returns imports.
    
    Returns:
    
    returns auto-import list as array

Class EngineImportServiceImpl

Field Summary

Fields inherited from interface com.espertech.esper.epl.core.EngineImportService

Fields inherited from interface com.espertech.esper.client.util.ClassLoaderProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EngineImportServiceImpl

Method Detail

isUdfCache

isDuckType

getConfigurationMethodRef

getClassForNameProvider

getFastClassClassLoader

getClassLoader

classloader

addMethodRefs

addImport

addAnnotationImport

addAggregation

addSingleRow

resolveAggregationFactory

addAggregationMultiFunction

resolveAggregationMultiFunction

resolveSingleRow

resolveMethodOverloadChecked

resolveCtor

resolveMethodOverloadChecked

resolveMethodOverloadChecked

resolveNonStaticMethodOverloadChecked

resolveClass

resolveAnnotation

resolveClassInternal

resolveMethod

resolveSingleRowExtendedBuiltin

resolveAggExtendedBuiltin

getDefaultMathContext

getTimeZone

getTimeAbacus

getThreadingProfile

isSortUsingCollator

getAggregationFactoryFactory

resolveAdvancedIndexProvider

isCodegenEventPropertyGetters

getCodeGeneration

codegenGetter

codegenGetter

codegenGetter

getEngineURI

getCodegenCompiler

getImports