org.qedeq.kernel.bo.module
Interface KernelQedeqBo

All Superinterfaces:

QedeqBo

All Known Implementing Classes:

DefaultKernelQedeqBo

public interface KernelQedeqBo
extends QedeqBo

Kernel internal QedeqBo with additional methods.

Author:

Michael Meyling

Method Summary

void	addPluginErrorsAndWarnings(ModuleService plugin, SourceFileExceptionList errors, SourceFileExceptionList warnings) Add errors and warnings for service.
void	clearAllPluginErrorsAndWarnings() Remove all errors and warnings for all services.
SourceFileException	createSourceFileException(Service service, ModuleDataException exception) Create exception out of ModuleDataException.
Element2Latex	getElement2Latex() Return mapper for transforming elements into LaTeX.
Element2Utf8	getElement2Utf8() Return mapper for transforming elements into UTF-8 text.
ModuleConstantsExistenceChecker	getExistenceChecker() Get the predicate and function existence checker.
KernelModuleReferenceList	getKernelRequiredModules() Get labels and URLs of all referenced modules.
InternalKernelServices	getKernelServices() Get internal kernel services.
ModuleLabels	getLabels() Get label references for QEDEQ module.
void	setDependencyFailureState(DependencyState loadRequiredFailed, SourceFileExceptionList sfl) Set dependency failure module state.
void	setDependencyProgressState(DependencyState state) Set dependency module state.
void	setExistenceChecker(ModuleConstantsExistenceChecker existence) Set ModuleConstantsExistenceChecker.
void	setFormallyProvedFailureState(FormallyProvedState state, SourceFileExceptionList sfl) Set logical formally proved module failure state.
void	setFormallyProvedProgressState(FormallyProvedState state) Set logical formally proved module progress state.
void	setLoadedImports(KernelModuleReferenceList imports) Set loaded imports state.
void	setLoadedRequiredModules() Set loaded required requirements state.
void	setLoadingImportsFailureState(LoadingImportsState loadImportsFailed, SourceFileExceptionList sfl) Set failure module state.
void	setLoadingImportsProgressState(LoadingImportsState stateLoadImports) Set logical well formed module state.
void	setWellfFormedFailureState(WellFormedState stateExternalCheckingFailed, SourceFileExceptionList sfl) Set failure module state.
void	setWellFormed(ModuleConstantsExistenceChecker checker) Set logic well formed state.
void	setWellFormedProgressState(WellFormedState stateInternalChecking) Set logical well formed module state.

Methods inherited from interface org.qedeq.kernel.bo.common.QedeqBo

getCurrentlyRunningService, getCurrentState, getDependencyState, getErrors, getFormallyProvedState, getLastSuccessfulState, getLoadingCompleteness, getLoadingImportsState, getLoadingState, getModuleAddress, getName, getOriginalLanguage, getQedeq, getRequiredModules, getRuleVersion, getStateDescription, getSupportedLanguages, getUrl, getWarnings, getWellFormedState, hasBasicFailures, hasErrors, hasLoadedImports, hasLoadedRequiredModules, hasWarnings, isFullyFormallyProved, isLoaded, isSupportedLanguage, isWellFormed

Method Detail

getKernelServices

InternalKernelServices getKernelServices()

Get internal kernel services.

Returns:

Internal kernel services.

getKernelRequiredModules

KernelModuleReferenceList getKernelRequiredModules()

Get labels and URLs of all referenced modules.

Returns:

URLs of all referenced modules.

getLabels

ModuleLabels getLabels()

Get label references for QEDEQ module.

Returns:

Label references.

getElement2Latex

Element2Latex getElement2Latex()

Return mapper for transforming elements into LaTeX.

Returns:

Transformer to get LaTeX out of elements.

getElement2Utf8

Element2Utf8 getElement2Utf8()

Return mapper for transforming elements into UTF-8 text.

Returns:

Transformer to get UTF-8 text out of elements.

createSourceFileException

SourceFileException createSourceFileException(Service service,
                                              ModuleDataException exception)

Create exception out of ModuleDataException.

