SupportForHibernateFramework
Page Info
Plain View
My Prefs
Log in
This page (revision-178) last changed on
21:18 02-Oct-2008
by vadiraj.
![[RSS]](http://wiki.netbeans.org/images/xml.png "Aggregate the RSS feed of the entire wiki")
This page is to keep track of the information related to the Hibernate plugin for NetBeans 6.1 and later.
Documents
Task List for NetBeans 6.1
The following tasks are derived from the functional specification above.| Pri | Task | Owner | Status | Milestone | Reference |
| P1 | Set up Hibernate module and build system in NetBeans respository | Dongmei | DONE | 6.1M2 | 123601 |
| P1 | Provide Hibernate support for NetBeans projects. One Pager | Vadiraj | DONE | 6.1M2 | 124994 |
| - Service and Implementation API | DONE | ||||
| - Project type integration | DONE | ||||
| - Hibernate Catalog registration | DONE | ||||
| - Add Hibernate to the list of supported frameworks with a panel to enter basic info | DONE | ||||
| - Automatically add Hibernate library reference to the project | DONE | ||||
| - Auto Generate session factory code | DONE | ||||
| P1 | Provide Editor Support for Hibernate config files (.cfg.xml) | Dongmei | 6.1M2 | 124995 | |
| - Design tab for editing the config files | DONE | ||||
| - Syntax coloring for tags | Generic XML editor already supports this. So, DONE | ||||
| - Static Code completion (property names, property values, such as Database dialect, true/false values, release connection mode, etc) | DONE | ||||
| - Dynamic Code completion (mapping files) | DONE | ||||
| - hyperlinking support for the mapping resources, cache-class and cache-collection classes, listener classes in the config file | DONE | ||||
| P1 | Provide Editor support for Hibernate mapping files (.hbm.xml) | Dongmei | 6.1M2 | 124995 | |
| - Design tab for editing the mapping files | Will NOT support. The DTD is very complicated. It does not make sense to have a Visual editor | ||||
| - Syntax coloring for tags | Generic XML editor already supports this. So, DONE | ||||
| - Static Code completion (ID generator strategies, Hibernate types, cascade styles) | DONE | ||||
| - Dynamic Code completion (POJOs, fields, DB Table names, column names, ) | DONE | ||||
| - hyperlinking support for the class elements in the mapping file | DONE | ||||
| P1 | New File Type Wizards for Hibernate .cfg.xml and .hbm.xml files | Gowri | 6.1M2 | 124996 | |
| - New File Type registration | DONE | ||||
| - New File Wizard for Configuration file | DONE | ||||
| - New File Wizard for Mapping file | DONE | ||||
| P1 | - Add config info to mapping file which should allow user to select config file | DONE | Post M2 | ||
| P2 | Allow mapping from the mapping file wizard | Gowri | |||
| - Allow class-table mapping | DONE | Post M2 | |||
| - Allow property-column mapping | I don't think this makes sense from the wizard panel. This can be done through ER diagram | Post 6.1 | |||
| P1 | Hibernate Session Management | Vadiraj | Single session management will be implemented as part of second feature above. Complete session management will be taken up after M2 | Post M2 | 124997 |
| P1 | HQL/SQL Editor/Translator | Vadiraj | Post M2 | 124998 | |
| P2 | Reverse Engineering | 123601 | |||
| P2 | Refactoring | Dongmei | 129585 | ||
| - refactoring the Hibernate mapping files when the referenced Java entity classe names are refactored (rename/move) | DONE | Post M2 | |||
| - find usage of Java class in the Hibernate mapping files | DONE | Post M2 | |||
| - refactoring the Hibernate mapping files when the referenced Java entity classe fields are refactored | DONE | Post M2 | |||
| - find usage of Java class fields in the Hibernate mapping files | DONE | Post M2 | |||
| - refactoring the Hibernate configuration files when the referenced mapping files are refactored | Post 6.1 | ||||
| P3 | Class/Table relationship Diagram View | 123601 | |||
| P3 | Provide DB schema management | 123601 | |||
| P3 | Provide support to use Hibernate properties file for configuration | 123601 |
Resources Needed
- Icons for Hibernate configuration files and mapping files. They should be 16x16 size.
- Hibernate icon (www.hibernate.org) to represent Hibernate root node in project logical view.
Known issues
| # | Issue Description | Status |
| 1 | Add Hibernate to the list of available frameworks for web projects | DONE |
| 2 | Create HibernateUtil class to enable Hibernate session access to the project code | DONE |
| 3 | First time invocation of code completion for table names or column names does not bring up the CC window due to the obstruction of output window and connection dialog that shows up while connecting to the db | 128546 (No update yet) |
| 4 | All code completion unit testing is done using JavaDB. In this case, JavaDB runtime was already included as part of the project classpath and the IDE could start the db server when required. | DONE, if the driver is not registered, AddDriver dialog pops up allowing the driver registration for the first time in the IDE. |
| 5 | Hibernate library registration happens when a new configuration file is created. If the existing project is opened this registration does not happen if the hibernate library is not already registered. (rare but valid case) | WILL TAKE THIS UP LATER |
| 6 | Logging is not enabled throughout the module | NOT DONE |
| 7 | New File action on the project node is broken (may be an external issue) | Not seen anymore (maybe issue with user cache) |
| 8 | Hibernate node is not made visible when creating config file for the first time | WILL NOT DO IT (Hibernate Node idea is dropped altogether) |
| 9 | Configuration and mapping files generate exceptions when they are left opened during re-starting of the IDE | (testuser dir issue (again) not visible anymore) |
| 10 | Shortcut to jump to the corresponding POJO file from mapping file. | NOT DONE |
| 11 | Request friend access to Hibernate module from Web projects module | NOT REQUIRED as of now. Will not do it. |
| 12 | Code completion of mapping file in configuration files shows the full path (So does in Design tab because same API is used now to get the mapping files | DONE |
| 13 | Investigate fast search for config and mapping files | NOT DONE |
| 14 | Investigate caching of database data (at least in case of code completion) | NOT DONE |
| 15 | New config file wizard should automatically fill up source root as the default location | DONE |
| 16 | New config file wizard should auto fill driver class when the db is selected | DONE |
| 17 | New config file wizard shows the same file name even if the file exists. (instead of wizard error, auto generating right file name might help) | DONE |
| 18 | New mapping file wizard browse button for folders should show java packages in stead of folder browser | DONE |
| 19 | New mapping file wizard does not show existing classes when Browse button to select class to map with | DONE |
| 20 | New mapping file wizard auto generation of file name appends the number after .hbm which alters the file extension | DONE |
| 21 | Code completion is slow (known issue, 128063 (as reported by Dongmei) | Done (Bug fixed) |
| 22 | Remove Logical view implementation | DONE |
| 23 | Rename the configuration files and mapping files get delayed by one step in editor tab and Navigator tab(see xmlmutiview issue 128211) | DONE (workaround added in Hibernate module) |
| 24 | Code completion (HB configuration file) for <property> values pops up only if the cursor is right after < (see xml editor issue 128275 ) | DONE. The bug has been fixed |
| 25 | HB configuration Design tab: the Add button is not disabled when there is no more properties to add | Need a method from xmlmutilview module to disable the Add button |
| 26 | Icons for the HB configuration files and mapping files are not final | waiting for a new version of the mapping icon |
| 27 | NPE during CC of column names when the mapping file is not attached to any configuration | DONE |
Task List for NetBeans 6.5
| Pri | Task | Owner | Status | Milestone | Reference_ |
| P1 | HQL/SQL Editor/Translator | Vadiraj | DONE | 124998 | |
| - UI design | DONE | 6.5M1 | |||
| - Syntax coloring for HQL | DONE | 6.5M1 | |||
| - Query execution | DONE | 6.5M1 | |||
| - On the fly SQL | DONE | 6.5M2 | 138978 | ||
| - Automatically compile POJOs | DONE | 6.5M2 | 137205 | ||
| - Hibernate Annotation Support | Gowri Vadiraj | DONE | 6.5 M2 | 136996 | |
| - Code completion (Java and database tables and columns) | Post 6.5M2 | ||||
| P1 | Reverse Engineering (Code Generation of POJOs and Mapping files) | Gowri | 133241 | ||
| - New File wizard for reverse engineering | DONE | 6.5 M1 | |||
| - Generating POJOs and Mapping files | DONE | 6.5 M1 | |||
| - Generating POJOs with Annotations | DONE | 6.5 M1 | |||
| P1 | Editor support for Hibernate Reverse Engineering xml files(.reveng.xml) | Gowri | DONE | 6.5 M2 | 136698 |
| - Syntax coloring for tags | Generic XML editor already supports this. So, DONE | 6.5M2 | |||
| - Static Code Completion (table-filter, table, Hibernate types, schema-selection etc) | DONE | 6.5M2 | |||
| - Dynamic Code Completion (packages, java classes, DB Table names etc) | DONE for packages and java classes. CC will not be supported for db tables as its difficult to get cfg.xml info from reveng.xml and without which its hard to show the tables from a db | 6.5M2 | |||
| P1 | Refactoring Hibernate Mapping files | Dongmei | 131248 | ||
| - Rename and Move the mapping files | Done | 6.5 M1 | |||
| - Find Usages | Done | 6.5 M1 | |||
| P1 | Move Hibernate module from contrib to main | Dongmei | Done(5/22) | 6.5M1 | |
| P2 | Split Web framework support and create new module | Vadiraj | DONE | 6.5M2 | 137220 |
| P2 | Add licenses for all the jars used in Hibernate | Gowri | Done | 6.5 M1 | |
| P2 | Move Hibernate to standard distribution | Gowri | Done | 6.5 M2 | |
| - Add required jars to hibernatelib zip | Gowri | DONE | 6.5 M2 | ||
| - Add logic to include ejb3-persistence.jar for J2SE projects only | Gowri | DONE | 6.5 M2 | ||
| - Change reveng wizard code to update cfg.xml with annotated pojos | Gowri | DONE | 6.5 M2 | ||
| - Change service api to work well with annotated pojos | Vadiraj | post 6.5 M2 | |||
| P3 | Pending I18N Ready | ALL | |||
| P3 | Pending Logging | ALL | |||
| P3 | Pending Unit tests for all major features | ALL | Added unit tests for CC and Hyperlinking | ||
| P3 | Pending Performance improvements (db related) | Vadiraj |
Issues must be fixed for 6.5
| Priority | Description | Owner | Status | Issue Link |
| P3 | Automatically register DB Driver during cfg creation | Vadiraj | DONE | 138142 |
| P3 | Hibernate Annotation Support | Gowri Vadiraj | DONE | 136996 |
| P3 | Add support for freeform projects | Vadiraj | DONE | 142626 |
| P3 | Classloader need to be abstracted into a separate layer | Vadiraj | DONE (copyright adjusted as per legal advice) | 141473 |
| P3 | Reverse Engg. does not generate mapping files | Vadiraj | DONE. (Resolved the bug in existing reverse engg. process. Ant target mechanism is not used.) | 140811 |
| P3 | Reading DB Tables should be updated to use the current schema | Vadiraj | Started (40%) Got sample databases from Honza. Got help from Andrei on db meta model usage. | 133124 |
| P3 | Not able to run HQL in case of mapping XMLs. | Vadiraj | Started (50%) Testing various scenarios | 148260 |
| P3 | Security exception (because of allowance of 'java' package naming on reverse engg. wizard) | Vadiraj | Under evaluation | 148705 |
| P3 | Verify Eclipse project import for Hibernate support | Vadiraj | 146022 |
Post 6.5
| P3 | Flag out-of-sync errors (hbm <-> POJO <-> cfg) | Vadiraj | |
| P3 | Spring integration | ||
| P3 | Relationship view | ||
| P3 | Design tab for editing the reveng files | Will NOT support for 6.5 as it requires more designing time to have a visual editor support. |
Resources Needed for 6.5
| Purpose | Icons size | Description |
| Hibernate Reverse Engineering files | 16x16 | This creates a hibernate.reveng.xml file and also generates hibernate mapping files and java classes based on the reveng.xml file |
| HQL editor window | 16X16 | Opens up HQL editor (the existing SQL editor window with hibernate icon embossed on it, can be the best fit) |
| Run HQL query | 16X16 | Runs HQL query thats typed in the editor. |
| HQL output window | 16X16 | Shows results/errors of the HQL query after execution. |
Attachments
| NBHibPlugin-1.6.odt |  |
22123 bytes |
| OnePagerHibernateProjectSupport.odt | |
14157 bytes |