org.qedeq.kernel.bo.module
Interface KernelServices

All Known Subinterfaces:

InternalKernelServices, KernelState

All Known Implementing Classes:

DefaultInternalKernelServices, KernelContext

public interface KernelServices

The main QEDEQ kernel methods are assembled here.

Version:

$Revision: 1.1 $

Method Summary

boolean	checkModule(ModuleAddress address) Checks if all formulas of a QEDEQ module and its required modules are well formed.
void	clearLocalBuffer() Clear local buffer and all loaded QEDEQ modules.
ModuleAddress[]	getAllLoadedModules() Get list of all currently loaded QEDEQ modules.
ModuleAddress	getModuleAddress(File file) Get module address from URL.
ModuleAddress	getModuleAddress(String url) Get module address from URL.
ModuleAddress	getModuleAddress(URL url) Get module address from URL.
QedeqBo	getQedeqBo(ModuleAddress address) Get QedeqBo for an address.
String	getSource(ModuleAddress address) Get source of an QEDEQ module.
String[]	getSourceFileExceptionList(ModuleAddress address) Get description of source file exception list.
boolean	loadAllModulesFromQedeq() Load all QEDEQ modules from project web directory for current kernel.
QedeqBo	loadModule(ModuleAddress address) Get a certain module.
void	loadRequiredModules(ModuleAddress address) Get a certain module.
void	removeAllModules() Remove all modules from memory.
void	removeModule(ModuleAddress address) Remove a certain module.

Method Detail

removeAllModules

public void removeAllModules()

Remove all modules from memory.

clearLocalBuffer

public void clearLocalBuffer()
                      throws IOException

Clear local buffer and all loaded QEDEQ modules.

Throws:

IOException - Deletion of all buffered file was not successful.

loadModule

public QedeqBo loadModule(ModuleAddress address)
                   throws SourceFileExceptionList

Get a certain module.

Parameters:

address - Address of module.

Returns:

Wanted module.

Throws:

SourceFileExceptionList - Module could not be successfully loaded.

loadRequiredModules

public void loadRequiredModules(ModuleAddress address)
                         throws SourceFileExceptionList

Get a certain module.

Parameters:

address - Address of module.

Throws:

SourceFileExceptionList - Required modules could not be successfully loaded. This can also happen if the required modules references form a circle.

loadAllModulesFromQedeq

public boolean loadAllModulesFromQedeq()

Load all QEDEQ modules from project web directory for current kernel.

Returns:

Successful loading.

removeModule

public void removeModule(ModuleAddress address)

Remove a certain module.

Parameters:

address - Address of module.

getAllLoadedModules

public ModuleAddress[] getAllLoadedModules()

Get list of all currently loaded QEDEQ modules.

Returns:

All currently loaded QEDEQ modules.

getQedeqBo

public QedeqBo getQedeqBo(ModuleAddress address)

Get QedeqBo for an address.

Parameters:

address - Look for this address.

Returns:

Existing or new QedeqBo, if address is maleformed null is returned.

getSource

public String getSource(ModuleAddress address)
                 throws IOException

Get source of an QEDEQ module. If the module was not yet not buffered null is returned.

Parameters:

address - Address for QEDEQ module address.

Returns:

Contents of locally buffered QEDEQ module.

Throws:

IOException - Loading failed.

getModuleAddress

public ModuleAddress getModuleAddress(URL url)
                               throws IOException

Get module address from URL.

Parameters:

url - URL for QEDEQ module.

Returns:

Module address.

Throws:

IOException - URL has not the correct format for referencing a QEDEQ module.

getModuleAddress

public ModuleAddress getModuleAddress(String url)
                               throws IOException

Get module address from URL.

Parameters:

url - URL for QEDEQ module.

Returns:

Module address.

Throws:

IOException - URL has not the correct format for referencing a QEDEQ module.

getModuleAddress

public ModuleAddress getModuleAddress(File file)
                               throws IOException

Get module address from URL.

Parameters:

file - Local QEDEQ module.

Returns:

Module address.

Throws:

IOException - URL has not the correct format for referencing a QEDEQ module.

checkModule

public boolean checkModule(ModuleAddress address)

Checks if all formulas of a QEDEQ module and its required modules are well formed.

Parameters:

address - Module to check.

Returns:

Was check successful?

getSourceFileExceptionList

public String[] getSourceFileExceptionList(ModuleAddress address)

Get description of source file exception list.

Parameters:

address - Get description for this module exceptions.

Returns:

Error description and location.