Module Structure

The Editorial Search and Replace module's code is divided into four major packages, each concerned with a specific set of tasks.

• Project Configuration
  provides means to configure a FirstSpirit project for use with this module.
• Client Service
  provides the module's reporting and search components with access to project configuration, such as templates enabled for search and replace processes.
• Report
  implements the user interface parts of the module, namely the report configuration itself, provision of report entries based upon report filters, and report items for interaction with report entries as well as handling changes to those entries' associated store elements during replacement processes. The report entry classes themselves are located in the sub-package Report Entries, while the report items are located in the sub-package Report Items.
• Search
  implements search and replace functionality which is accessed by report entry classes during report entry provision and upon interaction with entries through report items.

This chapter introduces the packages and class groups that make up the module's functionality, describing their functionality in the most essential terms. In order to avoid duplicating existing documentation (such as the FirstSpirit API documentation sets) and adding many code fragments, it is designed to supplement analysis of the example module's code and reading the API documentation.

Package Structure

The following diagram shows the module's high-level package structure. Click on either of the package blocks to navigate to a description page with more detailed notes on that package's structure.