cz.cuni.mff.ksi.jinfer.basicigg
Class IGGeneratorImpl

java.lang.Object
  cz.cuni.mff.ksi.jinfer.basicigg.IGGeneratorImpl

All Implemented Interfaces:

Capabilities, IGGenerator, NamedModule

public class IGGeneratorImpl
extends Object
implements IGGenerator

A trivial implementation of IGGenerator module. Works with XML documents, DTD schemas, XPath queries and provides an extension framework to enable support for additional languages (see Processor).

Constructor Summary

IGGeneratorImpl()

Method Summary

List<String>	getCapabilities() Returns the list of capabilities (strings) of this module.
String	getDisplayName() Returns a user friendly name of the module.
String	getModuleDescription() Returns the information about this module's inner workings.
String	getName() Returns a user friendly yet unique name of the module.
void	start(Input input, IGGeneratorCallback callback) Start the IG generation process.

Methods inherited from class java.lang.Object

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

Constructor Detail

IGGeneratorImpl

public IGGeneratorImpl()

Method Detail

getName

public String getName()

Description copied from interface: NamedModule

Returns a user friendly yet unique name of the module.

Specified by:

getName in interface NamedModule

Returns:

Unique module name.

getModuleDescription

public String getModuleDescription()

Description copied from interface: NamedModule

Returns the information about this module's inner workings. Most of the time will be equal to a call to NamedModule.getDisplayName(), but if the module for example consists of more sub-modules, their names should be listed here.

Specified by:

getModuleDescription in interface NamedModule

Returns:

String describing inner structure of the module.

getCapabilities

public List<String> getCapabilities()

Description copied from interface: Capabilities

Returns the list of capabilities (strings) of this module.

Specified by:

getCapabilities in interface Capabilities

Returns:

List of capability names.

start

public void start(Input input,
                  IGGeneratorCallback callback)
           throws InterruptedException

Description copied from interface: IGGenerator

Start the IG generation process. This method is called by the Runner module as the first stage of inference.

Specified by:

start in interface IGGenerator

Parameters:

input - Input data. Implementation of IGGenerator should retrieve the list of initial grammar rules from this input alone.

callback - A callback object. After all the IG rules are retrieved, their list must be sent to the next stages by calling the finished() method of this object.

Throws:

InterruptedException

getDisplayName

public String getDisplayName()

Description copied from interface: NamedModule

Returns a user friendly name of the module. This name is not neccessary unique.

Specified by:

getDisplayName in interface NamedModule

Returns:

Displayable module name.