org.foray.app
Class Starter

java.lang.Object
  org.foray.app.Starter

Direct Known Subclasses:

CommandLineStarter

public abstract class Starter
extends Object

Abstract super class for all FOray starters.

Constructor Summary

Starter(org.apache.commons.logging.Log logger, SessionConfig sessionConfig, OutputConfig renderConfig)
Constructor.

Method Summary

abstract InputSource	getInputSource() Returns the input source.
org.apache.commons.logging.Log	getLogger() Returns the logger.
Options	getOptions() Returns the options.
OutputConfig	getOutputConfig() Returns the output configuration.
abstract void	run() Runs the process.

Methods inherited from class java.lang.Object

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

Constructor Detail

Starter

public Starter(org.apache.commons.logging.Log logger,
               SessionConfig sessionConfig,
               OutputConfig renderConfig)
        throws FOrayException

Constructor.

Parameters:

logger - The logger. If null, one will be created.

sessionConfig - The session configuration.

renderConfig - The output configuration.

Throws:

FOrayException - For errors durint construction.

Method Detail

run

public abstract void run()
                  throws FOrayException

Runs the process.

Throws:

FOrayException - For errors during processing.

getLogger

public org.apache.commons.logging.Log getLogger()

Returns the logger.

Returns:

The logger.

getOutputConfig

public OutputConfig getOutputConfig()

Returns the output configuration.

Returns:

Returns the outputConfig.

getOptions

public Options getOptions()

Returns the options.

Returns:

Returns the options.

getInputSource

public abstract InputSource getInputSource()
                                    throws FOrayException

Returns the input source.

Returns:

Returns the inputSource.

Throws:

FOrayException - For errors creaing the input source.