Parameters:

service - This service generated the error.

exception - Take this exception.

Returns:

Newly created instance.

addPluginErrorsAndWarnings

void addPluginErrorsAndWarnings(ModuleService plugin,
                                SourceFileExceptionList errors,
                                SourceFileExceptionList warnings)

Add errors and warnings for service.

Parameters:

plugin - Add errors for this service.

errors - These errors occurred.

warnings - These warnings occurred.

clearAllPluginErrorsAndWarnings

void clearAllPluginErrorsAndWarnings()

Remove all errors and warnings for all services.

getExistenceChecker

ModuleConstantsExistenceChecker getExistenceChecker()

Get the predicate and function existence checker. Is only not null if logic was successfully checked.

Returns:

Checker. Checks if a predicate or function constant is defined.

setLoadingImportsFailureState

void setLoadingImportsFailureState(LoadingImportsState loadImportsFailed,
                                   SourceFileExceptionList sfl)

Set failure module state.

Parameters:

loadImportsFailed - Module state.

sfl - Exception that occurred during loading required modules.

Throws:

java.lang.IllegalArgumentException - state is no failure state

setLoadingImportsProgressState

void setLoadingImportsProgressState(LoadingImportsState stateLoadImports)

Set logical well formed module state. Must not be null.

Parameters:

stateLoadImports - module state

setLoadedImports

void setLoadedImports(KernelModuleReferenceList imports)

Set loaded imports state. All directly required modules were loaded.

Parameters:

imports - These imports were loaded.

Throws:

java.lang.IllegalStateException - Module is not yet loaded.

setDependencyFailureState

void setDependencyFailureState(DependencyState loadRequiredFailed,
                               SourceFileExceptionList sfl)

Set dependency failure module state.

Parameters:

loadRequiredFailed - Module state.

sfl - Exception that occurred during loading required modules.

Throws:

java.lang.IllegalArgumentException - loadRequiredFailed is no failure state

java.lang.IllegalStateException - Module is not yet loaded.

java.lang.NullPointerException - loadRequiredFailed is null.

setDependencyProgressState

void setDependencyProgressState(DependencyState state)

Set dependency module state. Must not be null.

Parameters:

state - Module state

Throws:

java.lang.IllegalStateException - Module is not yet loaded.

java.lang.IllegalArgumentException - state is failure state or loaded required state.

java.lang.NullPointerException - state is null.

setLoadedRequiredModules

void setLoadedRequiredModules()

Set loaded required requirements state.

Throws:

java.lang.IllegalStateException - Module is not yet loaded.

setWellfFormedFailureState

void setWellfFormedFailureState(WellFormedState stateExternalCheckingFailed,
                                SourceFileExceptionList sfl)

Set failure module state.

Parameters:

stateExternalCheckingFailed - Module state.

sfl - Exception that occurred during loading.

Throws:

java.lang.IllegalArgumentException - state is no failure state

setWellFormedProgressState

void setWellFormedProgressState(WellFormedState stateInternalChecking)

Set logical well formed module state. Must not be null.

Parameters:

stateInternalChecking - module state

setFormallyProvedProgressState

void setFormallyProvedProgressState(FormallyProvedState state)

Set logical formally proved module progress state. Must not be null.

Parameters:

state - module state

Throws:

java.lang.IllegalArgumentException - state is no failure state

setFormallyProvedFailureState

void setFormallyProvedFailureState(FormallyProvedState state,
                                   SourceFileExceptionList sfl)

Set logical formally proved module failure state. Must not be null.

Parameters:

state - module state

sfl - Exception that occurred during loading.

Throws:

java.lang.IllegalArgumentException - state is no failure state

setExistenceChecker

void setExistenceChecker(ModuleConstantsExistenceChecker existence)

Set ModuleConstantsExistenceChecker. Doesn't do any status handling.

Parameters:

existence - Set this checker.

setWellFormed

void setWellFormed(ModuleConstantsExistenceChecker checker)

Set logic well formed state. Also set the predicate and function existence checker.

Parameters:

checker - Checks if a predicate or function constant is defined.