Custom Templates
| Cayenne Version | 3.0.2 |
| Project Directory | Templates (contains Velocity templates) |
| Source Directories | Templates/src/main/java |
| Resource Directory | Templates/src/main/resources | Inputs | N/A |
| Compiling/Running |
cd Templates mvn cayenne:cgen |
| View/Edit Model | mvn cayenne-modeler:run | Status |
Code: Completed Documentation: In-Progress |
Cayenne includes default Velocity-based templates used to generate your Cayenne classes from the model. These default templates are sufficient for most uses, but you can create custom templates if desired.
This GitHub directory contains example custom templates, superclass.vm and subclass.vm, for Cayenne superclasses and subclasses. These are based upon the original templates, but have the following changes:
- A stronger warning about making changes that will get overwritten (superclass).
- Added a
serialVersionUIDto eliminate warnings (superclass and subclass). - Added comments for different sections (superclass and subclass).
- Added
RELATIONSHIP_in the relationship property constants (superclass). - Changed setters/getters to use the property constants instead of duplicating the strings (superclass).
To use these (or other) custom templates, put a copy in your project and add them to your Cayenne Modeler preferences under the Templates section as "subclass" and "superclass". (If you use different names, substitute the different names below.)
When generating classes, use the Advanced option with the following suggested settings:
Generation Mode: Entity and Embeddable generation
Generator Version: 1.2
Subclass Template: subclass (or your different template name)
Superclass Template: superclass (or your different template name)
Output Pattern: *.java
Make Pairs: checked
Overwrite Subclasses: unchecked
Use Package Path: checked