org.openksavi.sponge.core.engine

Class BaseEngineModule

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.util.Manageable

Direct Known Subclasses:

BaseEngine, BaseEventQueue, BaseEventScheduler, BasePlugin, BaseProcessingUnit, DefaultActionManager, DefaultConfigurationManager, DefaultEventQueueManager, DefaultKnowledgeBaseManager, DefaultPluginManager, DefaultProcessingUnitManager, DefaultProcessorManager, DefaultStatisticsManager, DefaultThreadPoolManager

public abstract class BaseEngineModule
extends Object
implements org.openksavi.sponge.engine.EngineModule

Engine module.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEngineModule() Creates a new engine module.
protected	BaseEngineModule(String name) Creates a new engine module.
protected	BaseEngineModule(String name, org.openksavi.sponge.engine.Engine engine) Creates a new engine module.

Method Summary

Modifier and Type	Method and Description
protected void	doShutdown()
protected void	doStartup()
org.openksavi.sponge.engine.Engine	getEngine() Returns the engine.
String	getName() Returns the name.
com.google.common.util.concurrent.Service	getService()
com.google.common.util.concurrent.Service.State	getState()
boolean	isFailed()
boolean	isNew()
boolean	isNewOrStartingOrRunning()
boolean	isRunning() Informs whether this managed entity is running.
boolean	isStarting()
boolean	isStopping()
boolean	isTerminated()
void	setEngine(org.openksavi.sponge.engine.Engine engine) Sets the engine.
void	setName(String name) Sets module name.
void	shutdown() Shuts down this managed entity.
void	startup() Starts up this managed entity.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEngineModule

protected BaseEngineModule(String name,
                           org.openksavi.sponge.engine.Engine engine)

Creates a new engine module.

Parameters:

name - name.

engine - the engine.

BaseEngineModule

protected BaseEngineModule(String name)

Creates a new engine module.

Parameters:

name - name.

BaseEngineModule

protected BaseEngineModule()

Creates a new engine module.

Method Detail

setEngine

public void setEngine(org.openksavi.sponge.engine.Engine engine)

Sets the engine.

Specified by:

setEngine in interface org.openksavi.sponge.engine.EngineModule

Parameters:

engine - the engine.

getEngine

public org.openksavi.sponge.engine.Engine getEngine()

Returns the engine.

Specified by:

getEngine in interface org.openksavi.sponge.engine.EngineModule

Returns:

the engine.

getName

public String getName()

Returns the name.

Specified by:

getName in interface org.openksavi.sponge.engine.EngineModule

Returns:

name.

setName

public void setName(String name)

Sets module name.

Specified by:

setName in interface org.openksavi.sponge.engine.EngineModule

Parameters:

name - module name.

doStartup

protected void doStartup()

doShutdown

protected void doShutdown()

startup

public final void startup()

Starts up this managed entity.

Specified by:

startup in interface org.openksavi.sponge.util.Manageable

shutdown

public final void shutdown()

Shuts down this managed entity.

Specified by:

shutdown in interface org.openksavi.sponge.util.Manageable

isNew

public final boolean isNew()

Specified by:

isNew in interface org.openksavi.sponge.util.Manageable

isStarting

public final boolean isStarting()

Specified by:

isStarting in interface org.openksavi.sponge.util.Manageable

isRunning

public final boolean isRunning()

Informs whether this managed entity is running.

Specified by:

isRunning in interface org.openksavi.sponge.util.Manageable

Returns:

if this managed entity is running.

isStopping

public final boolean isStopping()

Specified by:

isStopping in interface org.openksavi.sponge.util.Manageable

isTerminated

public final boolean isTerminated()

Specified by:

isTerminated in interface org.openksavi.sponge.util.Manageable

isFailed

public final boolean isFailed()

Specified by:

isFailed in interface org.openksavi.sponge.util.Manageable

getState

public com.google.common.util.concurrent.Service.State getState()

getService

public com.google.common.util.concurrent.Service getService()

isNewOrStartingOrRunning

public boolean isNewOrStartingOrRunning()

toString

public String toString()

Overrides:

toString in class Object