org.qedeq.kernel.bo.service.unicode
Class Qedeq2Utf8Executor

java.lang.Object
  org.qedeq.kernel.bo.service.unicode.Qedeq2Utf8Executor

All Implemented Interfaces:

ModuleServicePluginExecutor, ServiceCompleteness

public class Qedeq2Utf8Executor
extends java.lang.Object
implements ModuleServicePluginExecutor

Transfer a QEDEQ module into a UTF-8 text file.

This is just a quick written generator. This class just generates some text output to be able to get a visual impression of a QEDEQ module.

Author:

Michael Meyling

Constructor Summary

Qedeq2Utf8Executor(ModuleService plugin, KernelQedeqBo prop, Parameters parameters)
Constructor.

Method Summary

java.lang.Object	executePlugin(InternalModuleServiceCall call, java.lang.Object data) Execute plugin.
java.lang.String	generateUtf8(InternalServiceJob process, java.lang.String language, java.lang.String level) Gives a UTF-8 representation of given QEDEQ module as InputStream.
boolean	getInterrupted() Was the execution interrupted by the user?
java.lang.String	getLocationDescription() Get description of currently taken action.
double	getVisitPercentage() Get percentage of currently running plugin execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

Qedeq2Utf8Executor

public Qedeq2Utf8Executor(ModuleService plugin,
                          KernelQedeqBo prop,
                          Parameters parameters)

Constructor.

Parameters:

plugin - This plugin we work for.

prop - QEDEQ BO object.

parameters - Plugin parameter.

Method Detail

executePlugin

public java.lang.Object executePlugin(InternalModuleServiceCall call,
                                      java.lang.Object data)

Description copied from interface: ModuleServicePluginExecutor

Execute plugin.

Specified by:

executePlugin in interface ModuleServicePluginExecutor

Parameters:

call - Service call.

data - Process execution data.

Returns:

Plugin specific resulting object. Might be null.

generateUtf8

public java.lang.String generateUtf8(InternalServiceJob process,
                                     java.lang.String language,
                                     java.lang.String level)
                              throws SourceFileExceptionList,
                                     java.io.IOException

Gives a UTF-8 representation of given QEDEQ module as InputStream.

Parameters:

process - This process executes us.

language - Filter text to get and produce text in this language only. Might be null

level - Filter for this detail level. LATER mime 20050205: not supported yet.

Returns:

Name of generated file.

Throws:

SourceFileExceptionList - Major problem occurred.

java.io.IOException - File IO failed.

getLocationDescription

public java.lang.String getLocationDescription()

Description copied from interface: ModuleServicePluginExecutor

Get description of currently taken action.

Specified by:

getLocationDescription in interface ModuleServicePluginExecutor

Specified by:

getLocationDescription in interface ServiceCompleteness

Returns:

We are doing this currently.

getVisitPercentage

public double getVisitPercentage()

Description copied from interface: ModuleServicePluginExecutor

Get percentage of currently running plugin execution.

Specified by:

getVisitPercentage in interface ModuleServicePluginExecutor

Specified by:

getVisitPercentage in interface ServiceCompleteness

Returns:

Number between 0 and 100.

getInterrupted

public boolean getInterrupted()

Description copied from interface: ModuleServicePluginExecutor

Was the execution interrupted by the user?

Specified by:

getInterrupted in interface ModuleServicePluginExecutor

Returns:

The execution was interrupted.