org.appdapter.module.basic

Class TimedModule<Ctx>

java.lang.Object

org.appdapter.core.log.BasicDebugger

org.appdapter.bind.rdf.jena.assembly.KnownComponentImpl

org.appdapter.module.basic.BasicModule<Ctx>

org.appdapter.module.basic.TimedModule<Ctx>

All Implemented Interfaces:

Module<Ctx>, AnyOper.HasIdent, KnownComponent, MutableKnownComponent, UIAnnotations.ApplyToClassInterfaces, Loggable

Direct Known Subclasses:

EmptyTimedModule

public abstract class TimedModule<Ctx>
extends BasicModule<Ctx>

Here we log the timing of each callback exec, and also make the parent modulator's presence explicit in each callback. We also supply a naive "completed run count".

Author:

Stu B.

Nested Class Summary

Nested classes/interfaces inherited from interface org.appdapter.api.module.Module

Module.State

Field Summary

Fields

Modifier and Type	Field and Description
protected int	myRunDebugModulus

Fields inherited from class org.appdapter.core.log.BasicDebugger

myLogger

Fields inherited from interface org.appdapter.api.trigger.AnyOper.HasIdent

HASIDENT

Fields inherited from interface org.appdapter.core.log.Loggable

IMPO_HI, IMPO_HIHI, IMPO_LO, IMPO_LOLO, IMPO_MAX, IMPO_MIN, IMPO_NORM

Constructor Summary

Constructors

Constructor and Description
TimedModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doInit(Ctx mlator)
protected abstract void	doRelease(Ctx ctx)
protected abstract void	doRunOnce(Ctx ctx, long runSeqNum)
protected abstract void	doStart(Ctx ctx)
protected abstract void	doStop(Ctx ctx)
long	getCompletedRunCount()
String	getFieldSummary()
void	initModule() Modulator must be set when initModule is called.
void	releaseModule() Required pre-state is POST_STOP or FAILED_STARTUP.
void	runOnce() Required pre-state is WAIT_TO_RUN_OR_STOP.
void	start() Required pre-state is WAIT_TO_START.
void	stop() Required pre-state is WAIT_TO_RUN_OR_STOP.

Methods inherited from class org.appdapter.module.basic.BasicModule

enterBasicInitModule, enterBasicReleaseModule, enterBasicRunOnce, enterBasicStart, enterBasicStop, exitBasicInitModule, exitBasicReleaseModule, exitBasicRunOnce, exitBasicStart, exitBasicStop, failDuringInitOrStartup, getContext, getState, isStopRequested, markStopRequested, notifyStateViolation, setContext, verifyStoredState

Methods inherited from class org.appdapter.bind.rdf.jena.assembly.KnownComponentImpl

getDescription, getIdent, getShortLabel, setDescription, setIdent, setShortLabel, toString

Methods inherited from class org.appdapter.core.log.BasicDebugger

checkDebugImportance, forceLog4jConfig, getLogger, getLoggerForClass, isLoggerUsable, logDebug, logError, logError, logInfo, logInfo, logInfoEvent, logWarning, logWarning, logWithException, setDebugImportanceThreshold, setLogger, useLoggerForClass

Methods inherited from class java.lang.Object

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

Field Detail

myRunDebugModulus

protected int myRunDebugModulus

Constructor Detail

TimedModule

public TimedModule()

Method Detail

getCompletedRunCount

public long getCompletedRunCount()

doInit

protected abstract void doInit(Ctx mlator)

initModule

public void initModule()

Description copied from interface: Module

Modulator must be set when initModule is called. initModule is called exactly once, by the modulator, and can be First method called on Module, and called only once. Can only be called by the modulatorModule Upon return, must be in WAIT_TO_START, or FAILED_STARTUP.

doStart

protected abstract void doStart(Ctx ctx)

start

public void start()

Description copied from interface: Module

Required pre-state is WAIT_TO_START. During-state is IN_START Upon return, state is WAIT_TO_RUN_OR_STOP, or FAILED_STARTUP.

doRunOnce

protected abstract void doRunOnce(Ctx ctx,
             long runSeqNum)

runOnce

public void runOnce()

Description copied from interface: Module

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_RUN. Upon return, state is WAIT_TO_RUN_OR_STOP.

doStop

protected abstract void doStop(Ctx ctx)

stop

public void stop()

Description copied from interface: Module

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_STOP. Upon return, state is POST_STOP

doRelease

protected abstract void doRelease(Ctx ctx)

releaseModule

public void releaseModule()

Description copied from interface: Module

Required pre-state is POST_STOP or FAILED_STARTUP. Module is no longer usable as soon as call begins. Should not throw.

getFieldSummary

public String getFieldSummary()

Overrides:

getFieldSummary in class BasicModule<Ctx>