IDS catalog interface

[Jay Rainey]

The methods getDownloadURL and getUploadURL in ICatalog need to be re-factored into their own interface as it's not possible to call them within a compositeCatalog (#9026). They are part of the Information Data Service (IDS), which is a separate API from ICAT. (Though, it uses investigationIds etc that are obtained via ICAT)

To resolve this issue I need to:

1. Create a new interface (CatalogInfoService) that contains the two method signatures.
2. Inherit this interface in ICat4Catalog. (I should not have to change much within this class)
3. Remove the related methods from ICat3Catalog as it does not have an IDS.
4. Remove keepAliveinminutes method from ICatalog as it's not used, and will not function as expected in the compositeCatalog. The keepAlive method is more than sufficient.

Note: the catalog algorithms that use these methods should not be affected as they call the catalog in use. Better exception handling should be put in place to ensure if a catalog is used that does not support an IDS then the user will know. The algorithms are:

• CatalogDownloadDataFiles(uses getDownloadURL)
• CatalogDownloadDataSets (uses getDownloadURL)
• CatalogPublish (uses getUploadURL)

[Owen Arnold]

This sounds fine, but a quick 5-min sketch (class diagram) done in any application showing what the class hierarchy will look like before and after would be very useful. Export and attach to this ticket.

[Jay Rainey]

(In #7640) This ticket will act as an umbrella ticket for all functionality that will enable cross facility querying of ICAT within Mantid.

[Jay Rainey]

The catalog structure before changes

[Jay Rainey]

​ICatBefore

The current structure of the catalog functionality within Mantid does not allow for multiple catalogs to be created.This was to be addressed in #9026, which I am unable to do as several methods in ICatalog do not belong there. E.g. the IDS upload & download functionality.

​ICatAfter

This diagram illustrates the changes that I plan to make both in this ticket, and #9026, which involves:

1. Creating a new interface (ICatalogInfoService) that holds the IDS functionality.
2. Creating a CompositeCatalog (#9026) to allow the catalog functionality to be called on each instance of a catalog.
3. The session class will be removed, and related functionality added to each catalog.

[Jay Rainey]

Added new CatalogInfoService interface. Refs #9069.

Changeset: 9a1aaf15893b22d8e38895cd1bc3f24051dcdfa7

[Jay Rainey]

Updated layout of ICatalog. Refs #9069.

Changeset: 78fe1ea7eeaaf97aa9509961e511d6e92ba74793

[Jay Rainey]

Using ICatalogInfoService interface in ICAT4. Refs #9069.

• Removed IDS methods from ICatalog interface.
• Added typedef to easily use CatalogInfoService in algorithms.

Changeset: 2cf4b5e38a84775e28813df15d732ec44acf7e31

[Jay Rainey]

Algorithms to use ICatalogInfoService interface methods. Refs #9069.

Changeset: e6b95ccd29abbe243e8455f715e9b88b64040ca9

[Jay Rainey]

ICat3Catalog now uses CatalogInfoService. Refs #9069.

Changeset: dd73e653675df1f5963c82ecda2b21c2e8e4b34f

[Jay Rainey]

Merge branch 'feature/9069_refactor_catalog_interface' into develop.Refs #9069.

Conflicts:

• Code/Mantid/Framework/API/inc/MantidAPI/ICatalog.h
• Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Catalog.h

Changeset: 23ac661b83ce2c043722604f49377a8866091b6f

[Jay Rainey]

Overview

This ticket addresses the issues found when creating a composite catalog in #9026. That is, several methods did not belong in the ICatalog interface, and should instead be separated out into their own interface (they both use the IDS).

To test

External downloading

In order to test the external downloading functionality you must not have access to the archives. I have written instructions to disable access to the archives on Ubuntu ​here.

1. Log into the catalog and perform a search.
2. Double click on an investigation in the Search Results table. The Datafile information table will be populated.
3. Select a datafile, and click Download to..., and save the datafile on your desktop.
4. Verify the file was downloaded correctly.

Publishing

You will need to verify the publishing functionality works. To do this:

1. Log into the catalog.
2. Select Publish from the catalog menu.
3. Select a datafile to upload.
4. Enter a name to save the file as in the Name in catalog: field. Copy this name to your clipboard.
5. Select an investigation (The id is: 1193002) and click Run.

To verify the datafile was uploaded correctly:

1. Open the catalog interface and click Advanced search.
2. Paste the name of the file you uploaded into the Datafile name field.
3. Click Search. The investigation containing the datafile was now be displayed in the Search results table. Double click on it, and verify the datafile is there.
4. Download the datafile and compare it with the one you uploaded.

[Martyn Gigg]

All of the steps above still work after the refactoring and the code changes look good.

[Martyn Gigg]

Merge remote-tracking branch 'origin/feature/9069_refactor_catalog_interface'

Full changeset: ​9da084670a7b56b44f252ddd857f8f848566cc57

[Martyn Gigg]

Put back initializer character for MPI build

Refs #9069

Changeset: 019c2930128cfeb5529ca1a5b6021b72172996e8

[Stuart Campbell]

This ticket has been transferred to github issue ​9912