diff --git a/scripts/mmg.readme.txt b/scripts/mmg.readme.txt new file mode 100644 index 000000000..195fb42bb --- /dev/null +++ b/scripts/mmg.readme.txt @@ -0,0 +1,35 @@ +Metamodel generator (mmg) + +JPA 2.0 provides an utility to generate canonical metamodel for each persistent domain entity. +This brief note describes how to generate these canonical metamodel classes. + +The canonical metamodel classes are generated during compilation of persistent domain entity classes. +The generation process depends on Annotation Processing facility available in JDK6. Naturally, this +process *only* works if the persistent domain entity classes are compiled with a JDK6 compiler. + +Effectively, the process appears to be normal compilation process with a specialized Annotation Processor + + $ javac -classpath %CLASSPATH% <*.java source files> + + +Compiler Classpath +------------------ + The compiler classpath must include OpenJPA libraries. + +mmg options +----------- + These options specify the Annotation processor to be used as well as options for the processor. The only mandatory + option is + -processor org.apache.openjpa.persistence.meta.AnnotationProcessor6 + +The other options qualify the Annotation processor itself and specified with -A