Class TableCreatorClassGenerator
- java.lang.Object
-
- org.eclipse.persistence.sessions.factories.TableCreatorClassGenerator
-
public class TableCreatorClassGenerator extends Object
Purpose: Allow for a class storing a TopLink table creator's tables (meta-data) to be generated. This class can then be used at runtime to (re)create a project's database schema.
- Since:
- TopLink 3.0
- Author:
- James Sutherland
-
-
Field Summary
Fields Modifier and Type Field Description protected String
className
protected String
outputFileName
protected String
outputPath
protected Writer
outputWriter
protected String
packageName
protected TableCreator
tableCreator
-
Constructor Summary
Constructors Constructor Description TableCreatorClassGenerator()
PUBLIC: Create a new generator.TableCreatorClassGenerator(TableCreator tableCreator)
PUBLIC: Create a new generator to output the table creator.TableCreatorClassGenerator(TableCreator tableCreator, String projectClassName, Writer outputWriter)
PUBLIC: Create a new generator to output the table creator.TableCreatorClassGenerator(TableCreator tableCreator, String projectClassName, String fileName)
PUBLIC: Create a new generator to output the table creator.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addFieldLines(FieldDefinition field, NonreflectiveMethodDefinition method)
protected void
addForeignKeyLines(ForeignKeyConstraint foreignKey, NonreflectiveMethodDefinition method)
protected NonreflectiveMethodDefinition
buildConstructor()
protected NonreflectiveMethodDefinition
buildLoginMethod(DatabaseLogin login)
protected NonreflectiveMethodDefinition
buildTableMethod(TableDefinition table)
void
generate()
PUBLIC: Generate the project class, output the java source code to the stream or file.void
generate(boolean useUnicode)
PUBLIC: Generate the creator class, output the java source code to the stream or file.protected ClassDefinition
generateCreatorClass()
Return a class definition object representing the code to be generated for the table creator.String
getClassName()
PUBLIC: Return the name of class to be generated.String
getOutputFileName()
PUBLIC: Return the file name that the generate .java file will be output to.String
getOutputPath()
PUBLIC: Return the path that the generate .java file will be output to.Writer
getOutputWriter()
PUBLIC: Return the writer the output to.String
getPackageName()
PUBLIC: Return the package name of class to be generated.TableCreator
getTableCreator()
PUBLIC: Return the table creator to generate from.protected String
printString(Object value)
Return the printed version of the primitive value object.protected String
removeDots(String packageName)
void
setClassName(String newClassName)
PUBLIC: Set the name of class to be generated.void
setOutputFileName(String newOutputFileName)
PUBLIC: Set the file name that the generate .java file will be output to.void
setOutputPath(String newOutputPath)
PUBLIC: Set the path that the generate .java file will be output to.void
setOutputWriter(Writer outputWriter)
PUBLIC: Set the writer the output to.void
setPackageName(String newPackageName)
PUBLIC: Set the package name of class to be generated.void
setTableCreator(TableCreator tableCreator)
PUBLIC: Set the table creator to generate from.static void
write(TableCreator tableCreator, String creatorClassName, Writer writer)
PUBLIC: Generate the source code to a table creator class to the table creator's tables into the writer.static void
write(TableCreator tableCreator, String creatorClassName, String fileName)
PUBLIC: Generate the source code to a table creator class to the table creator's tables into the file.
-
-
-
Constructor Detail
-
TableCreatorClassGenerator
public TableCreatorClassGenerator()
PUBLIC: Create a new generator.
-
TableCreatorClassGenerator
public TableCreatorClassGenerator(TableCreator tableCreator)
PUBLIC: Create a new generator to output the table creator.
-
TableCreatorClassGenerator
public TableCreatorClassGenerator(TableCreator tableCreator, String projectClassName, Writer outputWriter)
PUBLIC: Create a new generator to output the table creator.
-
TableCreatorClassGenerator
public TableCreatorClassGenerator(TableCreator tableCreator, String projectClassName, String fileName)
PUBLIC: Create a new generator to output the table creator.
-
-
Method Detail
-
addFieldLines
protected void addFieldLines(FieldDefinition field, NonreflectiveMethodDefinition method)
-
addForeignKeyLines
protected void addForeignKeyLines(ForeignKeyConstraint foreignKey, NonreflectiveMethodDefinition method)
-
buildConstructor
protected NonreflectiveMethodDefinition buildConstructor()
-
buildLoginMethod
protected NonreflectiveMethodDefinition buildLoginMethod(DatabaseLogin login)
-
buildTableMethod
protected NonreflectiveMethodDefinition buildTableMethod(TableDefinition table)
-
generate
public void generate(boolean useUnicode) throws ValidationException
PUBLIC: Generate the creator class, output the java source code to the stream or file. useUnicode determines if unicode escaped characters for non_ASCII charaters will be used.- Throws:
ValidationException
-
generate
public void generate() throws ValidationException
PUBLIC: Generate the project class, output the java source code to the stream or file. Unicode escaped characters for non_ASCII charaters will be used.- Throws:
ValidationException
-
generateCreatorClass
protected ClassDefinition generateCreatorClass()
Return a class definition object representing the code to be generated for the table creator. This class will have one method per descriptor and its toString can be used to convert it to code.
-
getClassName
public String getClassName()
PUBLIC: Return the name of class to be generated. This is the unqualified name.
-
getOutputFileName
public String getOutputFileName()
PUBLIC: Return the file name that the generate .java file will be output to.
-
getOutputPath
public String getOutputPath()
PUBLIC: Return the path that the generate .java file will be output to.
-
getOutputWriter
public Writer getOutputWriter()
PUBLIC: Return the writer the output to.
-
getPackageName
public String getPackageName()
PUBLIC: Return the package name of class to be generated.
-
getTableCreator
public TableCreator getTableCreator()
PUBLIC: Return the table creator to generate from.
-
printString
protected String printString(Object value)
Return the printed version of the primitive value object. This must determine the class and use the correct constrcutor arguments.
-
setClassName
public void setClassName(String newClassName)
PUBLIC: Set the name of class to be generated. This can be qualified or unqualified name and will set the file name to match.
-
setOutputFileName
public void setOutputFileName(String newOutputFileName)
PUBLIC: Set the file name that the generate .java file will be output to. If the file does not include .java it will be appended.
-
setOutputPath
public void setOutputPath(String newOutputPath)
PUBLIC: Set the path that the generate .java file will be output to.
-
setOutputWriter
public void setOutputWriter(Writer outputWriter)
PUBLIC: Set the writer the output to.
-
setPackageName
public void setPackageName(String newPackageName)
PUBLIC: Set the package name of class to be generated.
-
setTableCreator
public void setTableCreator(TableCreator tableCreator)
PUBLIC: Set the table creator to generate from. All of the creator's tables will be stored into the file.
-
write
public static void write(TableCreator tableCreator, String creatorClassName, Writer writer)
PUBLIC: Generate the source code to a table creator class to the table creator's tables into the writer.
-
write
public static void write(TableCreator tableCreator, String creatorClassName, String fileName)
PUBLIC: Generate the source code to a table creator class to the table creator's tables into the file.
-
-