com.arsdigita.content
Class SqlDoc

java.lang.Object
  |
  +--com.arsdigita.content.SqlDoc

public class SqlDoc

extends java.lang.Object

Class to generate datasources from JavaDoc-style comments in SQL source code, SELECTed from the user_source table.

Field Summary

static java.lang.String

cvsId

Constructor Summary

SqlDoc()

Method Summary

static com.arsdigita.db.ListResultSet	functionList(java.lang.String package_name) gets a list of stored procedures/functions for a package.
DataSource	getPackageInfo(java.lang.String package_name) Returns a datasource with information about a package
static Selection	packageList()

Methods inherited from class java.lang.Object

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

Field Detail

cvsId

public static final java.lang.String cvsId

Constructor Detail

SqlDoc

public SqlDoc()

Method Detail

packageList

public static Selection packageList()
                             throws java.sql.SQLException

Returns:

a list of packages.

functionList

public static com.arsdigita.db.ListResultSet functionList(java.lang.String package_name)
                                                   throws java.sql.SQLException

gets a list of stored procedures/functions for a package.

Parameters:

package_name - the name of the package.

Returns:

the datasource listing the stored procs/functions for the package

getPackageInfo

public DataSource getPackageInfo(java.lang.String package_name)
                          throws java.sql.SQLException

Returns a datasource with information about a package

Parameters:

package_name - the name of the package

Returns:

a datasource with fields "comment" and "see_links"