Adding loadStudy method to StudyMetadataSource API

This commit is contained in:
Emanuel F. Oliveira 2017-02-13 12:57:07 -02:00 committed by Eloízio Salgado
parent 54e8a3f8f2
commit d8e5609089
2 changed files with 16 additions and 15 deletions

View File

@ -20,7 +20,7 @@ export class OHIFStudyMetadataSource extends OHIF.viewerbase.StudyMetadataSource
/**
* Load study info (OHIF.viewer.Studies) and study metadata (OHIF.viewer.StudyMetadataList) for a given study.
* @param {StudySummary|StudyMetadata} Instance of StudySummary or StudyMetadata object
* @param {StudySummary|StudyMetadata} study of StudySummary or StudyMetadata object.
*/
loadStudy(study) {
if (!(study instanceof StudyMetadata) && !(study instanceof StudySummary)) {

View File

@ -6,19 +6,8 @@ import { OHIFError } from './OHIFError';
export class StudyMetadataSource {
/**
* Get study metadata for a given study info
* @param {Object} studyInfo Study info object
*/
getByStudyInfo(studyInfo) {
/**
* Please override this method on a specialized class.
*/
throw new OHIFError('StudyMetadataSource::getByStudyInfo is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example');
}
/**
* Get study metadata for a study with given study InstanceUID
* @param {String} studyInstanceUID Study InstanceUID
* Get study metadata for a study with given study InstanceUID.
* @param {String} studyInstanceUID Study InstanceUID.
*/
getByInstanceUID(studyInstanceUID) {
/**
@ -26,4 +15,16 @@ export class StudyMetadataSource {
*/
throw new OHIFError('StudyMetadataSource::getByInstanceUID is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example');
}
}
/**
* Load study info and study metadata for a given study into the viewer.
* @param {StudySummary|StudyMetadata} study of StudySummary or StudyMetadata object.
*/
loadStudy(study) {
/**
* Please override this method on a specialized class.
*/
throw new OHIFError('StudyMetadataSource::loadStudy is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example');
}
}