plugout-jpa.README 1.68 KB
Newer Older
jeanneteau committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
== PLUGOUT-JPA
Copyright (C) 2010 - David Jeanneteau
Distributed under GPL v3

contact: plugout.jpa@gmail.com


== INSTALL 
 -- debian/ubuntu (and other UNIX based systems)
 run script: sudo install_debian.sh
this script may also run on linux systems where bouml is installed in /usr/lib/bouml directory.

 -- windows
 run script install-win32.bat
 
	windows launcher is a .exe file, because the .bat launcher did not work
	.exe was build using Code::blocks ( http://www.codeblocks.org/ )

 -- other (ask me for assistance)
copy files and directories from 'release' to bouml install directory
update the plugout launcher file 



== TEST (kind of tutorial)
 - launch bouml
 - open project 'jpa-project-test'
 - in class view 'test', add a relation between the 2 classes
 - edit the relation,select 'jpa:manyToOne', or 'jpa:oneToMany' stereotype, presse 'OK' button
 - plugout is launched
 - re-openrelation dialog, check that multiplicity, role names (if previously null) and JPA annotations are efficiently updated
 - in browser, check that addXXX and removeXXX methods are created (check method bodies) 

== Start NEW PROJECT
 - launch bouml
 - load project 'jpa-template'
 - save as your own project ...
 - create class view, add your classes, add relations with jpa stereotypes
 - generate java source (check bouml doc)
 - use generated java sources in your project !

== TODO
 - manage oneToOne relations
 - manage manyToMany relations 
 - add a 'clean' action to remove all generated parts (usefull when relation stereotype change ...)
 - add comment tag for role names (include role names in 'clean' action)
 - add a 'clean-force' to remove parts to be generated (ex: user defined addXXX and removeXXX methods)