edu.ksu.cis.projects.bogor
Interface IBogorConfiguration

All Superinterfaces:

Disposable

All Known Implementing Classes:

DefaultBogorConfiguration

public interface IBogorConfiguration
extends Disposable

Version:

CVS $Revision: 1.13 $ $Date: 2005/05/19 22:16:48 $

Author:

Robby , Matt Hoosier

Field Summary

static Class<IBacktrackingInfo>	ACTION_DEF_EXT_OP_RETURN_TYPE
static Class<IValue>	EXP_DEF_EXT_OP_RETURN_TYPE
static String[]	EXT_OP_ARG_NAMES
static Class[]	EXT_OP_ARG_TYPES

Method Summary

IMessageStore	connect()
IActionTaker	getActionTaker()
IBacktrackingInfoFactory	getBacktrackingInfoFactory()
Properties	getConfiguration()
ICounterExampleWriter	getCounterExampleWriter()
IExpEvaluator	getExpEvaluator()
IModule	getExtensionModule(String extId)
Map<ExtSymbolTable,IModule>	getExtTable()
String	getFilename()
List<Class>	getKnownImplementingClasses(Class<?> interfaceType) An optional method which attempts to search the runtime for known implementations of a particular Bogor module type.
List<IListener>	getListeners()
Object	getModuleInstance(String className, Class interfaceType, Collection<FileMessage> errors) Instantiate a Bogor module (an implementation of IModule).
Object	getPluginClassInstance(Properties config, String className, Class interfaceType, Collection<FileMessage> errors)
Object	getPluginClassInstance(String className, Class interfaceType, Collection<FileMessage> errors)
PrintWriter	getPrintWriter()
IProgressManager	getProgressManager()
ISchedulingStrategist	getSchedulingStrategist()
ISearcher	getSearcher()
IStateFactory	getStateFactory()
IStateManager	getStateManager()
SymbolTable	getSymbolTable()
ISystemTransformer[]	getSystemTransformers(Properties configuration, Collection<FileMessage> errors) Retrieve a (possibly empty) set of syntax-tree transformers which should run prior to the model-checking phase.
ITransformer	getTransformer()
IValueFactory	getValueFactory()
IMessageStore	initialize(SymbolTable symbolTable, IProgressManager pm, PrintWriter pw, Properties configuration)
void	setActionTaker(IActionTaker at)
void	setBacktrackingInfoFactory(IBacktrackingInfoFactory bif)
void	setCounterExampleWriter(ICounterExampleWriter cew)
void	setExpEvaluator(IExpEvaluator ee)
void	setProgressManager(IProgressManager pm)
void	setSchedulingStrategist(ISchedulingStrategist ss)
void	setSearcher(ISearcher sr)
void	setStateFactory(IStateFactory sf)
void	setStateManager(IStateManager sm)
void	setTransformer(ITransformer tr)
void	setValueFactory(IValueFactory vf)

Methods inherited from interface edu.ksu.cis.projects.bogor.util.Disposable

dispose

Field Detail

ACTION_DEF_EXT_OP_RETURN_TYPE

static final Class<IBacktrackingInfo> ACTION_DEF_EXT_OP_RETURN_TYPE

EXP_DEF_EXT_OP_RETURN_TYPE

static final Class<IValue> EXP_DEF_EXT_OP_RETURN_TYPE

EXT_OP_ARG_TYPES

static final Class[] EXT_OP_ARG_TYPES

EXT_OP_ARG_NAMES

static final String[] EXT_OP_ARG_NAMES

Method Detail

setActionTaker

void setActionTaker(IActionTaker at)

getActionTaker

IActionTaker getActionTaker()

setBacktrackingInfoFactory

void setBacktrackingInfoFactory(IBacktrackingInfoFactory bif)

getBacktrackingInfoFactory

IBacktrackingInfoFactory getBacktrackingInfoFactory()

setCounterExampleWriter

void setCounterExampleWriter(ICounterExampleWriter cew)

getCounterExampleWriter

ICounterExampleWriter getCounterExampleWriter()

getConfiguration

Properties getConfiguration()

setExpEvaluator

void setExpEvaluator(IExpEvaluator ee)

getExpEvaluator

IExpEvaluator getExpEvaluator()

getExtTable

Map<ExtSymbolTable,IModule> getExtTable()

getFilename

String getFilename()

getPrintWriter

PrintWriter getPrintWriter()

setProgressManager

void setProgressManager(IProgressManager pm)

getProgressManager

IProgressManager getProgressManager()

setSchedulingStrategist

void setSchedulingStrategist(ISchedulingStrategist ss)

getSchedulingStrategist

ISchedulingStrategist getSchedulingStrategist()

setSearcher

void setSearcher(ISearcher sr)

getSearcher

ISearcher getSearcher()

setStateFactory

void setStateFactory(IStateFactory sf)

getStateFactory

IStateFactory getStateFactory()

setStateManager

void setStateManager(IStateManager sm)

getStateManager

IStateManager getStateManager()

getSymbolTable

SymbolTable getSymbolTable()

setTransformer

void setTransformer(ITransformer tr)

getTransformer

ITransformer getTransformer()

setValueFactory

void setValueFactory(IValueFactory vf)

getValueFactory

IValueFactory getValueFactory()

getListeners

List<IListener> getListeners()

getExtensionModule

IModule getExtensionModule(String extId)

getPluginClassInstance

Object getPluginClassInstance(String className,
                              Class interfaceType,
                              Collection<FileMessage> errors)

Parameters:

errors - container for any FileMessage error messages generated while trying to get object instance

getPluginClassInstance

Object getPluginClassInstance(Properties config,
                              String className,
                              Class interfaceType,
                              Collection<FileMessage> errors)

Parameters:

errors - container for any FileMessage error messages generated while trying to get object instance

getModuleInstance

Object getModuleInstance(String className,
                         Class interfaceType,
                         Collection<FileMessage> errors)

Instantiate a Bogor module (an implementation of IModule).

Parameters:

className - fully qualified typename of object to instantiate

interfaceType - static type to which the new object must conform

errors - destination for any FileMessage error messages generated while trying to instantiate the module

Returns:

an instance of className if no errors occur, or null otherwise.

getSystemTransformers

ISystemTransformer[] getSystemTransformers(Properties configuration,
                                           Collection<FileMessage> errors)

Retrieve a (possibly empty) set of syntax-tree transformers which should run prior to the model-checking phase.

Parameters:

configuration - unmarshalled form of .bogor-conf file. A comma-separated list of class names given as the value of the edu.ksu.cis.projects.bogor.ast.transform.ISystemTransformer key will be instantiated and send back as the return value.

errors - destination for any FileMessage error messages generated while trying to instantiate AST transformers.

connect

IMessageStore connect()

initialize

IMessageStore initialize(SymbolTable symbolTable,
                         IProgressManager pm,
                         PrintWriter pw,
                         Properties configuration)

getKnownImplementingClasses

List<Class> getKnownImplementingClasses(Class<?> interfaceType)

An optional method which attempts to search the runtime for known implementations of a particular Bogor module type.

Parameters:

interfaceType - The API for which all implementing types should be found. Must be non-null.

Returns:

If this operation is supported, then a list of classes, each of which is a non-abstract class which is a subtype of interfaceType. If the operation is not supported, then an empty list is returned.