Ticket #8900 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Refactor catalog algorithms

Reported by: Jay Rainey Owned by: Jay Rainey
Priority: major Milestone: Release 3.2
Component: Framework Keywords: ICAT,ICAT4,maintenance
Cc: Blocked By:
Blocking: Tester: Samuel Jackson

Description (last modified by Jay Rainey) (diff)

There are several catalog algorithms that could be improved, for example:

  1. CatalogListInstruments and CatalogListInvestigationType have a property named IsValid, which is not used.
  2. CatalogPublish and CatalogGetDownloadDatafiles both perform an HTTP request, which could be refactored out into a helper method.

I think a better option would be to go through each catalog algorithm and improve those where possible, e.g. removal of un-used properties and methods, better property names, etc.

This includes updating the doxygen information of the algorithms (several of which are out dated).

Change History

comment:1 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:2 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:3 Changed 7 years ago by Jay Rainey

  • Status changed from new to inprogress

Removed namespaces and un-used property. Refs #8900.

Changeset: f4acbf0b6d5b80dc54ce12f2b890b9950bf4a9ef

comment:4 Changed 7 years ago by Jay Rainey

Use namespaces directly as there are few. Refs #8900.

Changeset: c4d50b1ef692818d95b447accb775f4218484c9c

comment:5 Changed 7 years ago by Jay Rainey

Remove unused isValid property. Refs #8900.

  • Updated the wiki of each algorithm to better describe its purpose.

Changeset: f75bbf1f716863ad9af5a0c5ea96f3b033dea28a

comment:6 Changed 7 years ago by Jay Rainey

Removed unnecessary try/catches from catalog. Refs #8900.

Changeset: e4ceb01f5fdd4f8efe54d0cb813d637903bf428e

comment:7 Changed 7 years ago by Jay Rainey

Updated wiki of catalog algorithms. Refs #8900.

Changeset: 5a7f802e741c9863b6a710c60c2a11e7738ecca2

comment:8 Changed 7 years ago by Jay Rainey

  • Status changed from inprogress to verify
  • Resolution set to fixed

Update include guards to match class names. Refs #8900.

Changeset: f5596597a525549ba42d1c480ec270d4fca1dd73

Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:9 Changed 7 years ago by Jay Rainey

To test

  1. Perform a ​code review to verify the changes made are sensible.
  2. Verify that the catalog functionality works as before, e.g. searching/loading/downloading/publishing.
Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:10 Changed 7 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester set to Samuel Jackson

comment:11 Changed 7 years ago by Samuel Jackson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/8900_improve_icat_algorithms'

Full changeset: ​9665c9eed26d7ea297c4f76f4d7bcbbfff0db665

comment:12 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9743

Note: See TracTickets for help on using tickets.