net.sourceforge.pldoc.database

Class PLDocParser

java.lang.Object

net.sourceforge.pldoc.database.PLDocParser

public class PLDocParser
extends Object

Provide a database API for PLDoc, allowing code to be documented within the database.

Constructor Summary

Constructors

Constructor and Description
PLDocParser()
PLDocParser(Settings settings)

Method Summary

Modifier and Type	Method and Description
static int	copy(InputStream input, OutputStream output)
static int	copy(InputStream input, Writer output)
static int	copy(Reader input, OutputStream output)
static int	copy(Reader input, Writer output)
static Object	getDBObject(Connection connection, int returnType, String sqlStatement) Helper method to confirm database working.
static Clob	getResource(String path, Clob resourceClob) Helper method to provision and return Clob from PLDoc resource
static URIResolver	getResourceResolver() Helper method to return fixed URIResolver to alternative applications: this provides read access to internal PLDoc resources such as stylesheets.
static InputStream	getResourceStream(String path) Helper method to return InputStream from internal PLDoc resources such as stylesheets.
Settings	getSettings()
static void	main(String[] args) Perform ad hoc test using command line parameters or defaults if not supplied.
void	parse(String schemaName, String objectName, String objectType, Clob objectCode, Clob parsedCode) Parse object PLDoc into intermediate XML.
static void	setResource(String path, Clob resourceClob) Helper method to copy PLDoc resource to provided Clob
void	setSettings(Settings settings)

Methods inherited from class java.lang.Object

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

Constructor Detail

PLDocParser

public PLDocParser()

PLDocParser

public PLDocParser(Settings settings)

Method Detail

getSettings

public Settings getSettings()

setSettings

public void setSettings(Settings settings)

parse

public void parse(String schemaName,
                  String objectName,
                  String objectType,
                  Clob objectCode,
                  Clob parsedCode)
           throws Exception

Parse object PLDoc into intermediate XML.

Parameters:

schemaName - The name of the owner of the object to be parsed

objectName - The name of the object to be parsed

objectType - The type of the object to be parsed

objectCode - Object code to parsed

parsedCode - Clob that parsed information will be written to

Throws:

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

getResourceResolver

public static URIResolver getResourceResolver()

Helper method to return fixed URIResolver to alternative applications: this provides read access to internal PLDoc resources such as stylesheets.

Returns:

URIResolver including internal PLDoc resources.

getResourceStream

public static InputStream getResourceStream(String path)
                                     throws IOException

Helper method to return InputStream from internal PLDoc resources such as stylesheets.

Parameters:

path - name of internal resopurce

Returns:

internal PLDoc resources.

Throws:

IOException - on problem retrieving PLDoc resource.

setResource

public static void setResource(String path,
                               Clob resourceClob)
                        throws IOException,
                               SQLException

Helper method to copy PLDoc resource to provided Clob

Parameters:

path - name of internal resopurce

resourceClob - target database Clob.

Throws:

IOException - on problem retrieving PLDoc resource or copying to output.

SQLException - on problem retrieving PLDoc resource.

getResource

public static Clob getResource(String path,
                               Clob resourceClob)
                        throws IOException,
                               SQLException

Helper method to provision and return Clob from PLDoc resource

Parameters:

path - name of internal resopurce

resourceClob - target database Clob.

Returns:

provisioned database object.

Throws:

IOException - on problem retrieving PLDoc resource or copying to output.

SQLException - on problem retrieving PLDoc resource.

main

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

Perform ad hoc test using command line parameters or defaults if not supplied.

Parameters:

args - array of command-line parameters

Throws:

Exception - on any encountered error

copy

public static int copy(InputStream input,
                       OutputStream output)
                throws IOException

Throws:

IOException

copy

public static int copy(Reader input,
                       OutputStream output)
                throws IOException

Throws:

IOException

copy

public static int copy(InputStream input,
                       Writer output)
                throws IOException

Throws:

IOException

copy

public static int copy(Reader input,
                       Writer output)
                throws IOException

Throws:

IOException

getDBObject

public static Object getDBObject(Connection connection,
                                 int returnType,
                                 String sqlStatement)
                          throws SQLException

Helper method to confirm database working.

Parameters:

connection - Database connection

returnType - the required/expected return type java.sql.Types}

sqlStatement - the SQl steatement to generate the daatabase object

Returns:

the databse Object to be returned

Throws:

SQLException - on database connection or access problems