[WIP] Moving new Hanging-Protocol bootstrap from Nucleus to OHIF Viewers

Packages/ohif-viewerbase/client/lib/classes/metadata/InstanceMetadata.js

@@ -1,5 +1,6 @@
 import { Metadata } from './Metadata';
 import { dicomTagDescriptions } from '../../dicomTagDescriptions';
+import { OHIFError } from '../OHIFError';
 
 const UNDEFINED = 'undefined';
 const NUMBER = 'number';
@@ -11,8 +12,43 @@ export class InstanceMetadata extends Metadata {
     constructor(data) {
         super(data);
         this._sopInstanceUID = null;
+        this._imageId = null;
+        // Initialize Public Properties
+        this._definePublicProperties();
     }
 
+    /**
+     * Private Methods
+     */
+
+    /**
+     * Define Public Properties
+     * This method should only be called during initialization (inside the class constructor)
+     */
+    _definePublicProperties() {
+
+        /**
+         * Property: this.sopInstanceUID
+         * Same as this.getSOPInstanceUID()
+         * It's specially useful in contexts where a method call is not suitable like in search criteria. For example:
+         * sopInstanceCollection.findBy({
+         *   sopInstanceUID: '1.2.3.4.5.6.77777.8888888.99999999999.0'
+         * });
+         */
+        Object.defineProperty(this, 'sopInstanceUID', {
+            configurable: false,
+            enumerable: false,
+            get: function() {
+                return this.getSOPInstanceUID();
+            }
+        });
+
+    }
+
+    /**
+     * Public Methods
+     */
+
     /**
      * Returns the SOPInstanceUID of the current instance.
      */
@@ -70,6 +106,7 @@ export class InstanceMetadata extends Metadata {
         /**
          * Please override this method on a specialized class.
          */
+        throw new OHIFError('InstanceMetadata::getRawValue is not overriden. Please, override it in a specialized class. See OHIFInstanceMetadata for example');
     }
 
     /**
@@ -97,22 +134,18 @@ export class InstanceMetadata extends Metadata {
         /**
          * Please override this method
          */
+        throw new OHIFError('InstanceMetadata::tagExists is not overriden. Please, override it in a specialized class. See OHIFInstanceMetadata for example');
     }
 
     /**
-    * Returns a URI for the specified resource related to this instance (if an instance).
-    * @param {string} resource The name of the resource. This name cannot have any leading or
-    * trailing slashes
-    * @param {string|number} [optParameter] An optional parameter. This cannot have any leading or
-    * trailing slashes
-    * @returns {string|undefined} The constructed URI for the specified resource related to this
-    * instance or undefined if this sequence is a sub-sequence (i.e.: it has no related resources of
-    * its own).
-    */
-    getResourceUri(resource, optParameter) {
+     * Get custom image id of a sop instance
+     * @return {Any}          sop instance image id
+     */
+    getImageId() {
         /**
          * Please override this method
          */
+        throw new OHIFError('InstanceMetadata::getImageId is not overriden. Please, override it in a specialized class. See OHIFInstanceMetadata for example');
     }
 
     /**

Packages/ohif-viewerbase/client/lib/classes/metadata/SeriesMetadata.js

@@ -7,8 +7,42 @@ export class SeriesMetadata extends Metadata {
         super(data);
         this._seriesInstanceUID = null;
         this._instances = []; // InstanceMetadata[]
+        // Initialize Public Properties
+        this._definePublicProperties();
     }
 
+    /**
+     * Private Methods
+     */
+
+    /**
+     * Define Public Properties
+     * This method should only be called during initialization (inside the class constructor)
+     */
+    _definePublicProperties() {
+
+        /**
+         * Property: this.seriesInstanceUID
+         * Same as this.getSeriesInstanceUID()
+         * It's specially useful in contexts where a method call is not suitable like in search criteria. For example:
+         * seriesCollection.findBy({
+         *   seriesInstanceUID: '1.2.3.4.5.6.77777.8888888.99999999999.0'
+         * });
+         */
+        Object.defineProperty(this, 'seriesInstanceUID', {
+            configurable: false,
+            enumerable: false,
+            get: function() {
+                return this.getSeriesInstanceUID();
+            }
+        });
+
+    }
+
+    /**
+     * Public Methods
+     */
+
     /**
      * Returns the SeriesInstanceUID of the current series.
      */

Packages/ohif-viewerbase/client/lib/classes/metadata/StudyMetadata.js

@@ -1,12 +1,92 @@
 import { Metadata } from './Metadata';
 import { SeriesMetadata } from './SeriesMetadata';
+import { ImageSet } from '../ImageSet';
 
 export class StudyMetadata extends Metadata {
+
     constructor(data) {
         super(data);
         this._studyInstanceUID = null;
         this._series = [];  // SeriesMetadata[]
+        this._displaySets = [];
+        // Initialize Public Properties
+        this._definePublicProperties();
+    }
 
+    /**
+     * Private Methods
+     */
+
+    /**
+     * Define Public Properties
+     * This method should only be called during initialization (inside the class constructor)
+     */
+    _definePublicProperties() {
+
+        /**
+         * Property: this.studyInstanceUID
+         * Same as this.getStudyInstanceUID()
+         * It's specially useful in contexts where a method call is not suitable like in search criteria. For example:
+         * studyCollection.findBy({
+         *   studyInstanceUID: '1.2.3.4.5.6.77777.8888888.99999999999.0'
+         * });
+         */
+        Object.defineProperty(this, 'studyInstanceUID', {
+            configurable: false,
+            enumerable: false,
+            get: function() {
+                return this.getStudyInstanceUID();
+            }
+        });
+
+    }
+
+    /**
+     * Public Methods
+     */
+
+    /**
+     * Getter for displaySets
+     * @return {Array} Array of display set object
+     */
+    getDisplaySets() {
+        return this._displaySets.slice();
+    }
+
+    /**
+     * Set display sets
+     * @param {Array} displaySets Array of display sets (ImageSet[])
+     */
+    setDisplaySets(displaySets) {
+        displaySets.forEach(displaySet => this.addDisplaySet(displaySet));
+    }
+
+    /**
+     * Add a single display set to the list
+     * @param {Object} displaySet Display set object
+     * @returns {boolean} True on success, false on failure.
+     */
+    addDisplaySet(displaySet) {
+        if (displaySet instanceof ImageSet) {
+            this._displaySets.push(displaySet);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Invokes the supplied callback for each display set in the current study passing
+     * two arguments: display set (a ImageSet instance) and index (the integer
+     * index of the display set within the current study)
+     * @param {function} callback The callback function which will be invoked for each display set instance.
+     * @returns {undefined} Nothing is returned.
+     */
+    forEachDisplaySet(callback) {
+        if (Metadata.isValidCallback(callback)) {
+            this._displaySets.forEach((displaySet, index) => {
+                callback.call(null, displaySet, index);
+            });
+        }
     }
 
     /**