org.openksavi.sponge.spring

Class SpringEngineBuilder

java.lang.Object

org.openksavi.sponge.core.engine.EngineBuilder<SpringSpongeEngine>

org.openksavi.sponge.spring.SpringEngineBuilder

public class SpringEngineBuilder
extends EngineBuilder<SpringSpongeEngine>

SpringEngine builder.

Field Summary

Fields inherited from class org.openksavi.sponge.core.engine.EngineBuilder

additionalKnowledgeBases, additionalPlugins, engine, ignoreConfigurationFileNotFound, postConfigKnowledgeBases, postConfigPlugins, preConfigKnowledgeBases, preConfigPlugins, propertyEntries

Constructor Summary

Constructors

Constructor and Description
SpringEngineBuilder(SpringSpongeEngine engine) Spring-aware Sponge engine builder.

Method Summary

Modifier and Type	Method and Description
SpringEngineBuilder	autoStartup(boolean autoStartup) Sets autoStartup meaning that if it is true (the default value), the engine will be automatically started up in the afterPropertiesSet Spring callback method.
SpringEngineBuilder	config(String configFilename) Sets the configuration filename.
SpringEngineBuilder	defaultKnowledgeBaseName(String defaultKnowledgeBaseName) Sets the default knowledge base name.
SpringEngineBuilder	description(String description) Sets the engine description.
SpringEngineBuilder	eventQueueProvider(org.openksavi.sponge.spi.EventQueueProvider eventQueueProvider) Sets the event queue provider.
SpringEngineBuilder	exceptionHandler(org.openksavi.sponge.engine.ExceptionHandler exceptionHandler) Sets the exception handler.
SpringEngineBuilder	knowledgeBase(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, org.openksavi.sponge.kb.KnowledgeBaseScript... scripts) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, org.openksavi.sponge.kb.KnowledgeBaseType type, org.openksavi.sponge.kb.KnowledgeBaseScript... scripts) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, org.openksavi.sponge.kb.KnowledgeBaseType type, List<org.openksavi.sponge.kb.KnowledgeBaseScript> scripts) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, org.openksavi.sponge.kb.KnowledgeBaseType type, String... files) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, List<org.openksavi.sponge.kb.KnowledgeBaseScript> scripts) Adds the knowledge base.
SpringEngineBuilder	knowledgeBase(String name, String... files) Adds the knowledge base.
SpringEngineBuilder	knowledgeBaseFileProvider(org.openksavi.sponge.kb.KnowledgeBaseFileProvider knowledgeBaseFileProvider) Sets the knowledge base file provider.
SpringEngineBuilder	knowledgeBaseInterpreterFactoryProviders(List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders) Sets the knowledge base interpreter factory providers.
SpringEngineBuilder	knowledgeBaseString(String name, org.openksavi.sponge.kb.KnowledgeBaseType type, String body) Adds the String-based knowledge base.
SpringEngineBuilder	label(String label) Sets the engine label.
SpringEngineBuilder	license(String license) Sets the engine license.
SpringEngineBuilder	moduleProvider(org.openksavi.sponge.spi.EngineModuleProvider moduleProvider) Sets the module provider.
SpringEngineBuilder	name(String name) Sets the engine name.
SpringEngineBuilder	phase(int phase)
SpringEngineBuilder	plugin(org.openksavi.sponge.plugin.Plugin plugin) Adds the plugin.
SpringEngineBuilder	plugins(org.openksavi.sponge.plugin.Plugin... plugins) Adds the plugins.
SpringEngineBuilder	processingUnitProvider(org.openksavi.sponge.spi.ProcessingUnitProvider processingUnitProvider) Sets the processing unit provider.
SpringEngineBuilder	processorBeansKnowledgeBaseName(String processorBeansKnowledgeBaseName)
SpringEngineBuilder	properties(Map<String,Object> simpleProperties) Sets the properties.
SpringEngineBuilder	property(String name, Object value) Sets the property (that is neither a variable nor a system property).
SpringEngineBuilder	property(String name, Object value, boolean variable, boolean system) Sets the property.
SpringEngineBuilder	systemProperties(Map<String,String> systemProperties) Sets the system properties.
SpringEngineBuilder	systemProperty(String name, Object value) Sets the system property (that is not a variable).
SpringEngineBuilder	variableProperties(Map<String,String> variableProperties) Sets the variable properties.
SpringEngineBuilder	variableProperty(String name, Object value) Sets the property that is also a variable.

