Hardware items should be annotatable

[olle]

Ticket accepted.

[olle]

Traceability note:

• Ticket #1310 (Annotations for protocols) covers making Protocol items annotatable.

[olle]

Design discussion:

• The design for this update will be based on that for Ticket #1310 (Annotations for protocols). Code changes related to making Hardware items annotatable and changing schema version can be made analogously to the latter ticket, while later changes in the GUI design only make parts of the corresponding code changes for Ticket #1310 relevant to the current case.
• Support for annotatable Hardware items will include the following parts:
  a. Basic support for adding annotations to Hardware items.
  b. Update of database schema version, since step (a.) adds new database columns.
  c. Adding an "Annotations" tab to the page for inspecting a Hardware item, and displaying the annotations.
  d. Adding an "Annotations" tab to the edit dialog for a Hardware item, and making it possible to edit annotations.
  e. For an item that can have an attached Hardware item, making annotations to the latter appear in the tree node for the overview of that item.
  f. For an item that can have an attached Hardware item, making annotations to the latter appear in the "Inherited annotations" tab of the edit dialog for that item.
  

[olle]

Design implementation:

The different parts in adding support for annotatable Hardware items will involve updates to the following files:

1. Basic support for adding annotations to Hardware items:
   
   Hardware.java in base3/src/core/net/sf/basedb/core/ and
   HardwareData.java in base3/src/core/net/sf/basedb/core/data/.
   
   
2. Update of database schema version:
   
   Install.java in base3/src/core/net/sf/basedb/core/ and
   Update.java in base3/src/core/net/sf/basedb/core/.
   
   
3. Adding an "Annotations" tab to the page for inspecting a Hardware item, and displaying the annotations:
   
   JavaScript hardware.js in base3/www/admin/hardware/
   JSP script list_hardware.jsp in base3/www/admin/hardware/
   JSP script view_hardware.jsp in base3/www/admin/hardware/
   
   
4. Adding an "Annotations" tab to the edit dialog for a Hardware item, and making it possible to edit annotations:
   
   JSP script edit_hardware.jsp in base3/www/admin/hardware/
   JavaScript hardware.js in base3/www/admin/hardware/
   JSP script index.jsp in base3/www/admin/hardware/
   JavaScript main.js in base3/www/include/scripts/ (for making edit dialog larger).
   
   
5. For an item that can have an attached Hardware item, making annotations to the latter appear in the tree node for the overview of that item:
   
   HardwareLoader.java in base3/src/core/net/sf/basedb/util/overview/loader/
DerivedBioAssay.java in base3/src/core/net/sf/basedb/core/
   JavaScript bioassays.js in base3/www/views/derivedbioassays/
PhysicalBioAssay.java in base3/src/core/net/sf/basedb/core/
   JavaScript bioassays.js in base3/www/views/physicalbioassays/
   
   
6. For an item that can have an attached Hardware item, making annotations to the latter appear in the "Inherited annotations" tab of the edit dialog for that item:
   
   DerivedBioAssay.java in base3/src/core/net/sf/basedb/core/
   JavaScript bioassays.js in base3/www/views/derivedbioassays/
PhysicalBioAssay.java in base3/src/core/net/sf/basedb/core/
   JavaScript bioassays.js in base3/www/views/physicalbioassays/
   

[olle]

(In [6328]) Refs #1771. Support for annotatable Hardware items added.

[olle]

(In [6331]) Refs #1771. Class\file Hardware.java in base3/src/core/net/sf/basedb/core/ updated in JavaDoc comment for public method Set<Annotatable> getAnnotatableParents() to refer to correct BASE version.

[olle]

(In [6332]) Refs #1771. Support for annotatable Hardware items updated:

1. JSP script edit_hardware.jsp in base3/www/admin/hardware/ updated by removing annotations.js from the list of scripts, since this script will still be invoked from JSP script annotate_frameset.jsp in www/common/annotations.

[olle]

(In [6333]) Refs #1771. Class\file Hardware.java in base3/src/core/net/sf/basedb/core/ updated in JavaDoc comment for public method Set<Annotatable> getAnnotatableParents() to refer to BASE version 3.3.

[olle]

Ticket closed as the requested functionality has been added.

[olle]

(In [6360]) Refs #1771. Page for inspecting a Hardware item updated by adding a "Change history" tab, and displaying the changes:

1. JavaScript hardware.js in base3/www/admin/hardware/ updated in function initPage() for pageId equal to view-page to add a tab active listener for history data.
2. JSP script view_hardware.jsp in base3/www/admin/hardware/ updated in HTML section to add a "Change history" tab.