[Modeling-cvs] ProjectModeling/Modeling/doc/UserGuide DefiningaModel.tex,1.18,1.19

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/modeling/ProjectModeling/Modeling/doc/UserGuide
In directory sc8-pr-cvs1:/tmp/cvs-serv5564/doc/UserGuide

Modified Files:
	DefiningaModel.tex 
Log Message:
Updated doc. for PyModel: defaults for components: Entity, Attribute, ADateTime, AFloat, AInteger, AString, APrimaryKey, AForeignKey

Index: DefiningaModel.tex
===================================================================
RCS file: /cvsroot/modeling/ProjectModeling/Modeling/doc/UserGuide/DefiningaModel.tex,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** DefiningaModel.tex	24 Aug 2003 16:55:51 -0000	1.18
--- DefiningaModel.tex	24 Aug 2003 17:38:04 -0000	1.19
***************
*** 458,462 ****
  \end{itemize}

! \subsubsection{Foreign keys\label{attributes-PKs-props}}

    A foreign key is an attribute that:
--- 458,462 ----
  \end{itemize}

! \subsubsection{Foreign keys\label{attributes-FKs-props}}

    A foreign key is an attribute that:
***************
*** 645,649 ****

  Last, please note that the section describing Models
! (~\ref{pymodel-entity-props}) exposes in details how these properties can be
  set; this information will not be repeated in the sections coming afterwards.

--- 645,649 ----

  Last, please note that the section describing Models
! (\ref{pymodel-entity-props}) exposes in details how these properties can be
  set; this information will not be repeated in the sections coming afterwards.

***************
*** 777,800 ****
  \subsection{Entity\label{pymodel-entity-props}}

! tbd.

  \subsection{Attribute\label{pymodel-attribute-props}}

!     AInteger, AString, AFloat, ADateTime, APrimaryKey, AForeignKey

! \subsubsection{Primary keys\label{pymodel-attribute-props-primary-keys}}

- \subsubsection{ForeignKeys\label{pymodel-attribute-props-foreign-keys}}

! \subsection{Relationship\label{pymodel-relationship-props}}

!     RToOne, RToMany

  \subsection{Association\label{pymodel-association-props}}

  tbd. 

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! \section{Description of the {\sc xml} format\label{model-xml-format}}

  \subsection{Overview of the xml\label{model-xml-format-overview}}
--- 777,985 ----
  \subsection{Entity\label{pymodel-entity-props}}

! The component \class{Entity} defines the following properties:

+ \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
+ 
+ \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
+ arguments when instanciating a \class{Attribute}. Once set, it should not be
+ changed}
+ \lineiii{className}{value of \code{name}}{}
+ \lineiii{moduleName}{value of \code{name}}{}
+ \lineiii{externalName}{\code{externalNameForInternalName(name)}}{}
+ \lineiii{isAbstract}{\code{0}}{}
+ \lineiii{isReadOnly}{\code{0}}{}
+ \lineiii{properties}{\code{[]}}{Sequence of \class{Attribute} and
+ \class{Relationship} objects}
+ \lineiii{parent}{\code{''}}{The name of its parent entity (inheritance)}
+ \lineiii{typeName}{\code{''}}{}
+ \lineiii{doc}{\code{''}}{comment}
+ \end{longtableiii}
+ \begin{notice}
+ For details about these properties and their meaning, please refer
+ to~\ref{entity-props}.
+ \end{notice}
+ 
+ %%
  \subsection{Attribute\label{pymodel-attribute-props}}

! \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
! \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
! arguments when instanciating a \class{Attribute}. Once set, it should not be
! changed}
! \lineiii{columnName}{\code{externalNameForInternalName(name)}}{}
! \lineiii{type}{\code{'int'}}{}
! \lineiii{externalType}{\code{'INTEGER'}}{}
! \lineiii{isClassProperty}{\code{1}}{}
! \lineiii{isRequired}{\code{0}}{}
! \lineiii{precision}{\code{0}}{}
! \lineiii{width}{\code{0}}{}
! \lineiii{scale}{\code{0}}{}
! \lineiii{defaultValue}{\code{None}}{}
! \lineiii{usedForLocking}{\code{0}}{}
! \lineiii{displayLabel}{\code{''}}{}
! \lineiii{doc}{\code{''}}{comment}
! \end{longtableiii}

! \begin{notice}
! For details about these properties and their meaning, please refer
! to~\ref{attributes-props}.
! \end{notice}

! %%
! \subsubsection{ADateTime\label{pymodel-attribute-props-datetime}}

