org.qedeq.kernel.bo.module
Interface QedeqFileDao

All Known Implementing Classes:

XmlQedeqFileDao

public interface QedeqFileDao

An instance of this interface can load and save QEDEQ module files.

Author:

Michael Meyling

Method Summary

SourceArea	createSourceArea(Qedeq qedeq, ModuleContext context) Get area in source file for QEDEQ module context.
java.io.Reader	getModuleReader(KernelQedeqBo prop) Get reader for local buffered QEDEQ module.
InternalKernelServices	getServices() Get kernel services.
Qedeq	loadQedeq(InternalServiceJob process, QedeqBo prop, java.io.File localFile) Load a QEDEQ module from file.
void	saveQedeq(InternalServiceJob process, KernelQedeqBo prop, java.io.File localFile) Save a QEDEQ module as file.
void	setServices(InternalKernelServices services) Set kernel services.

Method Detail

setServices

void setServices(InternalKernelServices services)

Set kernel services. Is called by the kernel to give this loader the opportunity to use kernel services within its methods. This is the first method the kernel calls.

Parameters:

services - Internal kernel services.

getServices

InternalKernelServices getServices()

Get kernel services.

Returns:

Internal kernel services.

loadQedeq

Qedeq loadQedeq(InternalServiceJob process,
                QedeqBo prop,
                java.io.File localFile)
                throws SourceFileExceptionList

Load a QEDEQ module from file.

Parameters:

process - We work for this service process.

prop - Module properties.

localFile - Load file from this location.

Returns:

Loaded QEDEQ.

Throws:

SourceFileExceptionList - Module could not be successfully loaded.

saveQedeq

void saveQedeq(InternalServiceJob process,
               KernelQedeqBo prop,
               java.io.File localFile)
               throws SourceFileExceptionList,
                      java.io.IOException

Save a QEDEQ module as file.

Parameters:

process - We work in this service process.

prop - Module properties.

localFile - Save module in this file.

Throws:

SourceFileExceptionList - Module could not be successfully saved.

java.io.IOException - File saving failed.

createSourceArea

SourceArea createSourceArea(Qedeq qedeq,
                            ModuleContext context)

Get area in source file for QEDEQ module context. If the system property "qedeq.test.xmlLocationFailures" is set to "true" a runtime exception is thrown if the context is not found.

Parameters:

qedeq - Look at this QEDEQ module.

context - Search for this context.

Returns:

Created file area. Maybe null.

getModuleReader

java.io.Reader getModuleReader(KernelQedeqBo prop)
                               throws java.io.IOException

Get reader for local buffered QEDEQ module.

Parameters:

prop - QEDEQ BO.

Returns:

Reader.

Throws:

java.io.IOException - Reading failed.