The MIRC Module: Difference between revisions

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


===mirc.util.MircDocument===
===mirc.util.MircDocument===
SortImagesService

Revision as of 14:15, 3 January 2013

UNDER DEVELOPMENT

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.

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.

The TFS-installer

The MIRC Plugin

The MIRC Configuration File

The MIRC Base Servlet

Users, Roles, and Preferences

The Query Service

The Storage Service

The Author Services

The Advanced Author Service

The Basic Author Service

The Submit Service

The Zip Service

Author Summary

The MIRC Pipelines

The File Service

The DICOM Service

The TCE Service

Download Service

Activity Report

Utility Classes

mirc.util.MircDocument

SortImagesService