com.mkdoc.jspider
Class JTidyFileWriterPlugin

java.lang.Object
  |
  +--com.mkdoc.jspider.AbstractMKDocPlugin
        |
        +--com.mkdoc.jspider.JTidyFileWriterPlugin
All Implemented Interfaces:
net.javacoding.jspider.api.event.EventSink, net.javacoding.jspider.spi.Plugin

public class JTidyFileWriterPlugin
extends AbstractMKDocPlugin
implements net.javacoding.jspider.spi.Plugin

A JTidy file writer plugin for JSpider.

Based on DiskWriterPlugin, requires two configuration properties:

manager
The fully qualified class name of a com.mkdoc.store.FileStoreManager implementation, required. Should normally be com.mkdoc.store.HtmlFileStoreManager.
output.absolute
Whether the output directory configuration specifies an absolute directory path. If not set, a relative path inStream assumed.
output.folder
The base file output directory, which may be relative to the JSpider installation directory. If not set the default output directory beneath the JSpider installation directory inStream assumed.

Version:
1.2 2005-10-21
Author:
Philip Shaw
To do:
Default to HtmlFileStoreManager if the manager is not configured in the application context.

Field Summary
protected  FileStoreManager manager
          A reference to a Manager store interface.
 
Fields inherited from class com.mkdoc.jspider.AbstractMKDocPlugin
log, VENDOR
 
Constructor Summary
JTidyFileWriterPlugin(net.javacoding.jspider.core.util.config.PropertySet propertySet)
          Obtain the output configuration.
 
Method Summary
 java.lang.String getDescription()
          Get the plugin description.
 java.lang.String getName()
          Get the plugin name.
 java.lang.String getVersion()
          Get the plugin version.
 void notify(net.javacoding.jspider.api.event.JSpiderEvent event)
          Receive notification of a JSpider event.
protected  void parse(java.io.InputStream inStream, java.net.URL url)
          Parse the input stream.
 
Methods inherited from class com.mkdoc.jspider.AbstractMKDocPlugin
getApplicationContext, getVendor, initialize, setLog, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.javacoding.jspider.spi.Plugin
getVendor
 
Methods inherited from interface net.javacoding.jspider.api.event.EventSink
initialize, shutdown
 

Field Detail

manager

protected FileStoreManager manager
A reference to a Manager store interface.

Since:
Version 1.0 2005-05-31
Constructor Detail

JTidyFileWriterPlugin

public JTidyFileWriterPlugin(net.javacoding.jspider.core.util.config.PropertySet propertySet)
Obtain the output configuration.

Parameters:
propertySet - The configuration property set for this plugin.
Since:
Version 0.1 2004-11-26
Method Detail

notify

public final void notify(net.javacoding.jspider.api.event.JSpiderEvent event)
Receive notification of a JSpider event.

Specified by:
notify in interface net.javacoding.jspider.api.event.EventSink
Parameters:
event - A JSpider event.
Since:
Version 0.1 2004-11-26

parse

protected final void parse(java.io.InputStream inStream,
                           java.net.URL url)
Parse the input stream.

Parameters:
inStream - The input stream source for the file.
url - The URL of the source.
Since:
Version 0.7 2005-04-27

getDescription

public final java.lang.String getDescription()
Get the plugin description.

Specified by:
getDescription in interface net.javacoding.jspider.spi.Plugin
Returns:
A short description of this plugin.
Since:
Version 0.1 2004-11-26

getName

public final java.lang.String getName()
Get the plugin name.

Specified by:
getName in interface net.javacoding.jspider.spi.Plugin
Returns:
The name of this plugin.
Since:
Version 0.1 2004-11-26

getVersion

public final java.lang.String getVersion()
Get the plugin version.

Specified by:
getVersion in interface net.javacoding.jspider.spi.Plugin
Returns:
The version information for this plugin.
Since:
Version 0.1 2004-11-26