Google Git
Sign in
apache/cayenne-modeler/5e22d24629f6fac586bb5db71c1fddf0ff791575
commit
5e22d24629f6fac586bb5db71c1fddf0ff791575
[log]
author
mrg <blacknext@gmail.com>
Sat Oct 08 06:50:44 2016 -0400
committer
mrg <blacknext@gmail.com>
Sat Oct 08 06:50:44 2016 -0400
tree
4d1641e76443048b09aef72ae1e20289250c2702
parent
4e7debc548b84d3e99f6b637fdd1c346cf52f377 [diff]
Added code to prevent empty project tree selection.
1 file changed
tree: 4d1641e76443048b09aef72ae1e20289250c2702
  1. src/
  2. .gitignore
  3. LICENSE
  4. pom.xml
  5. README.md
README.md

Cayenne Modeler Prototype

A more modern version of Cayenne Modeler

Project Goals

Why re-write Cayenne Modeler? While Cayenne Modeler is stable and works well, it is also built upon older technologies that make it harder to augment. The goal of this prototype project is to preserve everything that is good about Cayenne Modeler feature-wise, while upgrading the underlying technologies and features:

  • Use JavaFX and Scene Builder for a more modern core and easier UI development.
  • Add JavaDoc support for all generated Java classes, getters/setters, and relationships.
  • Add support for interfaces.
  • Add custom annotation support for all generated Java classes, getters/setters, and relationships.
  • Add custom imports for all generated classes (mainly to support custom annotations).
  • Add custom Velocity template editing and management.
  • Add multiple window support so multiple projects, including the same project, can be open at the same time.

Appearance

What will it look like? Well, it has the same basic layout as the current Cayenne Modeler, but with upgrades.

The following screenshots show how the prototype is shaping up. They'll be updated as work progresses.

DataDomain Editor DataDomain

DataMap Editor DataMap

ObjEntity Class Editor Object Entity Class Tab

ObjEntity Attributes Editor Object Entity Attributes Tab

Multiple Window Data Synchronization Multiple Window Data Synchronization

Development

Prerequisites

  • Java 8
  • Scene Builder (to edit FXML files)
  • Eclipse
    • e(fx)clipse (install from Eclipse Marketplace)
  • IntelliJ
    • TBD
  • Netbeans
    • TBD

Running Inside Eclipse

Right-click on the main application, src/main/java/org/apache/cayenne/modeler/CayenneModeler.java, and choose Run As => Java Application.

Running With Maven

From the top-level project, where the pom.xml file is located:

mvn exec:java -Dexec.mainClass=org.apache.cayenne.modeler.CayenneModeler

Project Layout

The project is Maven-based and has a typical Maven layout. That said, you can find some high-level things under:

  • src/main/resources/layouts contains the FXML files for the UI (edit with Scene Builder).
  • src/main/java/org/apache/cayenne/modeler/layout contains the Java controllers for the FXML layouts (names should match up).
  • src/main/resources/cayenne-analytic.xml contains the sample model currently being used for testing purposes.
  • More to come as the prototype solidifies...

To-Do

There are so many things needing to be done. See the issues for some of them.

Thanks

The FontAwesomeFX library is used to provide icons from FontAwesome.

License

Apache Software Foundation