Menu
▾
▴
pymerase-cvs-commit — CVS Commits to Pymerase Project
You can subscribe to this list here.
| 2002 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
(57) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2003 |
Jan
(44) |
Feb
(151) |
Mar
(131) |
Apr
(171) |
May
(125) |
Jun
(43) |
Jul
(26) |
Aug
(19) |
Sep
(10) |
Oct
|
Nov
(4) |
Dec
(28) |
| 2004 |
Jan
(134) |
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: <ki...@us...> - 2003-05-07 00:52:06
|
Update of /cvsroot/pymerase/htdocs/docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv18169
Modified Files:
index.shtml
Log Message:
updated index
Index: index.shtml
===================================================================
RCS file: /cvsroot/pymerase/htdocs/docs/output/index.shtml,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** index.shtml 2 Apr 2003 02:12:20 -0000 1.13
--- index.shtml 7 May 2003 00:52:00 -0000 1.14
***************
*** 6,10 ****
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link rel="SHORTCUT ICON" href="/images/pyfav.gif">
! <title>Pymerase</title>
</head>
--- 6,10 ----
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link rel="SHORTCUT ICON" href="/images/pyfav.gif">
! <title>Pymerase - Output Modules</title>
</head>
***************
*** 19,202 ****
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="90%" id="AutoNumber2">
<tr>
! <td width="100%" bgcolor="#0033FF"><b>Docs: Output Modules</b></td>
! </tr>
! <tr>
! <td width="100%" bgcolor="#6C8AFF"> <div align="center">
! <center>
! <table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="90%" id="AutoNumber5">
! <caption>
! <p align="left"><b>Status Color Code:</b></p>
! </caption>
! <tr>
! <td width="20%" align="center" bgcolor="#008000">Functional:<br>
! Release</td>
! <td width="20%" align="center" bgcolor="#00FF00">Functional:<br>
! Beta</td>
! <td width="20%" align="center" bgcolor="#FFFF00">Functional:<br>
! Alpha</td>
! </tr>
! <tr>
! <td width="20%" align="center" bgcolor="#FF6600">Non-Functional:<br>
! Work in progress (WP)</td>
! <td width="20%" align="center" bgcolor="#FF0000">Non-Functional:<br>
! Abandoned</td>
! <td width="20%" align="center" bgcolor="#0033FF">Planning</td>
! </tr>
! </table>
! </center>
! </div>
! <p> </p>
! <div align="center">
! <center>
! <table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="95%" id="AutoNumber3" height="390">
! <caption>
! <p align="left"><b>Pymerase: Current CVS Checkout</b></p>
! </caption>
! <tr>
! <td width="25%" align="center" bgcolor="#0033FF" height="38"><b>
! Output Module Name</b></td>
! <td width="8%" align="center" bgcolor="#0033FF" height="38"><b>
! Python</b></td>
! <td width="8%" align="center" bgcolor="#0033FF" height="38"><b>
! Jython</b></td>
! <td width="8%" align="center" bgcolor="#0033FF" height="38"><b>
! Status</b></td>
! <td width="8%" align="center" bgcolor="#0033FF" height="38"><b>
! Previous Status</b></td>
! <td width="59%" align="center" bgcolor="#0033FF" height="38"><b>
! Description</b></td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateDBAPI</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Python Database API (Currently
! PostgreSQL Support)</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateDBEditor</td>
! <td width="8%" align="center">N/A</td>
! <td width="8%" align="center">N/A</td>
! <td width="8%" align="center" bgcolor="#FF0000">Abandoned</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="59%" align="left">Prototype CGI Scripts for accessing
! DB</td>
! </tr>
! <tr>
! <td width="25%" align="center">
! <a href="CreateGraphvizUML">CreateGraphvizUML</a></td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Generates dot files for use with
! Graphviz.</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateHtmlForms</td>
! <td width="8%" align="center">N/A</td>
! <td width="8%" align="center">N/A</td>
! <td width="8%" align="center" bgcolor="#FF0000">Abandoned</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="59%" align="left">Prototype Html Forms used with
! CreateDBEditor.</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreatePyTkDbWidgets</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="59%" align="left">Creates Python Tkinter DBAPI Aware
! Widgets</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreatePyTkWidgets</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="8%" align="center" bgcolor="#FFFF00">Alpha</td>
! <td width="59%" align="left">Creates Python Tkinter Widget Lib
! for GUI Building</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreatePythonAPI</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#FF6600">No</td>
! <td width="8%" align="center" bgcolor="#FF6600">WP</td>
! <td width="8%" align="center" bgcolor="#FF6600">WP</td>
! <td width="59%" align="left">Python Object Model</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateReport</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Creates a Report text file
! describing your model.</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateSQL</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Creates SQL statements creating a
! database</td>
! </tr>
! <tr>
! <td width="25%" align="center">CreateTableXML</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Generates Table.dtd XML files.
! Provides more information</td>
! </tr>
! <tr>
! <td width="25%" align="center">iPymerase</td>
! <td width="8%" align="center" bgcolor="#008000">Yes</td>
! <td width="8%" align="center" bgcolor="#FF0000">No</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="8%" align="center" bgcolor="#00FF00">Beta</td>
! <td width="59%" align="left">Exposes an ipython interpreter for
! exploring Pymerase API.</td>
! </tr>
! </table>
! </center>
! </div>
! <p> </p>
! <div align="center">
! <center>
! <table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="90%" id="AutoNumber4">
! <caption>
! <p align="left"><b>Status Color Code:</b></p>
! </caption>
! <tr>
! <td width="20%" align="center" bgcolor="#008000">Functional:<br>
! Release</td>
! <td width="20%" align="center" bgcolor="#00FF00">Functional:<br>
! Beta</td>
! <td width="20%" align="center" bgcolor="#FFFF00">Functional:<br>
! Alpha</td>
! </tr>
! <tr>
! <td width="20%" align="center" bgcolor="#FF6600">Non-Functional:<br>
! Work in progress (WP)</td>
! <td width="20%" align="center" bgcolor="#FF0000">Non-Functional:<br>
! Abandoned</td>
! <td width="20%" align="center" bgcolor="#0033FF">Planning</td>
! </tr>
! </table>
! </center>
! </div>
! <p><br>
! </td>
</tr>
! </table>
! Last Modified: <!--#echo var="LAST_MODIFIED" -->
</td>
</tr>
--- 19,28 ----
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="90%" id="AutoNumber2">
<tr>
! <td width="100%" bgcolor="#6C8AFF">
! <!--#include virtual="output_modules.html"-->
! </td>
</tr>
! </table>
! Last Modified: <!--#echo var="LAST_MODIFIED" -->
</td>
</tr>
|
|
From: <ki...@us...> - 2003-05-07 00:51:21
|
Update of /cvsroot/pymerase/htdocs/docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv17950
Added Files:
output_modules.html
Log Message:
output modules docs v0.1.5
--- NEW FILE: output_modules.html ---
<!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"><!--
td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
td div.norm {line-height:normal;}
span.roman {font-family: serif; font-style: normal; font-weight: normal;}
span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
span.overacc1 {position: relative; left: .6em; top: -1.2ex;} --></style>
<title>Pymerase Docs - Output Modules
</title>
<h1 align="center"><font color="#0000FF">Pymerase Docs - Output Modules
</font> </h1>
<h3 align="center">Brandon King <br />
Copyright © 2003 California Institute of Technology </h3>
<h3 align="center">Version 0.1.5<br />May 6, 2003
</h3>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1 <font color="#0000FF">Output Modules</font></a><br />
<a href="#tth_sEc1.1"
>1.1 <font color="#0000FF">Overview</font></a><br />
<a href="#tth_sEc1.1.1"
>1.1.1 <font color="#0000FF">Status Key</font></a><br />
<a href="#tth_sEc1.1.2"
>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 />
<a href="#tth_sEc2.1"
>2.1 <font color="#0000FF">Description</font></a><br />
<a href="#tth_sEc2.2"
>2.2 <font color="#0000FF">Usage</font></a><br />
<a href="#tth_sEc2.3"
>2.3 <font color="#0000FF">Caveats</font></a><br />
<a href="#tth_sEc2.3.1"
>2.3.1 <font color="#0000FF">Packages</font></a><br />
<a href="#tth_sEc3"
>3 <font color="#0000FF">CreateGraphvizUML</font></a><br />
<a href="#tth_sEc3.1"
>3.1 <font color="#0000FF">Description</font></a><br />
<a href="#tth_sEc3.2"
>3.2 <font color="#0000FF">Usage</font></a><br />
<a href="#tth_sEc3.3"
>3.3 <font color="#0000FF">Caveats</font></a><br />
<a href="#tth_sEc3.3.1"
>3.3.1 <font color="#0000FF">UML Diagram Compatiblity</font></a><br />
<a href="#tth_sEc4"
>4 <font color="#0000FF">CreateReport</font></a><br />
<a href="#tth_sEc4.1"
>4.1 <font color="#0000FF">Description</font></a><br />
<a href="#tth_sEc4.2"
>4.2 <font color="#0000FF">Usage</font></a><br />
<a href="#tth_sEc4.3"
>4.3 <font color="#0000FF">Caveats</font></a><br />
<a href="#tth_sEc4.3.1"
>4.3.1 <font color="#0000FF">Not Complete</font></a><br />
<a href="#tth_sEc5"
>5 <font color="#0000FF">CreateSQL</font></a><br />
<a href="#tth_sEc5.1"
>5.1 <font color="#0000FF">Description</font></a><br />
<a href="#tth_sEc5.2"
>5.2 <font color="#0000FF">Usage</font></a><br />
<a href="#tth_sEc5.3"
>5.3 <font color="#0000FF">Caveats</font></a><br />
<a href="#tth_sEc5.3.1"
>5.3.1 <font color="#0000FF">PostgreSQL Only</font></a><br />
<a href="#tth_sEc5.3.2"
>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 />
<a href="#tth_sEc6.2"
>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 />
<div class="p"><!----></div>
<div class="p"><!----></div>
<h2><a name="tth_sEc1">
1</a> <font color="#0000FF">Output Modules</font></h2>
<h3><a name="tth_sEc1.1">
1.1</a> <font color="#0000FF">Overview</font></h3>
<div class="p"><!----></div>
<h4><a name="tth_sEc1.1.1">
1.1.1</a> <font color="#0000FF">Status Key</font></h4>
<table>
<tr><td><b>Label </td><td><b>Description </td></tr>
<tr><td>Release </td><td>Stable release. </td></tr>
<tr><td>Beta </td><td>Functional, has bugs, needs testing. </td></tr>
<tr><td>Alpha </td><td>Functional, lots of bugs, not finished, needs testing. </td></tr>
<tr><td>WP </td><td>Work in progress, Non-Functional. </td></tr>
<tr><td>Abandoned </td><td>Abandoned, Non-Functional. </td></tr>
<tr><td>Planning </td><td>In Plan phase, little or no code exists.
</td></tr></b></b></table>
<div class="p"><!----></div>
<h4><a name="tth_sEc1.1.2">
1.1.2</a> <font color="#0000FF">Current CVS Checkout</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.3">
1.1.3</a> <font color="#0000FF">Output Formats</font></h4>
<div class="p"><!----></div>
<table>
<tr><td><b>Output Module </td><td><b>Output Format </td></tr>
<tr><td>CreateDBAPI </td><td>Directory (Python Package) </td></tr>
<tr><td>CreateGraphvizUML </td><td>File (.dot) </td></tr>
<tr><td>CreatePyTkDBWidgets </td><td>Directory (Python Package) </td></tr>
<tr><td>CreatePyTkWidgets </td><td>Directory (Python Package) </td></tr>
<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>
<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>
<table>
<tr><td><b>Output Module </td><td><b>Python Module Req. </td><td><b>Other Requirements </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>
<tr><td>CreatePyTkDBWidgets </td><td>CreateDBAPI, Tkinter (Standard package) </td><td>None </td></tr>
<tr><td>CreatePyTkWidgets </td><td>Tkinter (Standard package) </td><td>None </td></tr>
<tr><td>CreatePythonAPI </td><td>mxDateTime </td><td>None </td></tr>
<tr><td>CreateReport </td><td>None </td><td>None </td></tr>
<tr><td>CreateSQL </td><td>None </td><td>PostgreSQL </td></tr>
<tr><td>CreateTableXML </td><td>None </td><td>None </td></tr>
<tr><td>iPymerase </td><td>None </td><td>ipython
</td></tr></b></b></b></table>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h2><a name="tth_sEc2">
2</a> <font color="#0000FF">CreateDBAPI</font></h2>
<h3><a name="tth_sEc2.1">
2.1</a> <font color="#0000FF">Description</font></h3>
CreateDBAPI generates a Python Database API to simplify the task of
creating Python programs which can access a database. For the DBAPI to
work, you need to have a database, you can either try to make a
compatible DBAPI for your existing database, or you can use the
CreateSQL output module to generate the SQL statements you need to
generate your database.
<div class="p"><!----></div>
<h3><a name="tth_sEc2.2">
2.2</a> <font color="#0000FF">Usage</font></h3>
Once you generate your DBAPI, you'll want to use it. Below is an
example of how to use your DBAPI.
<div class="p"><!----></div>
<pre>
#!/usr/bin/env python2.2
from YourAPI import DBSession
if __name__ == '__main__':
dbs = DBSession(dsn='localhost',
database='dbName',
user='userName',
password=None)
#######################################################
# Getting Objects from the database
#######################################################
# Create ObjOne and ObjTwo objects
#get all ObjectTypeOne objects
objectTypeOneList = dbs.getAllObjects(dbs.ObjectTypeOne)
#get all ObjectTypeTwo objects
groupList = dbs.getAllObjects(dbs.Group)
#get ObjectTypeOne with primary key/id of 1
ObjTypeOneId1 = dbs.getObject(dbs.ObjectTypeOne, '1')
#get ObjectTypeTwo objects with primary keys 1, 3, 4
ObjTypeTwo134 = dbs.getObject(dbs.NameLinkPair,
['1', '3', '4'])
#get ObjectTypeOne by database field 'name'
ObjTypeOneSomeNameList = dbs.getObjectWhere(dbs.ObjectTypeOne,
'name = \'someName\'')
#get ObjectTypeTwo that is associated with 'ObjectTypeOne'
# with name of 'someName'
if len(ObjTypeOneSomeNameList) > 0:
someNameObj = ObjTypeOneSomeNameList[0]
objType2 = someNameObj.getObjectTypeTwo()
#######################################################
# Create new objects and associate them with eachother.
#######################################################
# Create one new ObjOne, and two new ObjTwo objects
obj1 = dbs.ObjOne()
obj2 = dbs.ObjTwo()
obj2b = dbs.ObjTwo()
#make an association between object one and two
obj1.setObjTwo(obj2)
#add another ObjTwo to obj1
obj1.appendObjTwo(obj2b)
#get all ObjTwo's associated with ObjOne
obj2List = obj1.getObjTwo()
print obj2List #--> [ obj2, obj2b ]
#commit changes to database
obj1.commit()
</pre>
<div class="p"><!----></div>
<h3><a name="tth_sEc2.3">
2.3</a> <font color="#0000FF">Caveats</font></h3>
<h4><a name="tth_sEc2.3.1">
2.3.1</a> <font color="#0000FF">Packages</font></h4>
Pymerase has a partial implementation of a concept known in UML terms
as a Package. A Package allows you to define a portion of your model
which are closely related, so that it may be better organized.
<div class="p"><!----></div>
The goal is to allow the generation of different packages with
CreateDBAPI. Instead of generating SomeAPI, Pymerase would generate
SomeAPI.Package1 and SomeAPI.Package2.
<div class="p"><!----></div>
For now, Pymerase is only aware of one package. CreateDBAPI needs to
know about the package name inorder for the generated DBAPI to work
properly. If you are using parseXMI, it's defined by the UML namespace
and/or package name. If you are using parseGenexSchemaXML, it's
defined by the destination directory you supply when running Pymerase.
<div class="p"><!----></div>
<h2><a name="tth_sEc3">
3</a> <font color="#0000FF">CreateGraphvizUML</font></h2>
<h3><a name="tth_sEc3.1">
3.1</a> <font color="#0000FF">Description</font></h3>
CreateGraphvizUML uses the Pymerase API to generate a 'dot' file which
can then be used by a Graphviz program called 'dot' to generate graphs
which look similar to UML.
<div class="p"><!----></div>
This output module isn't really needed if you are using UML as the
input source. If you are using the Table.dtd XML file format, then
this module becomes useful for displaying your schema to the world.
<div class="p"><!----></div>
<h3><a name="tth_sEc3.2">
3.2</a> <font color="#0000FF">Usage</font></h3>
Once you have generated a '.dot' file, you use the following line to
generate a '.ps' (postscript) file.
<div class="p"><!----></div>
<pre>
dot -Tps -o nameOfPsFile.ps nameOfDotFile.dot
</pre>
<div class="p"><!----></div>
You should end up with something that looks like the image in
Figure 1, which was taken from the xmiSchool example included with
Pymerase.
<div class="p"><!----></div>
<div class="p"><!----></div>
<a name="tth_fIg1">
</a> <img src="images/xmiSchool.jpg">
<center>Figure 1: CreateGraphvizUML Example Output: xmiSchool Example</center>
<div class="p"><!----></div>
<h3><a name="tth_sEc3.3">
3.3</a> <font color="#0000FF">Caveats</font></h3>
<h4><a name="tth_sEc3.3.1">
3.3.1</a> <font color="#0000FF">UML Diagram Compatiblity</font></h4>
In UML, the inheritance arrows have a hollow (white) arrow pointing to
the base class which is being inherited from. Unfortunately, I was
unable to figure out how to generate these types of arrows with
Graphviz. I had to use solid (black) arrows with a dashed line to
represent inheritance.
<div class="p"><!----></div>
<h2><a name="tth_sEc4">
4</a> <font color="#0000FF">CreateReport</font></h2>
<h3><a name="tth_sEc4.1">
4.1</a> <font color="#0000FF">Description</font></h3>
CreateReport is an alternative Output Module developement tool to
iPymerase. It generates a human readable text file describing your
model using Pymerase API terms. It may not expose all of the Pymerase
API functionality, but it can be helpful when you can't use the
iPymerase output module.
<div class="p"><!----></div>
It's also a good template to start from when creating a new Output
module.
<div class="p"><!----></div>
<h3><a name="tth_sEc4.2">
4.2</a> <font color="#0000FF">Usage</font></h3>
Just create your .txt file and open it up in your favorite text
viewer. =o)
<div class="p"><!----></div>
<h3><a name="tth_sEc4.3">
4.3</a> <font color="#0000FF">Caveats</font></h3>
<h4><a name="tth_sEc4.3.1">
4.3.1</a> <font color="#0000FF">Not Complete</font></h4>
CreateReport isn't complete as it doesn't use all of the Pymerase API,
but it does use enough to be useful.
<div class="p"><!----></div>
<h2><a name="tth_sEc5">
5</a> <font color="#0000FF">CreateSQL</font></h2>
<h3><a name="tth_sEc5.1">
5.1</a> <font color="#0000FF">Description</font></h3>
CreateSQL generates SQL statements that can be used to genearte a
database base on the model you provided to Pymerase.
<div class="p"><!----></div>
<h3><a name="tth_sEc5.2">
5.2</a> <font color="#0000FF">Usage</font></h3>
Once you have generated your sql file and have PostgreSQL installed,
you can create your database. Use the following commands in a shell to
setup your database.
<div class="p"><!----></div>
<pre>
$ createdb db_name
CREATE DATABASE
$ psql db_name < name_of_sql_file.sql
<SQL DATABASE GENEARTION MESSAGES>
</pre>
<div class="p"><!----></div>
If everything went well, you should have a database. You should be
able to test your database by typing the following commands.
<div class="p"><!----></div>
<pre>
$ psql db_name
db_name=# \dt
<list of tables shown>
</pre>
<div class="p"><!----></div>
<h3><a name="tth_sEc5.3">
5.3</a> <font color="#0000FF">Caveats</font></h3>
<h4><a name="tth_sEc5.3.1">
5.3.1</a> <font color="#0000FF">PostgreSQL Only</font></h4>
Currently, Pymerase has been setup to support PostgreSQL only. It
shouldn't be too hard to make Pymerase compatible with other Database
Management Programs such as MySQL or Oracle. Although, this has not
been a priorty and will have to wait for future versions of Pymerase.
<div class="p"><!----></div>
Note that the SQL that Pymerase generates uses PostgreSQL sequences
and inheritance.
<div class="p"><!----></div>
<h4><a name="tth_sEc5.3.2">
5.3.2</a> <font color="#0000FF">PostgreSQL Table Names</font></h4>
Note that postgres will prune table names that have greater than 32
characters.
<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
module. This is convenient when you would like to provide Pymerase
with more information than you can include with a UML program.
<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
back into Pymerase.
<div class="p"><!----></div>
<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
the Pymerase API which has been filled up with your model. You can
explore the Pymerase API and learn how to use it and then write your
new Output Module.
<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
following output once iPymerase has been activated.
<div class="p"><!----></div>
<pre>
Welcome to iPymerase!
pymerase class list variable is 'classList'
Convenience Functions:
printClassess(classList)
printAttributes(attribList)
printAssociations(assocList)
getClassByName(classList, className)
getAttribByName(attribList, attribName)
getAssocByName(assocList, assocName)
In [1]:
</pre>
<div class="p"><!----></div>
Just start exploring the classList and your all set.
<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
Pymerase GUI won't shutdown or let you run Pymerase again.
<div class="p"><!----></div>
<br /><br /><hr /><small>File translated from
T<sub><font size="-1">E</font></sub>X
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>
|
|
From: <ki...@us...> - 2003-05-07 00:49:49
|
Update of /cvsroot/pymerase/htdocs/docs/output/images In directory sc8-pr-cvs1:/tmp/cvs-serv17534 Added Files: xmiSchool.jpg Log Message: figure for output modules docs --- NEW FILE: xmiSchool.jpg --- (This appears to be a binary file; contents omitted.) |
|
From: <ki...@us...> - 2003-05-07 00:48:47
|
Update of /cvsroot/pymerase/htdocs/docs/output/images In directory sc8-pr-cvs1:/tmp/cvs-serv17235/images Log Message: Directory /cvsroot/pymerase/htdocs/docs/output/images added to the repository |
|
From: <ki...@us...> - 2003-05-07 00:43:32
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv13669
Added Files:
CreateTableXML.tex
Log Message:
CreateTableXML documenation
--- NEW FILE: CreateTableXML.tex ---
% Pymerase Docs - CreateTableXML
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/07 00:35:17 $
\section{\cb CreateTableXML}
\subsection{\cb Description}
CreateTableXML generates XML files of your model which can then be
read back into Pymerase using the parseGenexSchemaXML input
module. This is convenient when you would like to provide Pymerase
with more information than you can include with a UML program.
\subsection{\cb Usage}
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
back into Pymerase.
%\subsection{\cb Caveats}
%\subsubsection{\cb Some Caveat}
%Some Caveat
|
|
From: <ki...@us...> - 2003-05-07 00:34:48
|
Update of /cvsroot/pymerase/Docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv13453
Modified Files:
output_modules.tex
Log Message:
added output formats, CreateReport and CreateTableXML
Index: output_modules.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/output_modules.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** output_modules.tex 7 May 2003 00:11:58 -0000 1.4
--- output_modules.tex 7 May 2003 00:34:45 -0000 1.5
***************
*** 29,33 ****
\author{Brandon King \\
Copyright \copyright ~2003 California Institute of Technology}
! \date{Version 0.1.4\\\today}
\maketitle
\thispagestyle{empty}
--- 29,33 ----
\author{Brandon King \\
Copyright \copyright ~2003 California Institute of Technology}
! \date{Version 0.1.5\\\today}
\maketitle
\thispagestyle{empty}
***************
*** 83,86 ****
--- 83,100 ----
\end{tabular}
+ \subsubsection{\cb Output Formats}
+
+ \begin{tabular}{ll}
+ \bf Output Module & \bf Output Format \\
+ CreateDBAPI & Directory (Python Package) \\
+ CreateGraphvizUML & File (.dot) \\
+ CreatePyTkDBWidgets & Directory (Python Package) \\
+ CreatePyTkWidgets & Directory (Python Package) \\
+ CreateReport & File (.txt) \\
+ CreateSQL & File (.sql) \\
+ CreateTableXML & Directory (schema/)\\
+ iPymerase & No Output
+ \end{tabular}
+
\subsubsection{\cb System Requirements}
***************
*** 104,108 ****
--- 118,126 ----
\input{modules/CreateGraphvizUML.tex}
\newpage
+ \input{modules/CreateReport.tex}
+ \newpage
\input{modules/CreateSQL.tex}
+ \newpage
+ \input{modules/CreateTableXML.tex}
\newpage
\input{modules/iPymerase.tex}
|
|
From: <ki...@us...> - 2003-05-07 00:33:55
|
Update of /cvsroot/pymerase/Docs/output In directory sc8-pr-cvs1:/tmp/cvs-serv13263 Modified Files: Makefile Log Message: added another dependancy Index: Makefile =================================================================== RCS file: /cvsroot/pymerase/Docs/output/Makefile,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** Makefile 7 May 2003 00:11:22 -0000 1.5 --- Makefile 7 May 2003 00:33:52 -0000 1.6 *************** *** 1,3 **** ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex modules/CreateDBAPI.tex modules/CreateSQL.tex modules/iPymerase.tex latex output_modules.tex latex output_modules.tex --- 1,3 ---- ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex modules/CreateDBAPI.tex modules/CreateSQL.tex modules/iPymerase.tex modules/CreateReport.tex modules/CreateTableXML.tex latex output_modules.tex latex output_modules.tex |
|
From: <ki...@us...> - 2003-05-07 00:25:38
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv10831
Added Files:
CreateReport.tex
Log Message:
CreateReport documentation
--- NEW FILE: CreateReport.tex ---
% Pymerase Docs - CreateReport
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/07 00:25:33 $
\section{\cb CreateReport}
\subsection{\cb Description}
CreateReport is an alternative Output Module developement tool to
iPymerase. It generates a human readable text file describing your
model using Pymerase API terms. It may not expose all of the Pymerase
API functionality, but it can be helpful when you can't use the
iPymerase output module.
It's also a good template to start from when creating a new Output
module.
\subsection{\cb Usage}
Just create your .txt file and open it up in your favorite text
viewer. =o)
\subsection{\cb Caveats}
\subsubsection{\cb Not Complete}
CreateReport isn't complete as it doesn't use all of the Pymerase API,
but it does use enough to be useful.
|
|
From: <ki...@us...> - 2003-05-07 00:12:01
|
Update of /cvsroot/pymerase/Docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv6828
Modified Files:
output_modules.tex
Log Message:
added CreateSQL and iPymerase
Index: output_modules.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/output_modules.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** output_modules.tex 6 May 2003 23:02:49 -0000 1.3
--- output_modules.tex 7 May 2003 00:11:58 -0000 1.4
***************
*** 29,33 ****
\author{Brandon King \\
Copyright \copyright ~2003 California Institute of Technology}
! \date{Version 0.1.3\\\today}
\maketitle
\thispagestyle{empty}
--- 29,33 ----
\author{Brandon King \\
Copyright \copyright ~2003 California Institute of Technology}
! \date{Version 0.1.4\\\today}
\maketitle
\thispagestyle{empty}
***************
*** 103,106 ****
--- 103,110 ----
\newpage
\input{modules/CreateGraphvizUML.tex}
+ \newpage
+ \input{modules/CreateSQL.tex}
+ \newpage
+ \input{modules/iPymerase.tex}
\end{document}
|
|
From: <ki...@us...> - 2003-05-07 00:11:25
|
Update of /cvsroot/pymerase/Docs/output In directory sc8-pr-cvs1:/tmp/cvs-serv6729 Modified Files: Makefile Log Message: added dependancy Index: Makefile =================================================================== RCS file: /cvsroot/pymerase/Docs/output/Makefile,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** Makefile 6 May 2003 22:56:40 -0000 1.4 --- Makefile 7 May 2003 00:11:22 -0000 1.5 *************** *** 1,3 **** ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex modules/CreateDBAPI.tex latex output_modules.tex latex output_modules.tex --- 1,3 ---- ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex modules/CreateDBAPI.tex modules/CreateSQL.tex modules/iPymerase.tex latex output_modules.tex latex output_modules.tex |
|
From: <ki...@us...> - 2003-05-07 00:11:00
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv6629
Added Files:
iPymerase.tex
Log Message:
iPymerase documentation
--- NEW FILE: iPymerase.tex ---
% Pymerase Docs - iPymerase
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/07 00:10:57 $
\section{\cb iPymerase}
\subsection{\cb Description}
iPymerase is meant as an Output Module developement tool. It will drop
you into an ipython interactive interpreter and allow you to explore
the Pymerase API which has been filled up with your model. You can
explore the Pymerase API and learn how to use it and then write your
new Output Module.
\subsection{\cb Usage}
Just run pymerase using anything other than the Pymweb interface to
Pymerase and launch the iPymerase output module. You will see the
following output once iPymerase has been activated.
\begin{verbatim}
Welcome to iPymerase!
pymerase class list variable is 'classList'
Convenience Functions:
printClassess(classList)
printAttributes(attribList)
printAssociations(assocList)
getClassByName(classList, className)
getAttribByName(attribList, attribName)
getAssocByName(assocList, assocName)
In [1]:
\end{verbatim}
Just start exploring the classList and your all set.
\subsection{\cb Caveats}
\subsubsection{\cb pymerasegui.py / pymerase --gui}
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
Pymerase GUI won't shutdown or let you run Pymerase again.
|
|
From: <ki...@us...> - 2003-05-07 00:10:40
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv6522
Modified Files:
CreateGraphvizUML.tex
Log Message:
added caveat
Index: CreateGraphvizUML.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/modules/CreateGraphvizUML.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** CreateGraphvizUML.tex 6 May 2003 23:01:26 -0000 1.3
--- CreateGraphvizUML.tex 7 May 2003 00:10:35 -0000 1.4
***************
*** 31,33 ****
\includegraphics[width=\textwidth]{images/xmiSchool.eps}
\caption{CreateGraphvizUML Example Output: xmiSchool Example}
! \end{figure}
\ No newline at end of file
--- 31,41 ----
\includegraphics[width=\textwidth]{images/xmiSchool.eps}
\caption{CreateGraphvizUML Example Output: xmiSchool Example}
! \end{figure}
!
! \subsection{\cb Caveats}
! \subsubsection{\cb UML Diagram Compatiblity}
! In UML, the inheritance arrows have a hollow (white) arrow pointing to
! the base class which is being inherited from. Unfortunately, I was
! unable to figure out how to generate these types of arrows with
! Graphviz. I had to use solid (black) arrows with a dashed line to
! represent inheritance.
\ No newline at end of file
|
|
From: <ki...@us...> - 2003-05-06 23:50:37
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv593
Added Files:
CreateSQL.tex
Log Message:
CreateSQL documentation
--- NEW FILE: CreateSQL.tex ---
% Pymerase Docs - CreateSQL
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/06 23:50:33 $
\section{\cb CreateSQL}
\subsection{\cb Description}
CreateSQL generates SQL statements that can be used to genearte a
database base on the model you provided to Pymerase.
\subsection{\cb Usage}
Once you have generated your sql file and have PostgreSQL installed,
you can create your database. Use the following commands in a shell to
setup your database.
\begin{verbatim}
$ createdb db_name
CREATE DATABASE
$ psql db_name < name_of_sql_file.sql
<SQL DATABASE GENEARTION MESSAGES>
\end{verbatim}
If everything went well, you should have a database. You should be
able to test your database by typing the following commands.
\begin{verbatim}
$ psql db_name
db_name=# \dt
<list of tables shown>
\end{verbatim}
\subsection{\cb Caveats}
\subsubsection{\cb PostgreSQL Only}
Currently, Pymerase has been setup to support PostgreSQL only. It
shouldn't be too hard to make Pymerase compatible with other Database
Management Programs such as MySQL or Oracle. Although, this has not
been a priorty and will have to wait for future versions of Pymerase.
Note that the SQL that Pymerase generates uses PostgreSQL sequences
and inheritance.
\subsubsection{\cb PostgreSQL Table Names}
Note that postgres will prune table names that have greater than 32
characters.
|
|
From: <ki...@us...> - 2003-05-06 23:02:52
|
Update of /cvsroot/pymerase/Docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv16633
Modified Files:
output_modules.tex
Log Message:
added copyright year and CreateDBAPI documentation
Index: output_modules.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/output_modules.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** output_modules.tex 6 May 2003 21:41:40 -0000 1.2
--- output_modules.tex 6 May 2003 23:02:49 -0000 1.3
***************
*** 28,33 ****
}
\author{Brandon King \\
! Copyright \copyright California Institute of Technology}
! \date{Version 0.1.2\\\today}
\maketitle
\thispagestyle{empty}
--- 28,33 ----
}
\author{Brandon King \\
! Copyright \copyright ~2003 California Institute of Technology}
! \date{Version 0.1.3\\\today}
\maketitle
\thispagestyle{empty}
***************
*** 99,102 ****
--- 99,105 ----
\end{tabular}
+ \newpage
+ \input{modules/CreateDBAPI.tex}
+ \newpage
\input{modules/CreateGraphvizUML.tex}
|
|
From: <ki...@us...> - 2003-05-06 23:01:29
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv16270
Modified Files:
CreateDBAPI.tex CreateGraphvizUML.tex template.tex
Log Message:
spelling error fixed
Index: CreateDBAPI.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/modules/CreateDBAPI.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** CreateDBAPI.tex 6 May 2003 22:52:58 -0000 1.2
--- CreateDBAPI.tex 6 May 2003 23:01:26 -0000 1.3
***************
*** 15,19 ****
generate your database.
! \subsection{\cb Useage}
Once you generate your DBAPI, you'll want to use it. Below is an
example of how to use your DBAPI.
--- 15,19 ----
generate your database.
! \subsection{\cb Usage}
Once you generate your DBAPI, you'll want to use it. Below is an
example of how to use your DBAPI.
Index: CreateGraphvizUML.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/modules/CreateGraphvizUML.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** CreateGraphvizUML.tex 6 May 2003 22:59:25 -0000 1.2
--- CreateGraphvizUML.tex 6 May 2003 23:01:26 -0000 1.3
***************
*** 16,20 ****
this module becomes useful for displaying your schema to the world.
! \subsection{\cb Useage}
Once you have generated a '.dot' file, you use the following line to
generate a '.ps' (postscript) file.
--- 16,20 ----
this module becomes useful for displaying your schema to the world.
! \subsection{\cb Usage}
Once you have generated a '.dot' file, you use the following line to
generate a '.ps' (postscript) file.
Index: template.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/modules/template.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** template.tex 6 May 2003 22:56:05 -0000 1.1
--- template.tex 6 May 2003 23:01:26 -0000 1.2
***************
*** 10,14 ****
Description
! \subsection{\cb Useage}
Useage
--- 10,14 ----
Description
! \subsection{\cb Usage}
Useage
|
|
From: <ki...@us...> - 2003-05-06 22:59:31
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv15659/modules
Modified Files:
CreateGraphvizUML.tex
Log Message:
added useage section
Index: CreateGraphvizUML.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/modules/CreateGraphvizUML.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** CreateGraphvizUML.tex 6 May 2003 21:42:13 -0000 1.1
--- CreateGraphvizUML.tex 6 May 2003 22:59:25 -0000 1.2
***************
*** 16,19 ****
--- 16,20 ----
this module becomes useful for displaying your schema to the world.
+ \subsection{\cb Useage}
Once you have generated a '.dot' file, you use the following line to
generate a '.ps' (postscript) file.
|
|
From: <ki...@us...> - 2003-05-06 22:56:45
|
Update of /cvsroot/pymerase/Docs/output In directory sc8-pr-cvs1:/tmp/cvs-serv14392 Modified Files: Makefile Log Message: added dependancy Index: Makefile =================================================================== RCS file: /cvsroot/pymerase/Docs/output/Makefile,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Makefile 6 May 2003 21:41:09 -0000 1.3 --- Makefile 6 May 2003 22:56:40 -0000 1.4 *************** *** 1,3 **** ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex latex output_modules.tex latex output_modules.tex --- 1,3 ---- ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex modules/CreateDBAPI.tex latex output_modules.tex latex output_modules.tex |
|
From: <ki...@us...> - 2003-05-06 22:56:11
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv14080
Added Files:
template.tex
Log Message:
template for documentation of output modules
--- NEW FILE: template.tex ---
% Pymerase Docs - Template
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/06 22:56:05 $
\section{\cb Output Module Name}
\subsection{\cb Description}
Description
\subsection{\cb Useage}
Useage
\subsection{\cb Caveats}
\subsubsection{\cb Some Caveat}
Some Caveat
|
|
From: <ki...@us...> - 2003-05-06 22:53:04
|
Update of /cvsroot/pymerase/Docs/output/modules In directory sc8-pr-cvs1:/tmp/cvs-serv13030 Modified Files: CreateDBAPI.tex Log Message: title update Index: CreateDBAPI.tex =================================================================== RCS file: /cvsroot/pymerase/Docs/output/modules/CreateDBAPI.tex,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** CreateDBAPI.tex 6 May 2003 22:52:03 -0000 1.1 --- CreateDBAPI.tex 6 May 2003 22:52:58 -0000 1.2 *************** *** 1,3 **** ! % Pymerase Docs - CreateGraphvizUML % Copyright (c) California Institute of Technology % --- 1,3 ---- ! % Pymerase Docs - CreateDBAPI % Copyright (c) California Institute of Technology % |
|
From: <ki...@us...> - 2003-05-06 22:52:10
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv12779
Added Files:
CreateDBAPI.tex
Log Message:
first version of DBAPI docs
--- NEW FILE: CreateDBAPI.tex ---
% Pymerase Docs - CreateGraphvizUML
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/06 22:52:03 $
\section{\cb CreateDBAPI}
\subsection{\cb Description}
CreateDBAPI generates a Python Database API to simplify the task of
creating Python programs which can access a database. For the DBAPI to
work, you need to have a database, you can either try to make a
compatible DBAPI for your existing database, or you can use the
CreateSQL output module to generate the SQL statements you need to
generate your database.
\subsection{\cb Useage}
Once you generate your DBAPI, you'll want to use it. Below is an
example of how to use your DBAPI.
\begin{verbatim}
#!/usr/bin/env python2.2
from YourAPI import DBSession
if __name__ == '__main__':
dbs = DBSession(dsn='localhost',
database='dbName',
user='userName',
password=None)
#######################################################
# Getting Objects from the database
#######################################################
# Create ObjOne and ObjTwo objects
#get all ObjectTypeOne objects
objectTypeOneList = dbs.getAllObjects(dbs.ObjectTypeOne)
#get all ObjectTypeTwo objects
groupList = dbs.getAllObjects(dbs.Group)
#get ObjectTypeOne with primary key/id of 1
ObjTypeOneId1 = dbs.getObject(dbs.ObjectTypeOne, '1')
#get ObjectTypeTwo objects with primary keys 1, 3, 4
ObjTypeTwo134 = dbs.getObject(dbs.NameLinkPair,
['1', '3', '4'])
#get ObjectTypeOne by database field 'name'
ObjTypeOneSomeNameList = dbs.getObjectWhere(dbs.ObjectTypeOne,
'name = \'someName\'')
#get ObjectTypeTwo that is associated with 'ObjectTypeOne'
# with name of 'someName'
if len(ObjTypeOneSomeNameList) > 0:
someNameObj = ObjTypeOneSomeNameList[0]
objType2 = someNameObj.getObjectTypeTwo()
#######################################################
# Create new objects and associate them with eachother.
#######################################################
# Create one new ObjOne, and two new ObjTwo objects
obj1 = dbs.ObjOne()
obj2 = dbs.ObjTwo()
obj2b = dbs.ObjTwo()
#make an association between object one and two
obj1.setObjTwo(obj2)
#add another ObjTwo to obj1
obj1.appendObjTwo(obj2b)
#get all ObjTwo's associated with ObjOne
obj2List = obj1.getObjTwo()
print obj2List #--> [ obj2, obj2b ]
#commit changes to database
obj1.commit()
\end{verbatim}
\subsection{\cb Caveats}
\subsubsection{\cb Packages}
Pymerase has a partial implementation of a concept known in UML terms
as a Package. A Package allows you to define a portion of your model
which are closely related, so that it may be better organized.
The goal is to allow the generation of different packages with
CreateDBAPI. Instead of generating SomeAPI, Pymerase would generate
SomeAPI.Package1 and SomeAPI.Package2.
For now, Pymerase is only aware of one package. CreateDBAPI needs to
know about the package name inorder for the generated DBAPI to work
properly. If you are using parseXMI, it's defined by the UML namespace
and/or package name. If you are using parseGenexSchemaXML, it's
defined by the destination directory you supply when running Pymerase.
|
|
From: <ki...@us...> - 2003-05-06 21:42:18
|
Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv14297
Added Files:
CreateGraphvizUML.tex
Log Message:
CreateGraphvizUML output module docs
--- NEW FILE: CreateGraphvizUML.tex ---
% Pymerase Docs - CreateGraphvizUML
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/06 21:42:13 $
\section{\cb CreateGraphvizUML}
\subsection{\cb Description}
CreateGraphvizUML uses the Pymerase API to generate a 'dot' file which
can then be used by a Graphviz program called 'dot' to generate graphs
which look similar to UML.
This output module isn't really needed if you are using UML as the
input source. If you are using the Table.dtd XML file format, then
this module becomes useful for displaying your schema to the world.
Once you have generated a '.dot' file, you use the following line to
generate a '.ps' (postscript) file.
\begin{verbatim}
dot -Tps -o nameOfPsFile.ps nameOfDotFile.dot
\end{verbatim}
You should end up with something that looks like the image in
Figure~1, which was taken from the xmiSchool example included with
Pymerase.
\begin{figure}[h]
\includegraphics[width=\textwidth]{images/xmiSchool.eps}
\caption{CreateGraphvizUML Example Output: xmiSchool Example}
\end{figure}
|
|
From: <ki...@us...> - 2003-05-06 21:41:44
|
Update of /cvsroot/pymerase/Docs/output
In directory sc8-pr-cvs1:/tmp/cvs-serv14018
Modified Files:
output_modules.tex
Log Message:
import CreateGraphvizUML.tex docs
Index: output_modules.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/output/output_modules.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** output_modules.tex 6 May 2003 21:09:24 -0000 1.1
--- output_modules.tex 6 May 2003 21:41:40 -0000 1.2
***************
*** 29,33 ****
\author{Brandon King \\
Copyright \copyright California Institute of Technology}
! \date{Version 0.1.1\\\today}
\maketitle
\thispagestyle{empty}
--- 29,33 ----
\author{Brandon King \\
Copyright \copyright California Institute of Technology}
! \date{Version 0.1.2\\\today}
\maketitle
\thispagestyle{empty}
***************
*** 99,102 ****
--- 99,103 ----
\end{tabular}
+ \input{modules/CreateGraphvizUML.tex}
\end{document}
|
|
From: <ki...@us...> - 2003-05-06 21:41:13
|
Update of /cvsroot/pymerase/Docs/output In directory sc8-pr-cvs1:/tmp/cvs-serv13930 Modified Files: Makefile Log Message: changed dependancy Index: Makefile =================================================================== RCS file: /cvsroot/pymerase/Docs/output/Makefile,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Makefile 6 May 2003 21:36:47 -0000 1.2 --- Makefile 6 May 2003 21:41:09 -0000 1.3 *************** *** 1,3 **** ! output_modules.pdf: output_modules.tex outputModules/CreateGraphvizUML.tex latex output_modules.tex latex output_modules.tex --- 1,3 ---- ! output_modules.pdf: output_modules.tex modules/CreateGraphvizUML.tex latex output_modules.tex latex output_modules.tex |
|
From: <ki...@us...> - 2003-05-06 21:40:54
|
Update of /cvsroot/pymerase/Docs/output/images In directory sc8-pr-cvs1:/tmp/cvs-serv13798/images Added Files: xmiSchool.eps Log Message: figure for documentation --- NEW FILE: xmiSchool.eps --- %!PS-Adobe-3.0 EPSF-3.0 %%Creator: GIMP PostScript file plugin V 1.12 by Peter Kirchgessner %%Title: /home/king/proj/docs/pymerase/Docs/output/outputModules/images/xmiSchool.eps %%CreationDate: Tue May 6 14:30:45 2003 %%DocumentData: Clean7Bit %%LanguageLevel: 2 %%Pages: 1 %%BoundingBox: 0 0 613 369 %%EndComments %%BeginProlog % Use own dictionary to avoid conflicts 10 dict begin %%EndProlog %%Page: 1 1 % Translate for offset 0.000028 0.000028 translate % Translate to begin of first scanline 0.000000 368.640000 translate 612.720000 -368.640000 scale [...2017 lines suppressed...] 0`rrW3"!!`H's8Dfir.4mGrrDKdrr<%Ms1eR<rr;lqrrE%Ls1J@6!<<)unc&^js8N(Ms1SF6rr2 s'r<N&is8W&kJcD_L#Pn/ps6U-eon!.Zrs&K&qu?Zrrdk*^rrW9$s8MQg"9/?#!.k0`rrW3"!!i N(!!r`-!!e&UW<!25!!!?+!rRWL_#FW<s82ir!<.QL]`/'6s8W)grr`9#rr@WM^&J05rrE#t"7- !ep4<4BrWi/srV6Bfs7LsC_>a`=s82ir!<.QL]`/'6s8W)grr`9#rr@WM^&J05rr<9&r:Kmds7h 0FVuHkjs8DqJs1\L;rr;lqrrE%Ls1J@6!<<)unc&^js8N(Ms1SF6rr2utrri<#s7H);ri,nrrr` /uqs/h5_#FW<s82ir!<.QL]`/'6s8W)grr`9#rr@WM^&J05rr<6#s7cQhrIP!Frrqunqu?]qJcE Rd#6+Z"s8N)uJcEC_!s&B$rpg!jrr;uuJcEF`!ri3"JcC<$JcFCeH#r;clqJcEOc#4MTl!<< )qnc&gis8N*!s6kO=_#FK2rr@WMJcC<$f`)-Ls7lU%l[f)Ors/2rrVHTpo)/%X#Q4/m!;l`poR[% XrrM?nJcC<$JcFF'!;c]p"8Mp-!.b0e!<iH+!"/i(mJd@d!=Jl1!.b0e!<N64!.k0$s+14%rrqN Zs7#sdJc<Lb#Q"K#rVQWhnaZVanb<(\rVuooJc<Lb!rMNfJcC<$JcFF'!;$3i"8Vurrdk*crs&G spAY'hq="=fq>C6kpA"T;s1nX8oDaCAJcC<$f`)0Qs82?_rVqHI_>XE6"TJGsrqc*`#5\>ps8N& uJc3F`rr7QLJcC<$g&D<Vo`+jhs8MtJs1nX=r;ZHis8M`^rs&2rs8Vclr.4m`rrVrgrIP!"s+14% rrr5ns8VopJc<Lb#6"T%qu$Kdn,EUas8;cos8@NJ_>XN9rr7QLJcC<$JcC<$JcDnQJcC<$JcC<$ JcC<$Y5a(QJcC<$JcC<$JcDnQJcC<$JcC<$JcC<$Y5a(QJcC<$JcC<$JcDnQJcC<$JcC<$JcC<$ Y5a(QJcC<$JcC<$JcDnQJcC<$JcC<$JcC<$Y5a"~> %%EndData showpage %%Trailer end %%EOF |
|
From: <ki...@us...> - 2003-05-06 21:40:12
|
Update of /cvsroot/pymerase/Docs/output/images In directory sc8-pr-cvs1:/tmp/cvs-serv13635/images Log Message: Directory /cvsroot/pymerase/Docs/output/images added to the repository |