! The component \class{ADateTime} redefines the following defaults:
! 
! \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
! \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
! arguments when instanciating a \class{Attribute}. Once set, it should not be
! changed}
! \lineiii{type}{\code{'DateTime'}}{}
! \lineiii{externalType}{\code{TIMESTAMP}}{Be warned: not all database supports
! \code{TIMESTAMP}. If this is the case, you'll probably have to redefine this
! default value in your PyModel. Discussion on supported SQL datatypes can be
! found at section~\ref{attributes-props}.}
! \lineiii{defaultValue}{\code{None}}{}
! \lineiii{usedForLocking}{\code{1}}{}
! \end{longtableiii}
! 
! \begin{notice}
! For details about these properties and their meaning, please refer
! to~\ref{attributes-props}.
! \end{notice}
! 
! %%
! \subsubsection{AFloat\label{pymodel-attribute-props-float}}
! 
! The component \class{AFloat} redefines the following defaults:
! 
! \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
! \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
! arguments when instanciating a \class{Attribute}. Once set, it should not be
! changed}
! \lineiii{type}{\code{'string'}}{}
! \lineiii{externalType}{\code{'NUMERIC'}}{}
! \lineiii{precision}{\code{15}}{}
! \lineiii{scale}{\code{5}}{}
! \lineiii{defaultValue}{\code{0.0}}{}
! \lineiii{usedForLocking}{\code{1}}{}
! \end{longtableiii}
! 
! \begin{notice}
! For details about these properties and their meaning, please refer
! to~\ref{attributes-props}.
! \end{notice}
! 
! %%
! \subsubsection{AInteger\label{pymodel-attribute-props-integer}}
! 
! The component \class{AFloat} redefines the following defaults:

+ \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
+ \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
+ arguments when instanciating a \class{Attribute}. Once set, it should not be
+ changed}
+ \lineiii{type}{\code{'int'}}{}
+ \lineiii{externalType}{\code{'INTEGER'}}{}
+ \lineiii{defaultValue}{\code{0}}{}
+ \lineiii{usedForLocking}{\code{1}}{}
+ \end{longtableiii}
+ 
+ \begin{notice}
+ For details about these properties and their meaning, please refer
+ to~\ref{attributes-props}.
+ \end{notice}
+ 
+ %%
+ \subsubsection{AString\label{pymodel-attribute-props-string}}
+ 
+ The component \class{AFloat} redefines the following defaults:
+ 
+ \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
+ \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
+ arguments when instanciating a \class{Attribute}. Once set, it should not be
+ changed}
+ \lineiii{type}{\code{'string'}}{No matter whether you run python2.1 (where
+ \code{type('').__name__=='string'}) or python2.2 (where
+ \code{type('').__name__=='str'}), you should always use 'string' for a
+ character type.
+ \lineiii{externalType}{\code{'VARCHAR'}}{}
+ \lineiii{width}{\code{255}}{}
+ \lineiii{defaultValue}{\code{''}}{}
+ \lineiii{usedForLocking}{\code{1}}{}
+ \end{longtableiii}
+ 
+ \begin{notice}
+ For details about these properties and their meaning, please refer
+ to~\ref{attributes-props}.
+ \end{notice}
+ 
+ %%
+ \subsubsection{APrimaryKey\label{pymodel-attribute-props-primary-key}}
+ 
+ The component \class{AFloat} redefines the following defaults:
+ 
+ \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
+ \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
+ arguments when instanciating a \class{Attribute}. Once set, it should not be
+ changed}
+ \lineiii{isClassProperty}{\code{0}}{}
+ \lineiii{isRequired}{\code{1}}{You should not change this default, nor
+ overwrite it: a primary key should be mandatory.}
+ \lineiii{defaultValue}{\code{}}{}
+ \lineiii{doc}{\code{'Primary Key'}}{}
+ \lineiii{usedForLocking}{\code{0}}{}
+ \end{longtableiii}
+ 
+ \begin{notice}
+ For details about these properties and their meaning, please refer
+ to~\ref{attributes-props}.
+ \end{notice}
+ 
+ %%
+ \subsubsection{AForeignKey\label{pymodel-attribute-props-foreign-key}}
+ 
+ The component \class{AFloat} redefines the following defaults:
+ 
+ \begin{longtableiii}{p{3cm}p{4cm}p{7cm}}{code}{Prop.}{Default}{Comment}
+ \lineiii{name}{\emph{no default}}{The \code{name} is the only mandatory
+ arguments when instanciating a \class{Attribute}. Once set, it should not be
+ changed}
+ \lineiii{isClassProperty}{\code{0}}{}
+ \lineiii{isRequired}{\code{0}}{}
+ \lineiii{defaultValue}{\code{None}}{}
+ \lineiii{doc}{\code{'Foreign Key'}}{}
+ \lineiii{usedForLocking}{\code{0}}{}
+ \end{longtableiii}
+ 
+ \begin{notice}
+ For details about these properties and their meaning, please refer
+ to~\ref{attributes-props}.
+ \end{notice}
+ 
+ %%
  \subsection{Association\label{pymodel-association-props}}

  tbd. 

+ %%
+ \subsection{Relationship\label{pymodel-relationship-props}}
+ 
+ tbd.
+ 
+ %%
+ \subsubsection{RToOne\label{pymodel-relationship-props-toone}}
+ 
+ tbd.
+ 
+ %%
+ \subsubsection{RToMany\label{pymodel-relationship-props-tomany}}
+ 
+ tbd.
+ 
+ 
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! \section{{\sc Xml} model\label{model-xml-format}}

  \subsection{Overview of the xml\label{model-xml-format-overview}}