org.processmining.framework.util
Class PluginDocumentationLoader

java.lang.Object
  extended by org.processmining.framework.util.PluginDocumentationLoader

public class PluginDocumentationLoader
extends java.lang.Object

Title: PluginDocumentationLoader

Description: Static class to load documentation from external file in /lib/documentation/ subfolder

Copyright: Copyright (c) 2004

Version:
1.5
Author:
Boudewijn van Dongen, Christian W. Guenther (christian@deckfour.org)

Field Summary
protected static java.lang.String HTML_BODY_REGEX
          Regular expression matching the body of an HTML document in group 4
 
Constructor Summary
PluginDocumentationLoader()
           
 
Method Summary
static java.lang.String load(Plugin p)
          Call load with a reference to the calling plugin to load the appropriate HTML body from a file with the name p.getName()+".html"
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML_BODY_REGEX

protected static final java.lang.String HTML_BODY_REGEX
Regular expression matching the body of an HTML document in group 4

See Also:
Constant Field Values
Constructor Detail

PluginDocumentationLoader

public PluginDocumentationLoader()
Method Detail

load

public static java.lang.String load(Plugin p)
Call load with a reference to the calling plugin to load the appropriate HTML body from a file with the name p.getName()+".html"

Parameters:
p - Plugin to load HTML body for
Returns:
String the HTML body, or null if the file is not found or read errors occur