Difference between revisions of "The MIRC Module"

From MircWiki
Jump to navigation Jump to search
Line 52: Line 52:

Revision as of 14:15, 3 January 2013


The MIRC module (MIRC.jar) contains the code of the CTP plugin that implements TFS, the RSNA Teaching File System. This article describes the theory of operation of the packages and files contained in the MIRC module. The intended audience for this article is software engineers extending or maintaining any of that software.

See Setting Up a MIRC Development Environment for information on obtaining and building the MIRC module. It will be helpful to get the source code and build it so you can reference the Javadocs as you go along.

1 Overview

The MIRC module contains many packages. In general, major system functions (as well as some minor ones) are encapsulated in their own packages, but because many functions interact, this principle is not universally maintained. Most system functions have classes and files that are contained in the jar file. Often, the files are XSL programs used for the generation of web pages or Javascript and CSS files referenced by the web pages. These files are served directly from the jar file without having to be installed on the disk. See The Util Module for a description of how the server serves files from the classpath.

2 The TFS-installer

3 The MIRC Plugin

4 The MIRC Configuration File

5 The MIRC Base Servlet

6 Users, Roles, and Preferences

7 The Query Service

8 The Storage Service

9 The Author Services

9.1 The Advanced Author Service

9.2 The Basic Author Service

9.3 The Submit Service

9.4 The Zip Service

9.5 Author Summary

10 The MIRC Pipelines

10.1 The File Service

10.2 The DICOM Service

10.3 The TCE Service

11 Download Service

12 Activity Report

13 Utility Classes

13.1 mirc.util.MircDocument