Documentor Functions : Overview of the Extraction Functions

Overview of the Extraction Functions

The database extraction functions are a collection of routines that enable you to extract information from the specification database.

There are four types of database extraction functions:

Single-element - Provide information about a discrete Rational Statemate element in the specification database. For example, you can retrieve the contents of the description field in the form for a particular state. See Single-Element Functions for detailed information.
Query - Extract lists of elements from the database that conform to a specific criterion. For example, you can extract a list of activities from the database that are control activities. Each function corresponds directly to a query of the property sheet. Function output consists of a list of Rational Statemate elements. See Query Functions for detailed information.
Utility - Perform operations on lists and strings. Most of these functions do not extract information from the database, but enable you to manipulate the information you have already retrieved. See Utility Functions for detailed information.
Project management - Extract information about the Statemate project, manager, and members.