com.mkdoc.jspider
Class AbstractMKDocPlugin

java.lang.Object
  |
  +--com.mkdoc.jspider.AbstractMKDocPlugin
Direct Known Subclasses:
AbstractRdfPlugin, JTidyFileWriterPlugin

public abstract class AbstractMKDocPlugin
extends java.lang.Object

Abstract base class for MKDoc JSpider plugins.

Version:
0.7 2005-07-12
Author:
Philip Shaw

Field Summary
protected  net.javacoding.jspider.core.logging.Log log
          A reference to the logging implementation.
protected static java.lang.String VENDOR
          The plugin vendor.
 
Constructor Summary
AbstractMKDocPlugin()
           
 
Method Summary
static ApplicationContext getApplicationContext(net.javacoding.jspider.core.util.config.PropertySet propertySet)
          Get the plugin application context.
 java.lang.String getVendor()
          Get the vendor identifier.
 void initialize()
          Initialialise the plugin.
 void setLog(net.javacoding.jspider.core.logging.Log log)
          Change the Log implementation.
 void shutdown()
          Shut down the plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected net.javacoding.jspider.core.logging.Log log
A reference to the logging implementation.

Since:
Version 0.3 2005-01-14

VENDOR

protected static final java.lang.String VENDOR
The plugin vendor.

Since:
Version 0.1 2004-12-10
See Also:
Constant Field Values
Constructor Detail

AbstractMKDocPlugin

public AbstractMKDocPlugin()
Method Detail

getVendor

public final java.lang.String getVendor()
Get the vendor identifier.

Returns:
The identifier for the plugin vendor.
Since:
Version 0.1 2004-12-10

setLog

public final void setLog(net.javacoding.jspider.core.logging.Log log)
Change the Log implementation.

Parameters:
log - The Log implementation to substitute, not null.
Since:
Version 0.3 2005-01-14

initialize

public void initialize()
Initialialise the plugin.

Not implemented.

Since:
Version 0.5 2005-04-27

shutdown

public void shutdown()
Shut down the plugin.

Not implemented.

Since:
Version 0.5 2005-04-27

getApplicationContext

public static final ApplicationContext getApplicationContext(net.javacoding.jspider.core.util.config.PropertySet propertySet)
Get the plugin application context.

Parameters:
propertySet - The property set obtained from the JSpider engine.
Returns:
A plugin application context.
Since:
Version 0.7 2005-07-12