Module org.eclipse.persistence.core

Package org.eclipse.persistence.sessions.factories

Class ProjectClassGenerator

java.lang.Object

org.eclipse.persistence.sessions.factories.ProjectClassGenerator

public class ProjectClassGenerator
extends Object

Purpose: Allow for a class storing a TopLink project's descriptors (meta-data) to be generated. This class can then be used at runtime to deploy the TopLink descriptor's instead of XML files.

Since:

TopLink 3.0

Author:

James Sutherland

Field Summary

Fields

Modifier and Type	Field	Description
protected String	className
protected Hashtable<ClassDescriptor,String>	descriptorMethodNames
protected String	outputFileName
protected String	outputPath
protected Writer	outputWriter
protected String	packageName
protected Project	project

Constructor Summary

Constructors

Constructor	Description
ProjectClassGenerator()	PUBLIC: Create a new generator.
ProjectClassGenerator(Project project)	PUBLIC: Create a new generator to output the project.
ProjectClassGenerator(Project project, String projectClassName, Writer outputWriter)	PUBLIC: Create a new generator to output to the writer.
ProjectClassGenerator(Project project, String projectClassName, String fileName)	PUBLIC: Create a new generator to output to the file.

Method Summary

Modifier and Type	Method	Description
protected void	addAggregateCollectionMappingLines(NonreflectiveMethodDefinition method, String mappingName, AggregateCollectionMapping mapping)
protected void	addAggregateObjectMappingLines(NonreflectiveMethodDefinition method, String mappingName, AggregateObjectMapping mapping)
protected void	addCacheInvalidationPolicyLines(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addCMPPolicyLines(NonreflectiveMethodDefinition method, CMPPolicy sourceCMPPolicy)
protected void	addConverterLines(NonreflectiveMethodDefinition method, String converterName, Converter converter)
protected void	addDescriptorPropertyLines(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addDirectCollectionMappingLines(NonreflectiveMethodDefinition method, String mappingName, DirectCollectionMapping mapping)
protected void	addDirectMapMappingLines(NonreflectiveMethodDefinition method, String mappingName, DirectMapMapping mapping)
protected void	addEventManagerPropertyLines(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addFetchGroupLines(NonreflectiveMethodDefinition method, FetchGroup fetchGroup, String fetchGroupIdentifier)
protected void	addFetchGroupManagerLine(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addForeignReferenceMappingLines(NonreflectiveMethodDefinition method, String mappingName, ForeignReferenceMapping mapping)
protected void	addHistoryPolicyLines(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addHistoryPolicyLines(NonreflectiveMethodDefinition method, HistoryPolicy policy, String policyName)
protected void	addHistoryPolicyLines(NonreflectiveMethodDefinition method, DirectCollectionMapping mapping, String mappingName)
protected void	addHistoryPolicyLines(NonreflectiveMethodDefinition method, ManyToManyMapping mapping, String mappingName)
protected void	addInheritanceLines(NonreflectiveMethodDefinition method, InheritancePolicy policy)
protected void	addInterfaceLines(NonreflectiveMethodDefinition method, InterfacePolicy policy)
protected void	addManyToManyMappingLines(NonreflectiveMethodDefinition method, String mappingName, ManyToManyMapping mapping)
protected void	addMappingLines(NonreflectiveMethodDefinition method, DatabaseMapping mapping)
protected void	addNamedQueryLines(NonreflectiveMethodDefinition method, DatabaseQuery query, DescriptorQueryManager queryManager, int iteration)
protected void	addObjectTypeConverterLines(NonreflectiveMethodDefinition method, String converterName, ObjectTypeConverter converter)
protected void	addOneToManyMappingLines(NonreflectiveMethodDefinition method, String mappingName, OneToManyMapping mapping)
protected void	addOneToOneMappingLines(NonreflectiveMethodDefinition method, String mappingName, OneToOneMapping mapping)
protected void	addOptimisticLockingLines(NonreflectiveMethodDefinition method, OptimisticLockingPolicy policy)
protected void	addQueryKeyLines(NonreflectiveMethodDefinition method, QueryKey queryKey)
protected void	addQueryManagerPropertyLines(NonreflectiveMethodDefinition method, ClassDescriptor descriptor)
protected void	addReturningPolicyLines(NonreflectiveMethodDefinition method, ReturningPolicy policy)
protected void	addReturningPolicyLines(NonreflectiveMethodDefinition method, ReturningPolicy policy, String policyName)
protected void	addTransformationMappingLines(NonreflectiveMethodDefinition method, String mappingName, TransformationMapping mapping)
protected void	addTypeConversionConverterLines(NonreflectiveMethodDefinition method, String converterName, TypeConversionConverter converter)
protected void	addVariableOneToOneMappingLines(NonreflectiveMethodDefinition method, String mappingName, VariableOneToOneMapping mapping)
protected void	addXMLInteractionLines(NonreflectiveMethodDefinition method, XMLInteraction interaction, String variableName)
protected String	buildBuilderString(String builderString, NonreflectiveMethodDefinition method, int iteration, String queryIdentifier)
protected NonreflectiveMethodDefinition	buildConstructor()
protected NonreflectiveMethodDefinition	buildDescriptorMethod(ClassDescriptor descriptor)
protected void	buildExpressionString(String builderString, NonreflectiveMethodDefinition method, String queryIdentifier, Expression exp, String attrString)
protected NonreflectiveMethodDefinition	buildLoginMethod(Login datasourceLogin)
protected void	computeDescriptorMethodNames()	This figures out the best name for each descriptor, first using the local class name then the qualified one for duplicates.
void	generate()	PUBLIC: Generate the project class, output the java source code to the stream or file.
void	generate(boolean useUnicode)	PUBLIC: Generate the project class, output the java source code to the stream or file.
protected ClassDefinition	generateProjectClass()	Return a class definition object representing the code to be generated for the project and its descriptors.
String	getClassName()	PUBLIC: Return the name of class to be generated.
protected Hashtable<ClassDescriptor,String>	getDescriptorMethodNames()
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.
Project	getProject()	PUBLIC: Return the project 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.
protected String	setDefaultOrAddSequenceString(Sequence sequence, boolean isSetDefault)
protected void	setDescriptorMethodNames(Hashtable<ClassDescriptor,String> descriptorMethodNames)
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	setProject(Project newProject)	PUBLIC: Set the project to generate from.
protected Vector<DatabaseMapping>	sortMappings(Vector<DatabaseMapping> mappings)	Short the mappings by type.
static void	write(Project project, String projectClassName, Writer writer)	PUBLIC: Generate the source code to a project class to the project's descriptor into the writer.
static void	write(Project project, String projectClassName, String fileName)	PUBLIC: Generate the source code to a project class to the project's descriptor into the file.

Methods inherited from class java.lang.Object

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

Field Detail

className

protected String className

packageName

protected String packageName

outputPath

protected String outputPath

outputFileName

protected String outputFileName

outputWriter

protected Writer outputWriter

project

protected Project project

descriptorMethodNames

protected Hashtable<ClassDescriptor,String> descriptorMethodNames

Constructor Detail

ProjectClassGenerator

public ProjectClassGenerator()

PUBLIC: Create a new generator.

ProjectClassGenerator

public ProjectClassGenerator(Project project)

PUBLIC: Create a new generator to output the project.

ProjectClassGenerator

public ProjectClassGenerator(Project project,
                             String projectClassName,
                             Writer outputWriter)

PUBLIC: Create a new generator to output to the writer.

ProjectClassGenerator

public ProjectClassGenerator(Project project,
                             String projectClassName,
                             String fileName)

PUBLIC: Create a new generator to output to the file.

Method Detail

addAggregateCollectionMappingLines

protected void addAggregateCollectionMappingLines(NonreflectiveMethodDefinition method,
                                                  String mappingName,
                                                  AggregateCollectionMapping mapping)

addAggregateObjectMappingLines

protected void addAggregateObjectMappingLines(NonreflectiveMethodDefinition method,
                                              String mappingName,
                                              AggregateObjectMapping mapping)

addCacheInvalidationPolicyLines

protected void addCacheInvalidationPolicyLines(NonreflectiveMethodDefinition method,
                                               ClassDescriptor descriptor)

addCMPPolicyLines

protected void addCMPPolicyLines(NonreflectiveMethodDefinition method,
                                 CMPPolicy sourceCMPPolicy)

addDescriptorPropertyLines

protected void addDescriptorPropertyLines(NonreflectiveMethodDefinition method,
                                          ClassDescriptor descriptor)

addDirectCollectionMappingLines

protected void addDirectCollectionMappingLines(NonreflectiveMethodDefinition method,
                                               String mappingName,
                                               DirectCollectionMapping mapping)

addDirectMapMappingLines

protected void addDirectMapMappingLines(NonreflectiveMethodDefinition method,
                                        String mappingName,
                                        DirectMapMapping mapping)

addFetchGroupManagerLine

protected void addFetchGroupManagerLine(NonreflectiveMethodDefinition method,
                                        ClassDescriptor descriptor)

addFetchGroupLines

protected void addFetchGroupLines(NonreflectiveMethodDefinition method,
                                  FetchGroup fetchGroup,
                                  String fetchGroupIdentifier)

addEventManagerPropertyLines

protected void addEventManagerPropertyLines(NonreflectiveMethodDefinition method,
                                            ClassDescriptor descriptor)

addForeignReferenceMappingLines

protected void addForeignReferenceMappingLines(NonreflectiveMethodDefinition method,
                                               String mappingName,
                                               ForeignReferenceMapping mapping)

addHistoryPolicyLines

protected void addHistoryPolicyLines(NonreflectiveMethodDefinition method,
                                     ClassDescriptor descriptor)

addHistoryPolicyLines

protected void addHistoryPolicyLines(NonreflectiveMethodDefinition method,
                                     DirectCollectionMapping mapping,
                                     String mappingName)

addHistoryPolicyLines

protected void addHistoryPolicyLines(NonreflectiveMethodDefinition method,
                                     ManyToManyMapping mapping,
                                     String mappingName)

addHistoryPolicyLines

protected void addHistoryPolicyLines(NonreflectiveMethodDefinition method,
                                     HistoryPolicy policy,
                                     String policyName)

addInheritanceLines

protected void addInheritanceLines(NonreflectiveMethodDefinition method,
                                   InheritancePolicy policy)

addInterfaceLines

protected void addInterfaceLines(NonreflectiveMethodDefinition method,
                                 InterfacePolicy policy)

addManyToManyMappingLines

protected void addManyToManyMappingLines(NonreflectiveMethodDefinition method,
                                         String mappingName,
                                         ManyToManyMapping mapping)

addMappingLines

protected void addMappingLines(NonreflectiveMethodDefinition method,
                               DatabaseMapping mapping)

addObjectTypeConverterLines

protected void addObjectTypeConverterLines(NonreflectiveMethodDefinition method,
                                           String converterName,
                                           ObjectTypeConverter converter)

addOneToManyMappingLines

protected void addOneToManyMappingLines(NonreflectiveMethodDefinition method,
                                        String mappingName,
                                        OneToManyMapping mapping)

addOneToOneMappingLines

protected void addOneToOneMappingLines(NonreflectiveMethodDefinition method,
                                       String mappingName,
                                       OneToOneMapping mapping)

addOptimisticLockingLines

protected void addOptimisticLockingLines(NonreflectiveMethodDefinition method,
                                         OptimisticLockingPolicy policy)

addQueryKeyLines

protected void addQueryKeyLines(NonreflectiveMethodDefinition method,
                                QueryKey queryKey)

addQueryManagerPropertyLines

protected void addQueryManagerPropertyLines(NonreflectiveMethodDefinition method,
                                            ClassDescriptor descriptor)

addXMLInteractionLines

protected void addXMLInteractionLines(NonreflectiveMethodDefinition method,
                                      XMLInteraction interaction,
                                      String variableName)

addNamedQueryLines

protected void addNamedQueryLines(NonreflectiveMethodDefinition method,
                                  DatabaseQuery query,
                                  DescriptorQueryManager queryManager,
                                  int iteration)

buildBuilderString

protected String buildBuilderString(String builderString,
                                    NonreflectiveMethodDefinition method,
                                    int iteration,
                                    String queryIdentifier)

buildExpressionString

protected void buildExpressionString(String builderString,
                                     NonreflectiveMethodDefinition method,
                                     String queryIdentifier,
                                     Expression exp,
                                     String attrString)

addReturningPolicyLines

protected void addReturningPolicyLines(NonreflectiveMethodDefinition method,
                                       ReturningPolicy policy)

addReturningPolicyLines

protected void addReturningPolicyLines(NonreflectiveMethodDefinition method,
                                       ReturningPolicy policy,
                                       String policyName)

addTransformationMappingLines

protected void addTransformationMappingLines(NonreflectiveMethodDefinition method,
                                             String mappingName,
                                             TransformationMapping mapping)

addConverterLines

protected void addConverterLines(NonreflectiveMethodDefinition method,
                                 String converterName,
                                 Converter converter)

addTypeConversionConverterLines

protected void addTypeConversionConverterLines(NonreflectiveMethodDefinition method,
                                               String converterName,
                                               TypeConversionConverter converter)

addVariableOneToOneMappingLines

protected void addVariableOneToOneMappingLines(NonreflectiveMethodDefinition method,
                                               String mappingName,
                                               VariableOneToOneMapping mapping)

buildConstructor

protected NonreflectiveMethodDefinition buildConstructor()

buildDescriptorMethod

protected NonreflectiveMethodDefinition buildDescriptorMethod(ClassDescriptor descriptor)

buildLoginMethod

protected NonreflectiveMethodDefinition buildLoginMethod(Login datasourceLogin)

setDefaultOrAddSequenceString

protected String setDefaultOrAddSequenceString(Sequence sequence,
                                               boolean isSetDefault)

computeDescriptorMethodNames

protected void computeDescriptorMethodNames()

This figures out the best name for each descriptor, first using the local class name then the qualified one for duplicates.

generate

public void generate(boolean useUnicode)
              throws ValidationException

PUBLIC: Generate the project 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

generateProjectClass

protected ClassDefinition generateProjectClass()

Return a class definition object representing the code to be generated for the project and its descriptors. 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.

getDescriptorMethodNames

protected Hashtable<ClassDescriptor,String> getDescriptorMethodNames()

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.

getProject

public Project getProject()

PUBLIC: Return the project 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 constructor arguments.

removeDots

protected String removeDots(String packageName)

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.

setDescriptorMethodNames

protected void setDescriptorMethodNames(Hashtable<ClassDescriptor,String> descriptorMethodNames)

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.

setProject

public void setProject(Project newProject)

PUBLIC: Set the project to generate from. All of the projects descriptors will be stored into the file.

sortMappings

protected Vector<DatabaseMapping> sortMappings(Vector<DatabaseMapping> mappings)

Short the mappings by type.

write

public static void write(Project project,
                         String projectClassName,
                         Writer writer)

PUBLIC: Generate the source code to a project class to the project's descriptor into the writer.

write

public static void write(Project project,
                         String projectClassName,
                         String fileName)

PUBLIC: Generate the source code to a project class to the project's descriptor into the file.