|
POSC Specifications Version 2.2 | Projection Tool |
This directory is the top of the directories that contain the source code for
the various C-programs.
The following files are contained in this directory:
| File | Description |
|---|---|
| ExportExpress | This directory contains the source for the ExportExpress utility. This utility reads an express file and generates metadata ASCII files that can be loaded into a database by the loadPTX program. It uses the NIST express parser to parse the express file and uses the structures created by this parser to produce the result. |
| GenC | This directory contains a utility program that generates standard i/o
functions and data structures for all tables in the database. This
program is used from the 'src/ptlib' directory when
running 'make functions'. There will be no need for this,
since all functions are generated and distributed with this
release. It may be useful when extending the meta data and
automatically generate the data structures and access and
insert functions and their prototypes.
This utility generated a structure with an item for each column in a table. It removes underscores and if it does, it makes the letter following the underscore uppercase. All other letters are lowercase. It recognizes some of the datatypes defined in the general Projection Toolkit include file 'include/pt.h'. These data structures are used by the interface functions that read or insert data into the tables. For more usage information about these functions see ptlib/README . |
| GenExpress | This program generates express from the meta data. It is also capable of generating HTML files of the express that is automatically linked in with the result of the docTool and other documentation generation tools included. |
| Makefile | High level makefile to compile and link all Projection Toolkit libraries and sources. |
| ProjTool | This directory contains the source for the Projection Tool. This tool generates the relational projection into the meta data, based on several input files (*.ptp, see ../models/epic.2.2/input/README . |
| README | The ASCII version of this file. |
| README.htm | The HTML version of this file. |
| ddlTool | This directory contains the source for the DDL tool that generates DDL from the meta data. It can produce several DDL files (see ../models/epic.2.2/ddl/README) based on the options specified on the command line. It is also capable of generating an HTML version of the DDL that is automatically linked with the other documentation generated by the docTool program and other documentation related tools. Note that informix DDL is generated from the 'generic ascii file' (-g option) by an awk script (../bin/makeDDL.awk). |
| delProjection | This directory contains a utility program that deletes a particular projection from the meta data. It is intended to be used when going through cycles of subsetting and projection. This utility can be used to remove a previous projection, allowing a new subset to be defined and projected. |
| delSource | Utility program that deletes info about a particular source from the meta data. One source corresponds to one set of '*.ptx' files (see ../models/epic.2.2/input/README ) that was generated by a run of ExportExpress and loaded by loadPTX . It will only be useful when dealing with small models (otherwise, a complete drop and re-create of all tables and loading of 'Reference' (loadPTR) and 'Static' (loadPTS) would be faster). |
| docTool | This program generates HTML documentation from information in the meta database. It will generate documentation in a predefined set of files, based on the type of object (entity, NDT, table, etc.). |
| expDesc | This is a utility program that can export descriptions to an ascii file, along with an identification of which it is a description. Currently, descriptions can be exported for entities, attributes and NDT's, based on the options. |
| export | This program exports part of the meta data. The output is used by the DAE Sample Implementation to load the meta data into the production database. |
| express | This directory contains source that is copied from the NIST EXPRESS Toolkit. The express/README.NIST file contains more information (including information on how to obtain the original source). The table below is simply a list provided for completeness. No descriptions have been put here. Refer to the actual source code if necessary. |
| loadPTC | Program that loads the change information (as exported from the case tool used by POSC) into the meta data (files ' models/epic.2.2/input/*.ptc '). |
| loadPTD | Program that loads descriptions (as exported by the case tool used by POSC) into the meta data (files ' models/epic.2.2/input/*.ptd '). |
| loadPTL | Program that loads logical information (as exported from the case tool used by POSC) into the meta data. This consists of information that cannot be found in express, e.g. info about which entities are on which diagrams, types of reference entities, etc. (files ' models/epic.2.2/input/*.ptl '). |
| loadPTR | Program that loads reference data into the meta data. This is data that defines the existing methods, column group types, etc. (file ' models/epic.2.2/input/*.ptr '). |
| loadPTS | Program that loads certain 'static' data into the meta data. This includes abbreviations, sql data types and epicentre type info (files ' models/epic.2.2/input/*.pts '). |
| loadPTX | This program loads the files generated by the ExportExpress program into the meta data. These files contain the logical model as specified in express in a loadable format (files ' models/epic.2.2/input/*.ptx '). |
| or7lib | Functions that interface to the oracle OCI interface library. |
| ptlib | This directory contains library functions for the Projection Toolkit. Most of the source files here are generated (all 'get*' and 'ins*' files) by the GenC program and are used as convenient way of accessing entire rows of a table. |