Methods inherited from class org.openksavi.sponge.core.engine.EngineBuilder

build, getEngineDefaultParameters, getInfo, ignoreConfigurationFileNotFound, init

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringEngineBuilder

public SpringEngineBuilder(SpringSpongeEngine engine)

Spring-aware Sponge engine builder. Sets knowledgeBaseFileProvider to SpringKnowledgeBaseFileProvider.

Parameters:

engine - the engine.

Method Detail

autoStartup

public SpringEngineBuilder autoStartup(boolean autoStartup)

Sets autoStartup meaning that if it is true (the default value), the engine will be automatically started up in the afterPropertiesSet Spring callback method. Moreover the engine will be shut down in the destroy Spring callback method.

Parameters:

autoStartup - the autoStartup flag.

Returns:

this builder.

phase

public SpringEngineBuilder phase(int phase)

processorBeansKnowledgeBaseName

public SpringEngineBuilder processorBeansKnowledgeBaseName(String processorBeansKnowledgeBaseName)

name

public SpringEngineBuilder name(String name)

Sets the engine name.

Overrides:

name in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the engine name.

Returns:

this builder.

label

public SpringEngineBuilder label(String label)

Sets the engine label.

Overrides:

label in class EngineBuilder<SpringSpongeEngine>

Parameters:

label - the engine label.

Returns:

this builder.

description

public SpringEngineBuilder description(String description)

Sets the engine description.

Overrides:

description in class EngineBuilder<SpringSpongeEngine>

Parameters:

description - the engine description.

Returns:

this builder.

license

public SpringEngineBuilder license(String license)

Sets the engine license.

Overrides:

license in class EngineBuilder<SpringSpongeEngine>

Parameters:

license - the engine license.

Returns:

this builder.

moduleProvider

public SpringEngineBuilder moduleProvider(org.openksavi.sponge.spi.EngineModuleProvider moduleProvider)

Sets the module provider.

Overrides:

moduleProvider in class EngineBuilder<SpringSpongeEngine>

Parameters:

moduleProvider - the moduleProvider to set.

Returns:

this builder.

knowledgeBaseInterpreterFactoryProviders

public SpringEngineBuilder knowledgeBaseInterpreterFactoryProviders(List<org.openksavi.sponge.spi.KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)

Sets the knowledge base interpreter factory providers.

Overrides:

knowledgeBaseInterpreterFactoryProviders in class EngineBuilder<SpringSpongeEngine>

Parameters:

knowledgeBaseInterpreterFactoryProviders - the knowledge base interpreter factory providers.

Returns:

this builder.

eventQueueProvider

public SpringEngineBuilder eventQueueProvider(org.openksavi.sponge.spi.EventQueueProvider eventQueueProvider)

Sets the event queue provider.

Overrides:

eventQueueProvider in class EngineBuilder<SpringSpongeEngine>

Parameters:

eventQueueProvider - the event queue provider.

Returns:

this builder.

processingUnitProvider

public SpringEngineBuilder processingUnitProvider(org.openksavi.sponge.spi.ProcessingUnitProvider processingUnitProvider)

Sets the processing unit provider.

Overrides:

processingUnitProvider in class EngineBuilder<SpringSpongeEngine>

Parameters:

processingUnitProvider - the processing unit provider.

Returns:

this builder.

knowledgeBaseFileProvider

public SpringEngineBuilder knowledgeBaseFileProvider(org.openksavi.sponge.kb.KnowledgeBaseFileProvider knowledgeBaseFileProvider)

Sets the knowledge base file provider.

Overrides:

knowledgeBaseFileProvider in class EngineBuilder<SpringSpongeEngine>

Parameters:

knowledgeBaseFileProvider - the knowledge base file provider.

Returns:

this builder.

config

public SpringEngineBuilder config(String configFilename)

Sets the configuration filename.

Overrides:

config in class EngineBuilder<SpringSpongeEngine>

Parameters:

configFilename - the configuration filename.

Returns:

this builder.

property

public SpringEngineBuilder property(String name,
                                    Object value,
                                    boolean variable,
                                    boolean system)

Sets the property.

Overrides:

property in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the property name.

value - the property value.

