net.sourceforge.pldoc

Class PLDoc

java.lang.Object

net.sourceforge.pldoc.PLDoc

public class PLDoc
extends Object

PL/SQL documentation generator.

2006-05-16 - Matthias Hendler - Rewritten execption handling in Methode run and processPackage. Now the program ignores not only exceptions thrown by the parser but also thrown errors. Also a summary of skipped packages will be written to stderr at the program end. User can specify if he wants to get a generator summary in which he can see errors encountered during processing packages. Creation date is also added to the XML document (application.xml) for further XSLT processing.

Version:

$Header: /cvsroot/pldoc/sources/src/java/net/sourceforge/pldoc/PLDoc.java,v 1.13 2005/11/29 08:25:00 gpaulissen Exp $

Author:

Albert Tumanov

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceLoader	resLoader
static ResourceResolver	resResolver
Settings	settings

Constructor Summary

Constructors

Constructor and Description
PLDoc(Settings settings) Create using collected or defaulted settings.

Method Summary

Modifier and Type	Method and Description
static URIResolver	getResourceResolver()
static InputStream	getResourceStream(String path)
static void	main(String[] args) Generate PLDoc from the command-line - all settings are passed as command-line parameters
Throwable	processPackage(BufferedReader packageSpec, XMLWriter xmlOut, String pPackageName, String pSchemaName, String pGlobalPackageName) Processes a package.
void	resultSetToXml(ResultSet resultSet, OutputStream outputStream, String documentRootName, String rowElementName, String dtd) Write ResultSet to Output As XML using the specified settings.
void	run() Run PLDoc using the specified settings.

Methods inherited from class java.lang.Object

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

Field Detail

resResolver

public static final ResourceResolver resResolver

resLoader

public static final ResourceLoader resLoader

settings

public Settings settings

Constructor Detail

PLDoc

public PLDoc(Settings settings)

Create using collected or defaulted settings.

Parameters:

settings - the collected settings from command-line, ANt task or Maven mojo.

Method Detail

main

public static void main(String[] args)
                 throws Exception

Generate PLDoc from the command-line - all settings are passed as command-line parameters

Parameters:

args - all command-line settings

Throws:

Exception - on error

run

public void run()
         throws Exception

Run PLDoc using the specified settings.

Throws:

Exception - on error 2006-05-16 - Matthias Hendler - Collect some status information during the processing and add them to the application.xml. More verbose output to console added.

resultSetToXml

public void resultSetToXml(ResultSet resultSet,
                           OutputStream outputStream,
                           String documentRootName,
                           String rowElementName,
                           String dtd)
                    throws Exception

Write ResultSet to Output As XML using the specified settings.

Parameters:

resultSet - the database information to write

outputStream - outputStream

documentRootName - the root Element of the XML document

rowElementName - the element containing each row document

dtd - Optional DTD that the XML should validate against

Throws:

Exception - on error

processPackage

public Throwable processPackage(BufferedReader packageSpec,
                                XMLWriter xmlOut,
                                String pPackageName,
                                String pSchemaName,
                                String pGlobalPackageName)
                         throws net.sourceforge.pldoc.PLDoc.SystemExitException

Processes a package. 2006-05-16 - Matthias Hendler - Rewritten exception handling and methode signature.

Parameters:

packageSpec - Package specification to parse

xmlOut - XML writer

pPackageName - The name of the package which is processed

pSchemaName - The name of the package owner

pGlobalPackageName - The name of the default package name to contain function, procedure and trigger PLDoc if pSchemaName is not provided

Returns:

Null, if successfully processed or otherwise throwable which was encountered during processing.

Throws:

SystemExitException - Thrown if an error occurred and the user specified the halt on errors option. All other throwables will be caught.

net.sourceforge.pldoc.PLDoc.SystemExitException

getResourceStream

public static InputStream getResourceStream(String path)
                                     throws IOException

Throws:

IOException

getResourceResolver

public static URIResolver getResourceResolver()