Menu
▾
▴
[Pymerase-cvs-commit] htdocs/docs/output output_modules.html,1.1,1.2
|
From: <ki...@us...> - 2003-07-08 01:38:13
|
Update of /cvsroot/pymerase/htdocs/docs/output In directory sc8-pr-cvs1:/tmp/cvs-serv10618 Modified Files: output_modules.html Log Message: v0.1.6 release Index: output_modules.html =================================================================== RCS file: /cvsroot/pymerase/htdocs/docs/output/output_modules.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** output_modules.html 7 May 2003 00:51:18 -0000 1.1 --- output_modules.html 8 Jul 2003 01:38:08 -0000 1.2 *************** *** 1,6 **** ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" ! "http://www.w3.org/TR/REC-html40/loose.dtd"> <html> ! <meta name="GENERATOR" content="TtH 3.33"> <style type="text/css"> div.p { margin-top: 7pt;}</style> <style type="text/css"><!-- --- 1,6 ---- ! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ! "http://www.w3.org/TR/html4/loose.dtd"> <html> ! <meta name="GENERATOR" content="TtH 3.40"> <style type="text/css"> div.p { margin-top: 7pt;}</style> <style type="text/css"><!-- *************** *** 14,20 **** ! <title>Pymerase Docs - Output Modules ! </title> ! <h1 align="center"><font color="#0000FF">Pymerase Docs - Output Modules </font> </h1> --- 14,23 ---- ! <title>Pymerase Docs - Output Modules</title> ! ! <div class="p"><!----></div> ! ! <title>Pymerase Docs - Output Modules</title> ! <h1 align="center"><font color="#0000FF">Pymerase Docs - Output Modules </font> </h1> *************** *** 23,27 **** Copyright © 2003 California Institute of Technology </h3> ! <h3 align="center">Version 0.1.5<br />May 6, 2003 </h3> --- 26,30 ---- Copyright © 2003 California Institute of Technology </h3> ! <h3 align="center">Version 0.1.6<br />Jul 7, 2003 </h3> *************** *** 40,46 **** >1.1.2 <font color="#0000FF">Current CVS Checkout</font></a><br /> <a href="#tth_sEc1.1.3" ! >1.1.3 <font color="#0000FF">Output Formats</font></a><br /> <a href="#tth_sEc1.1.4" ! >1.1.4 <font color="#0000FF">System Requirements</font></a><br /> <a href="#tth_sEc2" >2 <font color="#0000FF">CreateDBAPI</font></a><br /> --- 43,51 ---- >1.1.2 <font color="#0000FF">Current CVS Checkout</font></a><br /> <a href="#tth_sEc1.1.3" ! >1.1.3 <font color="#0000FF">Pymerase v0.1.99.0</font></a><br /> <a href="#tth_sEc1.1.4" ! >1.1.4 <font color="#0000FF">Output Formats</font></a><br /> ! <a href="#tth_sEc1.1.5" ! >1.1.5 <font color="#0000FF">System Requirements</font></a><br /> <a href="#tth_sEc2" >2 <font color="#0000FF">CreateDBAPI</font></a><br /> *************** *** 86,90 **** >5.3.2 <font color="#0000FF">PostgreSQL Table Names</font></a><br /> <a href="#tth_sEc6" ! >6 <font color="#0000FF">CreateTableXML</font></a><br /> <a href="#tth_sEc6.1" >6.1 <font color="#0000FF">Description</font></a><br /> --- 91,95 ---- >5.3.2 <font color="#0000FF">PostgreSQL Table Names</font></a><br /> <a href="#tth_sEc6" ! >6 <font color="#0000FF">CreateTabDelimitedParser</font></a><br /> <a href="#tth_sEc6.1" >6.1 <font color="#0000FF">Description</font></a><br /> *************** *** 92,104 **** >6.2 <font color="#0000FF">Usage</font></a><br /> <a href="#tth_sEc7" ! >7 <font color="#0000FF">iPymerase</font></a><br /> <a href="#tth_sEc7.1" >7.1 <font color="#0000FF">Description</font></a><br /> <a href="#tth_sEc7.2" >7.2 <font color="#0000FF">Usage</font></a><br /> ! <a href="#tth_sEc7.3" ! >7.3 <font color="#0000FF">Caveats</font></a><br /> ! <a href="#tth_sEc7.3.1" ! >7.3.1 <font color="#0000FF">pymerasegui.py / pymerase -gui</font></a><br /> --- 97,115 ---- >6.2 <font color="#0000FF">Usage</font></a><br /> <a href="#tth_sEc7" ! >7 <font color="#0000FF">CreateTableXML</font></a><br /> <a href="#tth_sEc7.1" >7.1 <font color="#0000FF">Description</font></a><br /> <a href="#tth_sEc7.2" >7.2 <font color="#0000FF">Usage</font></a><br /> ! <a href="#tth_sEc8" ! >8 <font color="#0000FF">iPymerase</font></a><br /> ! <a href="#tth_sEc8.1" ! >8.1 <font color="#0000FF">Description</font></a><br /> ! <a href="#tth_sEc8.2" ! >8.2 <font color="#0000FF">Usage</font></a><br /> ! <a href="#tth_sEc8.3" ! >8.3 <font color="#0000FF">Caveats</font></a><br /> ! <a href="#tth_sEc8.3.1" ! >8.3.1 <font color="#0000FF">pymerasegui.py / pymerase -gui</font></a><br /> *************** *** 138,141 **** --- 149,153 ---- <table> <tr><td><b>Output Module </td><td align="center"><b>Status </td><td align="center"><b>Prev. Status </td><td><b>Description </td></tr> + <tr><td>CreateCppAPI </td><td align="center">WP </td><td align="center">Planning </td><td>Generation of C++ API </td></tr> <tr><td>CreateDBAPI </td><td align="center">Beta </td><td align="center">Beta </td><td>Python Database API (Currently </td></tr> <tr><td></td><td align="center"></td><td align="center"></td><td>PostgreSQL Support) </td></tr> *************** *** 155,158 **** --- 167,173 ---- <tr><td>CreateSQL </td><td align="center">Beta </td><td align="center">Beta </td><td>Creates SQL statements creating </td></tr> <tr><td></td><td align="center"></td><td align="center"></td><td>a database </td></tr> + <tr><td>CreateTabDelimitedParser </td><td align="center">Alpha </td><td align="center">Planning </td><td>Generates Tab Delimited Text </td></tr> + <tr><td></td><td align="center"></td><td align="center"></td><td>Parser with support for pickling </td></tr> + <tr><td></td><td align="center"></td><td align="center"></td><td>or saving to database. </td></tr> <tr><td>CreateTableXML </td><td align="center">Beta </td><td align="center">Beta </td><td>Generates Table.dtd XML </td></tr> <tr><td></td><td align="center"></td><td align="center"></td><td>files. Provides more information </td></tr> *************** *** 164,168 **** <div class="p"><!----></div> <h4><a name="tth_sEc1.1.3"> ! 1.1.3</a> <font color="#0000FF">Output Formats</font></h4> <div class="p"><!----></div> --- 179,215 ---- <div class="p"><!----></div> <h4><a name="tth_sEc1.1.3"> ! 1.1.3</a> <font color="#0000FF">Pymerase v0.1.99.0</font></h4> ! ! <div class="p"><!----></div> ! ! <table> ! <tr><td><b>Output Module </td><td align="center"><b>Status </td><td align="center"><b>Prev. Status </td><td><b>Description </td></tr> ! <tr><td>CreateDBAPI </td><td align="center">Beta </td><td align="center">Beta </td><td>Python Database API (Currently </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>PostgreSQL Support) </td></tr> ! <tr><td>CreateDBEditor </td><td align="center">Abandoned </td><td align="center">Alpha </td><td>Prototype CGI </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>Scripts for accessing DB </td></tr> ! <tr><td>CreateGraphvizUML </td><td align="center">Beta </td><td align="center">Beta </td><td>Generates dot files for </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>use with Graphviz. </td></tr> ! <tr><td>CreateHtmlForms </td><td align="center">Abandoned </td><td align="center">Alpha </td><td>Prototype Html Forms </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>used with CreateDBEditor. </td></tr> ! <tr><td>CreatePyTkDBWidgets </td><td align="center">Alpha </td><td align="center">Alpha </td><td>Creates Python </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>Tkinter DBAPI Aware Widgets </td></tr> ! <tr><td>CreatePyTkWidgets </td><td align="center">Alpha </td><td align="center">Alpha </td><td>Creates Python </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>Tkinter Widget Lib for GUI Building </td></tr> ! <tr><td>CreatePythonAPI </td><td align="center">WP </td><td align="center">WP </td><td>Python Object Model </td></tr> ! <tr><td>CreateReport </td><td align="center">Beta </td><td align="center">Beta </td><td>Creates a Report text file </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>describing your model. </td></tr> ! <tr><td>CreateSQL </td><td align="center">Beta </td><td align="center">Beta </td><td>Creates SQL statements creating </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>a database </td></tr> ! <tr><td>CreateTableXML </td><td align="center">Beta </td><td align="center">Beta </td><td>Generates Table.dtd XML </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>files. Provides more information </td></tr> ! <tr><td>iPymerase </td><td align="center">Beta </td><td align="center">Beta </td><td>Exposes an ipython interpreter </td></tr> ! <tr><td></td><td align="center"></td><td align="center"></td><td>for exploring Pymerase API. ! </td></tr></b></b></b></b></table> ! ! ! <div class="p"><!----></div> ! <h4><a name="tth_sEc1.1.4"> ! 1.1.4</a> <font color="#0000FF">Output Formats</font></h4> <div class="p"><!----></div> *************** *** 170,173 **** --- 217,221 ---- <table> <tr><td><b>Output Module </td><td><b>Output Format </td></tr> + <tr><td>CreateCppAPI </td><td>Directory (C++ Code) </td></tr> <tr><td>CreateDBAPI </td><td>Directory (Python Package) </td></tr> <tr><td>CreateGraphvizUML </td><td>File (.dot) </td></tr> *************** *** 176,180 **** <tr><td>CreateReport </td><td>File (.txt) </td></tr> <tr><td>CreateSQL </td><td>File (.sql) </td></tr> ! <tr><td>CreateTableXML </td><td>Directory (schema/)</td></tr> <tr><td>iPymerase </td><td>No Output </td></tr></b></b></table> --- 224,229 ---- <tr><td>CreateReport </td><td>File (.txt) </td></tr> <tr><td>CreateSQL </td><td>File (.sql) </td></tr> ! <tr><td>CreateTabDelimitedParser </td><td>File (.py) </td></tr> ! <tr><td>CreateTableXML </td><td>Directory (schema/) </td></tr> <tr><td>iPymerase </td><td>No Output </td></tr></b></b></table> *************** *** 182,187 **** <div class="p"><!----></div> ! <h4><a name="tth_sEc1.1.4"> ! 1.1.4</a> <font color="#0000FF">System Requirements</font></h4> <div class="p"><!----></div> --- 231,236 ---- <div class="p"><!----></div> ! <h4><a name="tth_sEc1.1.5"> ! 1.1.5</a> <font color="#0000FF">System Requirements</font></h4> <div class="p"><!----></div> *************** *** 189,192 **** --- 238,242 ---- <table> <tr><td><b>Output Module </td><td><b>Python Module Req. </td><td><b>Other Requirements </td></tr> + <tr><td>CreateCppAPI </td><td>None </td><td>GCC, Make </td></tr> <tr><td>CreateDBAPI </td><td>Pygresql (pgdb), mxDatetime (mx.DateTime) </td><td>Postgresql </td></tr> <tr><td>CreateGraphvizUML </td><td>None </td><td>Graphviz (dot) </td></tr> *************** *** 196,199 **** --- 246,250 ---- <tr><td>CreateReport </td><td>None </td><td>None </td></tr> <tr><td>CreateSQL </td><td>None </td><td>PostgreSQL </td></tr> + <tr><td>CreateTabDelimitedParser </td><td>CreateDBAPI (Optional) </td><td>None </td></tr> <tr><td>CreateTableXML </td><td>None </td><td>None </td></tr> <tr><td>iPymerase </td><td>None </td><td>ipython *************** *** 347,351 **** <div class="p"><!----></div> <a name="tth_fIg1"> ! </a> <img src="images/xmiSchool.jpg"> <center>Figure 1: CreateGraphvizUML Example Output: xmiSchool Example</center> --- 398,402 ---- <div class="p"><!----></div> <a name="tth_fIg1"> ! </a> <a href="images/xmiSchool.eps">Figure</a> <center>Figure 1: CreateGraphvizUML Example Output: xmiSchool Example</center> *************** *** 461,468 **** <div class="p"><!----></div> <h2><a name="tth_sEc6"> ! 6</a> <font color="#0000FF">CreateTableXML</font></h2> <h3><a name="tth_sEc6.1"> 6.1</a> <font color="#0000FF">Description</font></h3> CreateTableXML generates XML files of your model which can then be read back into Pymerase using the parseGenexSchemaXML input --- 512,597 ---- <div class="p"><!----></div> <h2><a name="tth_sEc6"> ! 6</a> <font color="#0000FF">CreateTabDelimitedParser</font></h2> <h3><a name="tth_sEc6.1"> 6.1</a> <font color="#0000FF">Description</font></h3> + Note that the description below is for the alpha version of the + CreateTabDelimitedParser output module. New and improved features are + likely to be added in the near future. + + <div class="p"><!----></div> + This output module generates a tab delimited text file parser. To + generate the parser correctly you need to define a single 'Class' in + UML, or a single 'Table' using table.dtd XML. The first attribute in + the class/table will be column 0 (first column). The second attribute + in the class/table will be column 1 (second column) and so on and so + forth. + + <div class="p"><!----></div> + The Parser file itself contains the following: + + <div class="p"><!----></div> + + <table> + <tr><td><b>*Parser </td><td>Tab Delimited Text Parser </td></tr> + <tr><td><b>*Record </td><td>Stores One Line of Parsed Text </td></tr> + <tr><td><b>*Master </td><td>Base Container Class of *Records </td></tr> + <tr><td><b>*PickleMaster </td><td>Inherits from *Master </td></tr> + <tr><td></td><td>Enables class to pickle itself to disk </td></tr> + <tr><td><b>*DbMaster </td><td>Inherits from *Master </td></tr> + <tr><td></td><td>Enables class to save to DB via DBAPI + </td></tr></b></b></b></b></b></table> + + + <div class="p"><!----></div> + The *Master class provides a save() function which doesn't do much by + itself. The purpose to this class is to be a base class for a custom + Master class which has a custom save command. Two super classes have + been provide for use. *PickleMaster which uses Python's 'pickle', to + save itself to disc. *DbMaster, on the other hand, will save to + database which can be generated by 'CreateSQL' output module. And then + accessed by the DBAPI generated by the 'CreateDBAPI' output module. + + <div class="p"><!----></div> + <h3><a name="tth_sEc6.2"> + 6.2</a> <font color="#0000FF">Usage</font></h3> + + <div class="p"><!----></div> + To use the use the parser to save your tab delimited text file to a + database after you created the database (CreateSQL) and generated the + DBAPI (CreateDBAPI), your import the generated parser module and type + the following python code. + + <div class="p"><!----></div> + + <pre> + #Note that * are replaced by more meaningful names when the parser + # is generated. + + #Choose a Master container class and pass it to the parser + parser = *Parser(*DbMaster) + + #Pass the file name of the tab delimited text to the parser + parsedData = parser.parse(fileName) + + #Tell the parsed data to save itself to the database. + parsedData.save('localhost', 'myDatabase', 'myUser', 'myPassword') + + </pre> + + <div class="p"><!----></div> + Hopefully that helps, but if are confused or have any questions, feel + free to send a message to one of the Pymerase mailing lists. Also note + that the generated tab delimited text parser contains documention on + how to use it. + + <div class="p"><!----></div> + + <div class="p"><!----></div> + <h2><a name="tth_sEc7"> + 7</a> <font color="#0000FF">CreateTableXML</font></h2> + + <h3><a name="tth_sEc7.1"> + 7.1</a> <font color="#0000FF">Description</font></h3> CreateTableXML generates XML files of your model which can then be read back into Pymerase using the parseGenexSchemaXML input *************** *** 471,476 **** <div class="p"><!----></div> ! <h3><a name="tth_sEc6.2"> ! 6.2</a> <font color="#0000FF">Usage</font></h3> All you have to do is tell Pymerase what directory you want your XML files to end up in and then your done. Edit away, and then feed it --- 600,605 ---- <div class="p"><!----></div> ! <h3><a name="tth_sEc7.2"> ! 7.2</a> <font color="#0000FF">Usage</font></h3> All you have to do is tell Pymerase what directory you want your XML files to end up in and then your done. Edit away, and then feed it *************** *** 482,490 **** <div class="p"><!----></div> ! <h2><a name="tth_sEc7"> ! 7</a> <font color="#0000FF">iPymerase</font></h2> ! <h3><a name="tth_sEc7.1"> ! 7.1</a> <font color="#0000FF">Description</font></h3> iPymerase is meant as an Output Module developement tool. It will drop you into an ipython interactive interpreter and allow you to explore --- 611,619 ---- <div class="p"><!----></div> ! <h2><a name="tth_sEc8"> ! 8</a> <font color="#0000FF">iPymerase</font></h2> ! <h3><a name="tth_sEc8.1"> ! 8.1</a> <font color="#0000FF">Description</font></h3> iPymerase is meant as an Output Module developement tool. It will drop you into an ipython interactive interpreter and allow you to explore *************** *** 494,499 **** <div class="p"><!----></div> ! <h3><a name="tth_sEc7.2"> ! 7.2</a> <font color="#0000FF">Usage</font></h3> Just run pymerase using anything other than the Pymweb interface to Pymerase and launch the iPymerase output module. You will see the --- 623,628 ---- <div class="p"><!----></div> ! <h3><a name="tth_sEc8.2"> ! 8.2</a> <font color="#0000FF">Usage</font></h3> Just run pymerase using anything other than the Pymweb interface to Pymerase and launch the iPymerase output module. You will see the *************** *** 523,531 **** <div class="p"><!----></div> ! <h3><a name="tth_sEc7.3"> ! 7.3</a> <font color="#0000FF">Caveats</font></h3> ! <h4><a name="tth_sEc7.3.1"> ! 7.3.1</a> <font color="#0000FF">pymerasegui.py / pymerase -gui</font></h4> If you run iPymerase from the Pymerase GUI, then you will have to make sure you exit the ipython interpreter when your done, otherwise the --- 652,660 ---- <div class="p"><!----></div> ! <h3><a name="tth_sEc8.3"> ! 8.3</a> <font color="#0000FF">Caveats</font></h3> ! <h4><a name="tth_sEc8.3.1"> ! 8.3.1</a> <font color="#0000FF">pymerasegui.py / pymerase -gui</font></h4> If you run iPymerase from the Pymerase GUI, then you will have to make sure you exit the ipython interpreter when your done, otherwise the *************** *** 538,541 **** by <a href="http://hutchinson.belmont.ma.us/tth/"> T<sub><font size="-1">T</font></sub>H</a>, ! version 3.33.<br />On 6 May 2003, 17:47.</small> </html> --- 667,670 ---- by <a href="http://hutchinson.belmont.ma.us/tth/"> T<sub><font size="-1">T</font></sub>H</a>, ! version 3.40.<br />On 7 Jul 2003, 18:24.</small> </html> |