variable - should the property be used as a variable.

system - is the property a system property.

Returns:

this builder.

property

public SpringEngineBuilder property(String name,
                                    Object value)

Sets the property (that is neither a variable nor a system property).

Overrides:

property in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the property name.

value - the property value.

Returns:

this builder.

systemProperty

public SpringEngineBuilder systemProperty(String name,
                                          Object value)

Sets the system property (that is not a variable).

Overrides:

systemProperty in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the property name.

value - the property value.

Returns:

this builder.

variableProperty

public SpringEngineBuilder variableProperty(String name,
                                            Object value)

Sets the property that is also a variable.

Overrides:

variableProperty in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the property name.

value - the property value.

Returns:

this builder.

properties

public SpringEngineBuilder properties(Map<String,Object> simpleProperties)

Sets the properties.

Overrides:

properties in class EngineBuilder<SpringSpongeEngine>

Parameters:

simpleProperties - the properties.

Returns:

this builder.

systemProperties

public SpringEngineBuilder systemProperties(Map<String,String> systemProperties)

Sets the system properties.

Overrides:

systemProperties in class EngineBuilder<SpringSpongeEngine>

Parameters:

systemProperties - the system properties.

Returns:

this builder.

variableProperties

public SpringEngineBuilder variableProperties(Map<String,String> variableProperties)

Sets the variable properties.

Overrides:

variableProperties in class EngineBuilder<SpringSpongeEngine>

Parameters:

variableProperties - the variable properties.

Returns:

this builder.

plugin

public SpringEngineBuilder plugin(org.openksavi.sponge.plugin.Plugin plugin)

Adds the plugin.

Overrides:

plugin in class EngineBuilder<SpringSpongeEngine>

Parameters:

plugin - the plugin.

Returns:

this builder.

plugins

public SpringEngineBuilder plugins(org.openksavi.sponge.plugin.Plugin... plugins)

Adds the plugins.

Overrides:

plugins in class EngineBuilder<SpringSpongeEngine>

Parameters:

plugins - the plugins.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

knowledgeBase - the knowledge base.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         org.openksavi.sponge.kb.KnowledgeBaseType type,
                                         String... files)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

type - the knowledge base type.

files - the knowledge base files.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         String... files)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

files - the knowledge base files.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         org.openksavi.sponge.kb.KnowledgeBaseScript... scripts)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

scripts - the knowledge base scripts.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         org.openksavi.sponge.kb.KnowledgeBaseType type,
                                         org.openksavi.sponge.kb.KnowledgeBaseScript... scripts)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

type - the knowledge base type.

scripts - the knowledge base scripts.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         List<org.openksavi.sponge.kb.KnowledgeBaseScript> scripts)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

scripts - the knowledge base scripts.

Returns:

this builder.

knowledgeBase

public SpringEngineBuilder knowledgeBase(String name,
                                         org.openksavi.sponge.kb.KnowledgeBaseType type,
                                         List<org.openksavi.sponge.kb.KnowledgeBaseScript> scripts)

Adds the knowledge base.

Overrides:

knowledgeBase in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

type - the knowledge base type.

scripts - the knowledge base scripts.

Returns:

this builder.

knowledgeBaseString

public SpringEngineBuilder knowledgeBaseString(String name,
                                               org.openksavi.sponge.kb.KnowledgeBaseType type,
                                               String body)

Adds the String-based knowledge base.

Overrides:

knowledgeBaseString in class EngineBuilder<SpringSpongeEngine>

Parameters:

name - the knowledge base name.

type - the knowledge base type.

body - the String-based knowledge base body.

Returns:

this builder.

exceptionHandler

public SpringEngineBuilder exceptionHandler(org.openksavi.sponge.engine.ExceptionHandler exceptionHandler)

Sets the exception handler.

Overrides:

exceptionHandler in class EngineBuilder<SpringSpongeEngine>

Parameters:

exceptionHandler - the new exception handler.

Returns:

this builder.

defaultKnowledgeBaseName

public SpringEngineBuilder defaultKnowledgeBaseName(String defaultKnowledgeBaseName)

Sets the default knowledge base name.

Overrides:

defaultKnowledgeBaseName in class EngineBuilder<SpringSpongeEngine>

Parameters:

defaultKnowledgeBaseName - the default knowledge base name.

Returns:

this builder.