[elvystrac] r1690 - documentation updated
- From: elvys@xxxxxxxxxxxxxxxxxxxxxx
- To: elvystrac@xxxxxxxxxxxxx
- Date: Tue, 9 Feb 2010 20:27:40 +0100
Author: DavidK
Date: 2010-02-09 20:27:40 +0100 (Tue, 09 Feb 2010)
New Revision: 1690
Modified:
others/dokumentace/technicalGuide/architecture/4webapp.tex
others/dokumentace/technicalGuide/architecture/5layoutdesigner.tex
others/dokumentace/technicalGuide/architecture/7communication.tex
others/dokumentace/technicalGuide/architecture/8deployment.tex
others/dokumentace/technicalGuide/architecture/9tools.tex
others/dokumentace/technicalGuide/architecture/9z10appendix.tex
Log:
documentation updated
Modified: others/dokumentace/technicalGuide/architecture/4webapp.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/4webapp.tex 2010-02-09
17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/4webapp.tex 2010-02-09
19:27:40 UTC (rev 1690)
@@ -37,6 +37,11 @@
Tělo většiny zpráv posílaných přes internet je tvořeno XML dokumentem
nesoucím určitá data.
Všechny komplexnější XML\footnote{Extensible Markup Language (XML),
\url{http://www.w3.org/XML/}} dokumenty (např. jakýkoliv XXXConfig přenášený ze
serveru na kiosek) mají
definován formát pomocí jazyka XML Schema\footnote{XML Schema language,
\url{http://www.w3.org/XML/Schema}}
+
+ \subsubsection{JAXB}
+ JAXB generuje \\
+
+ Při změně XSD souboru je nutné znovu vygenerovat třídy pomocí ANT
skriptu [DOPLNIT]
\subsection{Technologie Java Servlet}
[DO KAP.4 mozna]
@@ -49,8 +54,8 @@
V tomto modulu se nachází sdílený kód a sdílené zdroje, které používá
jak projekt webServer2, tak projekt dispatcher.
\subsection{LayoutDesigner} Jedná se o java applet, grafický editor, který
je součástí webové
aplikace (konkrétně tedy aplikace webServer2) a umožňuje uživateli
navrhovat
- rozvržení obrazovek pro kiosky. Podobněji se architekturou tohoto editoru
zabývá \textit{kapitola \ref{LD} (\pageref{LD})}.
- Komunikaci mezi webovým serverem a editorem LayoutDesigner potom popisuje
\textit{kapitola \ref{interface_web_and_LD} (\pageref{interface_web_and_LD})}.
+ rozvržení obrazovek pro kiosky. Podobněji se architekturou tohoto editoru
zabývá \textit{kapitola \ref{LD} (str. \pageref{LD})}.
+ Komunikaci mezi webovým serverem a editorem LayoutDesigner potom popisuje
\textit{kapitola \ref{interface_web_and_LD} (str.
\pageref{interface_web_and_LD})}.
@@ -58,14 +63,34 @@
%% DB, ORM
%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Databázový model a databáze}
-napsat, co se pouziva za DB
+ \subsection{Databáze}
+ Při diskuzi, který databázový stroj pro serverovou část řešení ELVYS zvolit,
rozhodovali se autoři mezi následujícími:
+ \begin{itemize}
+ \item textbf{Oracle Database 10g či 11g} \footnote{Oracle Database 11g,
} TODO
+ \item textbf{Microsoft SQL Server 2008}\footnote{Microsoft SQL Server
2008, \url{http://www.microsoft.com/sqlserver/2008/}} TODO
+ \item textbf{PostgreSQL}\footnote{PostgreSQL,
\url{http://www.postgresql.org/}} TODO
+ \item textbf{MySQL 5.1, community edition}\footnote{MySQL,
\url{http://dev.mysql.com/doc/refman/5.1/en/}} TODO
+ \end{itemize}
+ Jako databázový stroj byl pro serverovou část řešení ELVYS zvolen MySQL
server a to z důvodu, že s ním mají autoři bohaté
+ zkušenosti, je relativně výkonná a spolehlivá. Pro vývoj je tato databáze
plně postačující a díky použití Hibernate ORM nástroje
+ je možné elegantně přejít na jinou databázovou technologii v případě potřeby.
- \subsection{popis datového modelu}
- \subsection{popis 'ORM' frameworku Hibernate}\label{hibernate}
+
+ \subsection{Popis datového modelu}
+ Detailní datový model je k nalezení v \textit{příloze
\ref{appendix_DB_model} (str. \pageref{appendix_DB_model})}.
+ Následuje seznam tabulek s vysvětlením jejich smyslu.
+ \begin{description}
+ \item \textbf{TODO}
+ \end{description}
+
+
+ \subsection{Popis 'ORM' frameworku Hibernate}\label{hibernate_popis}
- \subsection{nastavení hibernate}
+ \subsection{Nastavení hibernate}
+
+ \subsection{Získání hibernate tříd}
\begin{itemize}
\item vygenerování .hbm.xml mapování z DB modelu
\item ruční úprava(přidání dědičnosti, doplnění vlastního kódu)
Modified: others/dokumentace/technicalGuide/architecture/5layoutdesigner.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/5layoutdesigner.tex
2010-02-09 17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/5layoutdesigner.tex
2010-02-09 19:27:40 UTC (rev 1690)
@@ -1,4 +1,4 @@
-\chapter{LayoutDesigner java applet}\ref{LD}
+\chapter{LayoutDesigner java applet}\label{LD}
\textbf{Datové struktury}
\\
Modified: others/dokumentace/technicalGuide/architecture/7communication.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/7communication.tex
2010-02-09 17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/7communication.tex
2010-02-09 19:27:40 UTC (rev 1690)
@@ -63,7 +63,7 @@
\end{itemize}
- Více o architektuře aplikace dispatcher je k nalezení v \textit{kapitole
\ref{webapp_dispatcher}, str. \pageref{webapp_dispatcher}}.
+ Více o architektuře aplikace dispatcher je k nalezení v \textit{kapitole
\ref{webapp_architecture_dispatcher} (str.
\pageref{webapp_architecture_dispatcher})}.
@@ -83,25 +83,36 @@
TODO tato sekce
\begin{description}
- \item[Upload obrázku obrazovky kiosku]
+ \item[Upload obrázku obrazovky kiosku] TODO \\
Tato metoda slouží k uplaodu obrázku obrazovky kiosku na server.
Obrázek je poslán....
\begin{description}
\item[parametry] -
\item[useragent] screenshot<elvysID>
\item[odpověď] -
\end{description}
- \item[Generování categoryConfig]
+
+ \item[Generování appConfig] TODO \\
+ XSD popis generovaných dat je k nalezení v \textit{příloze
\ref{appendix_appConfig}}
+
+
+ \item[Generování categoryConfig] TODO \\
Tato metoda slouží k vygenerování categoryConfig konfiguračního
souboru pro klienta...
\textbf{Detailní popis vygenerované zprávy:}\\
- categoryConfig obsahuje informace o ..\\
- odpovídající XSD popis \textbf{categoryConfig.xsd} lze nalézt v
příloze\ref{appendix_categoryConfig.xsd}
+ categoryConfig obsahuje informace o ..
+
+ XSD popis generovaných dat je k nalezení v \textit{příloze
\ref{appendix_categoryConfig}}
- \item[Generování appConfig]
+ \item[Generování documentConfig] TODO \\
+ XSD popis generovaných dat je k nalezení v \textit{příloze
\ref{appendix_documentConfig}}
+
+ \item[Generování filecacheConfig] TODO \\
+ XSD popis generovaných dat je k nalezení v \textit{příloze
\ref{appendix_filecacheConfig}}
- \item[Generování documentConfig]
- \item[Generování]
+ \item[Generování layoutConfig] TODO \\
+ XSD popis generovaných dat je k nalezení v \textit{příloze
\ref{appendix_layoutConfig}}
+
Modified: others/dokumentace/technicalGuide/architecture/8deployment.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/8deployment.tex
2010-02-09 17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/8deployment.tex
2010-02-09 19:27:40 UTC (rev 1690)
@@ -1,15 +1,17 @@
%subject to change
\chapter{Konfigurace, nasazení řešení a závislosti}
-Celé řešení Elvys sestává ze serverové části(rozdělená na více modulů) a
klientské části.
-Popsat tady jak se toele nasazuje c
+Tato kapitola popisuje, jak se celé řešení elvys sestaví, nasadí a na čem jsou
jednotlivé
+části závislé (při sestavování, tak při běhu).\\
+Celé řešení Elvys sestává ze serverové části(rozdělená na více aplikací) a z
klientské části (kiosky). \\
+Schema nasazení (deployment diagram) kompletního řešení je \textit{na obrázku
\ref{img.deployment_img_big}}.
\begin{figure}
- \label{deployment_img}
\begin{center}
\includegraphics[width=0.95\textwidth]{imgs/Deployment.png}
\end{center}
\caption{Schéma nasazení řešení ELVYS}
+ \label{img.deployment_img_big}
\end{figure}
\section{Webový server - aplikace}
Modified: others/dokumentace/technicalGuide/architecture/9tools.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/9tools.tex 2010-02-09
17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/9tools.tex 2010-02-09
19:27:40 UTC (rev 1690)
@@ -1,8 +1,31 @@
\chapter{Nástroje použité při vývoji}
+V této sekci je uveden seznam nástrojů použitých při práci na projektu ELVYS.
+
% svn, trac, hudson....
+ \subsection{Vývojové nástroje}
+ \subsubsection{JBoss Developer Studio 2.0.0.GA}
(\url{http://www.jboss.com/products/devstudio/})
+ \subsubsection{Eclipse 3.5} (\url{http://www.eclipse.org/eclipse/})
+ \subsubsection{aa} (\url{aa})
+ \subsubsection{aa} (\url{aa})
+
+
+ \subsection{Databázové nástroje, databáze}
+ \subsubsection{MySQL 5.1.x} {\url{http://dev.mysql.com/doc/refman/5.1/en/}}
+ \subsubsection{Power Designer 12}
(\url{http://www.sybase.com/products/modelingdevelopment/powerdesigner})
+ \subsubsection{Oracle SQL Developer}
(\url{http://www.oracle.com/technology/products/database/sql_developer/index.html})
+ \subsubsection{phpMyAdmin}
(\url{http://www.phpmyadmin.net/home_page/index.php})
+
+ \subsection{Nástroje na vytváření dokumentů}
+ \subsubsection*{TeX}
+ \subsubsection*{Enterprise Architect 7} (\url{aaa})
+
+
-\begin{thebibliography}{9}
+
+
+
+\begin{thebibliography}{10}
\bibitem{pdfcreator} \textbf{PDF Creator}
http://sourceforge.net/projects/pdfcreator/
\bibitem{googlebooks} \textbf{Google Books} http://books.google.com
\bibitem{flashpaper} \textbf{Flashpaper}
http://www.adobe.com/products/flashpaper/
Modified: others/dokumentace/technicalGuide/architecture/9z10appendix.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/9z10appendix.tex
2010-02-09 17:01:28 UTC (rev 1689)
+++ others/dokumentace/technicalGuide/architecture/9z10appendix.tex
2010-02-09 19:27:40 UTC (rev 1690)
@@ -4,3 +4,9 @@
\begin{center}
\includegraphics[width=1\textwidth]{imgs/dbschema.png}
\end{center}
+\chapter{XSD pro komunikaci}
+ \section{appConfig.xsd}\label{appendix_appConfig}
+ \section{categoryConfig.xsd}\label{appendix_categoryConfig}
+ \section{documentConfig.xsd}\label{appendix_documentConfig}
+ \section{filecacheConfig.xsd}\label{appendix_filecacheConfig}
+ \section{layoutConfig.xsd}\label{appendix_layoutConfig}
\ No newline at end of file
Other related posts:
- » [elvystrac] r1690 - documentation updated - elvys
