org.eclipse.persistence.tools.schemaframework

Class StoredProcedureGenerator

java.lang.Object

org.eclipse.persistence.tools.schemaframework.StoredProcedureGenerator

public class StoredProcedureGenerator
extends java.lang.Object

Purpose: To generate StoredProcedures from EclipseLink Projects

Description: This Class was designed to read in a project and produce StoredProcedures. It then modifies the descriptors files of the project to use these StoredProcedures. NOTE: reads are not supported in Oracle.

Responsibilities:

Since:

TopLink 2.1

Author:

Gordon Yorke

Field Summary

Fields

Modifier and Type	Field and Description
SchemaManager	schemaManager

Constructor Summary

Constructors

Constructor and Description
StoredProcedureGenerator(SchemaManager schemaMngr)

Method Summary

Methods

Modifier and Type	Method and Description
void	generateAmendmentClass(java.io.Writer outputWriter, java.lang.String packageName, java.lang.String className) PUBLIC: Generate an amendment class that will set up the descriptors to use these stored procedures.
void	generateStoredProcedures() PUBLIC: generates all the stored procedures using the schema manager.
void	generateStoredProcedures(java.io.Writer writerOrNull) PUBLIC: generates all the stored procedures to the writer using the schema manager outputDDLToWriter(Writer).
java.lang.String	getPrefix()
org.eclipse.persistence.internal.sessions.AbstractSession	getSession()
java.io.Writer	getWriter()
void	setPrefix(java.lang.String prefix)
void	writeDefinition(StoredProcedureDefinition definition)

Methods inherited from class java.lang.Object

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

Field Detail

schemaManager

public SchemaManager schemaManager

Constructor Detail

StoredProcedureGenerator

public StoredProcedureGenerator(SchemaManager schemaMngr)

Method Detail

generateAmendmentClass

public void generateAmendmentClass(java.io.Writer outputWriter,
                          java.lang.String packageName,
                          java.lang.String className)
                            throws ValidationException

PUBLIC: Generate an amendment class that will set up the descriptors to use these stored procedures.

Throws:

ValidationException

generateStoredProcedures

public void generateStoredProcedures()

PUBLIC: generates all the stored procedures using the schema manager. The schema manager may be set to write directly to the database on the a file. See outputDDLToWriter(Writer) and outputDDLToDatabase() on SchemaManager

generateStoredProcedures

public void generateStoredProcedures(java.io.Writer writerOrNull)

PUBLIC: generates all the stored procedures to the writer using the schema manager outputDDLToWriter(Writer).

getPrefix

public java.lang.String getPrefix()

getSession

public org.eclipse.persistence.internal.sessions.AbstractSession getSession()

getWriter

public java.io.Writer getWriter()

setPrefix

public void setPrefix(java.lang.String prefix)

writeDefinition

public void writeDefinition(StoredProcedureDefinition definition)