empire-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rei...@apache.org
Subject svn commit: r681719 [2/10] - in /incubator/empire-db/site: ./ community/ css/ documentation/ downloads/ empiredb/ images/ images/diagrams/ images/logos/ images/mail/ images/menu/ javadocs/ js/ struts2ext/ support/
Date Fri, 01 Aug 2008 15:15:29 GMT
Added: incubator/empire-db/site/documentation/api.htm
URL: http://svn.apache.org/viewvc/incubator/empire-db/site/documentation/api.htm?rev=681719&view=auto
==============================================================================
--- incubator/empire-db/site/documentation/api.htm (added)
+++ incubator/empire-db/site/documentation/api.htm Fri Aug  1 08:15:26 2008
@@ -0,0 +1,212 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-gb" lang="en-gb" >
+<!-- #BeginTemplate "../main.dwt" -->
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+	<meta http-equiv="language" content="en" />
+	<meta name="robots" content="index, follow" />
+	<meta name="keywords" content="java, jar, jdbc, sql, data, metadata, persistence, rdbms, orm, mapping" />
+	<meta name="description" content="Open Source relational data persistence component." />
+	
+	<!-- #BeginEditable "doctitle" -->
+<title>Empire-db - API</title>
+	<!-- #EndEditable -->
+	
+	<script type="text/javascript" src="../js/prototype.js"></script>
+	<script type="text/javascript" src="../js/menu.js"></script>
+	<!-- #BeginEditable "javascripts" -->
+	<!-- #EndEditable -->
+	
+	<link rel="shortcut icon" href="../empire-db.ico" />
+	<link rel="stylesheet" href="../css/layout.css" type="text/css" />
+	<!-- #BeginEditable "stylesheets" -->
+	<!-- #EndEditable -->
+</head>
+
+<body>
+<div id="wrapper">
+
+	<!-- Header -->
+	<div id="header">
+		<div id="logo">
+			<img src="../images/logos/empire-db-logo.gif" alt="Empire-db: The relational data persistence component." />
+		</div>
+		<div id="asf">
+			<a target="_blank" href="http://incubator.apache.org/">
+			<img src="../images/logos/apache-incubator-logo.png" alt="Apache Incubator" /></a>
+		</div>
+		<div style="clear:both"></div>
+	</div>
+	
+	<!-- Top -->
+	<div id="top">
+		<div id="topbar">&nbsp;</div>
+	</div>
+	
+	<!-- Middle -->
+	<div id="middle">
+		<div id="left">    
+				<div id="menuBox">     
+					<ul id="mainMenu">
+						<li id="menu_home"><a href="../index.html">Home</a></li>
+						<li id="menu_news"><a href="../news.htm">News</a></li>
+						<li id="menu_empiredb">
+						<a href="../empiredb/empiredb.htm">Empire-db</a>
+								<ul class="subMenu">
+									<li id="menu_empiredb_extending_pattern">
+									<a href="../empiredb/pattern.htm">The Empire DAO-<br />pattern</a></li>
+									<li id="menu_empiredb_handling_metadata">
+									<a href="../empiredb/metadata.htm">Handling data and metadata</a></li>
+									<li id="menu_empiredb_wrong">
+									<a href="../empiredb/hibernate.htm">What's wrong with Hibernate and JPA</a></li>
+									<li id="menu_empiredb_stringfree">
+									<a href="../empiredb/stringfree.htm">The principle of<br/>string-free coding</a></li>
+									<li id="menu_empiredb_faq">
+									<a href="../empiredb/faq.htm">FAQ</a></li>
+								</ul>
+						</li>
+						<li id="menu_struts2ext">
+						<a href="../struts2ext/struts2ext.htm">Empire-db and Struts2</a>
+							<ul class="subMenu">
+								<li id="menu_struts2ext_forms_controls">
+								<a href="../struts2ext/forms_controls.htm">Forms and controls</a></li>
+								<li id="menu_struts2ext_rendering_parsing">
+								<a href="../struts2ext/rendering_parsing.htm">Rendering and parsing</a></li>
+								<!--<li id="menu_struts2ext_tag_reference"><a href="struts2ext/tag_reference.htm">Tag reference</a></li>-->
+								<li id="menu_struts2ext_input_controls">
+								<a href="../struts2ext/input_controls.htm">Input controls</a></li>
+							</ul>
+						</li>
+						<li id="menu_downloads">
+						<a href="../downloads/downloads.htm">Downloads</a>
+								<ul class="subMenu">
+									<li id="menu_downloads_license">
+									<a href="../downloads/license.htm">License</a></li>
+								</ul>
+						</li>
+						<li id="menu_documentation"><a href="documentation.htm">Documentation</a>					
+							<ul class="subMenu">
+								<li id="menu_documentation_class_overview">
+								<a href="class_overview.htm">Empire-db class<br />overview</a></li>
+								<li id="menu_documentation_tutorials">
+								<a href="tutorial.htm">Tutorial</a></li>
+								<li id="menu_documentation_getting_started">
+								<a href="getting_started.htm">Getting started</a></li>
+								<li id="menu_documentation_api">
+								<a href="api.htm">API</a></li>
+							</ul>
+						</li>
+						<li id="menu_community">
+						<a href="../community/community.htm">Community</a>					
+							<ul class="subMenu">
+								<li id="menu_community_mailing_lists">
+								<a href="../community/mailing_lists.htm">Mailing lists</a></li>
+								<!--<li id="menu_community_source_code"><a href="community/source_code.htm">Source code</a></li>-->
+								<li id="menu_community_jira">
+								<a href="../community/jira.htm">Ticketing system</a></li>
+								<!--<li id="menu_community_road_map"><a href="community/road_map.htm">Road map</a></li>-->
+								<li id="menu_community_contributors">
+								<a href="../community/contributors.htm">Contributors</a></li>
+							</ul>
+						</li>
+						<li id="menu_disclaimer"><a href="../disclaimer.htm">Disclaimer</a></li>
+					</ul>
+				</div>
+				
+		</div>
+	
+		<!-- #BeginEditable "menu" -->	
+	<script type="text/javascript">
+		var menu = new Menu( 'mainMenu', 'menu_documentation', 'menu_documentation_api' );
+		var prev_page = "getting_started.htm";
+	</script>
+		<!-- #EndEditable -->
+		<script type="text/javascript">
+			/* <![CDATA[ */
+			if( menu ) {
+				// Menu fully opened (comment out if not wanted)
+				// menu.openAll();
+			/* ]]> */
+			}
+		</script>
+	
+		<div id="main">		
+			
+			<div id="pathway">
+			<!-- #BeginEditable "pathway" -->
+	        	<a href="documentation.htm">Documentation</a> &raquo; API
+	        <!-- #EndEditable -->
+	        </div>
+			
+			<div id="content">
+			<!-- #BeginEditable "content" -->
+		<!--<h1>Application Programming Interface</h1>-->
+		<h1>Empire-db API</h1>
+		<p>Click <a href="../javadocs/empire-db/index.html" target="_blank">here</a> to read the API documentation of the Empire-db relational data persistence component. 
+		The API documentation is also provided with the Empire-db distribution 
+		package which can be found in the download section.</p>
+		<p><a href="../javadocs/empire-db/index.html" target="_blank">to the API....   <img src="../images/next.gif" alt="" /></a></p>
+<!--		<h1>Empire Struts2 Extension API</h1>
+		<p><a href="../javadocs/empireStruts2Ext/index.html" target="_blank">to the API....   <img src="../images/next.gif" alt="" /></a></p>-->
+			<!-- #EndEditable --></div>
+					
+			<div id="nav">
+				<hr />
+				<div id="nav_prev">
+					<a id="prev" href=""><img src="../images/prev.gif" alt="" /> Previous Page</a> 
+					&nbsp;
+				</div>
+				<div id="nav_next">
+					&nbsp;
+					<a id="next" href="">Next Page 
+					<img src="../images/next.gif" alt="" /></a>
+				</div>
+				<div style="clear: both;"></div>
+			</div>
+			
+			<script type="text/javascript">
+			/* <![CDATA[ */
+				if( ( typeof(prev_page) == "undefined" || prev_page == "" ) &&
+					( typeof(next_page) == "undefined" || next_page == "" ) ) 
+				{
+					$( 'nav' ).hide();
+				}
+				else 
+				{			
+					if( typeof(prev_page) != "undefined" && prev_page != "" ) {
+						$( 'prev' ).href = prev_page;
+						$( 'prev' ).show();
+					}
+					else {
+						$( 'prev' ).hide();
+					}
+					
+					if( typeof(next_page) != "undefined" && next_page !="" ) {
+						$( 'next' ).href = next_page;
+						$( 'next' ).show();
+					}
+					else {
+						$( 'next' ).hide();
+					}
+				}
+			/* ]]> */
+			</script>
+
+		</div>
+
+	</div>
+	
+	<!-- Footer -->		
+	<div id="footer">
+		<small>Copyright &copy; 2008, The Apache Software Foundation</small>&nbsp;<!--<p style="padding-right: 25px; text-align: right;">
+	    <a href="http://validator.w3.org/check?uri=referer">
+		<img
+	        src="images/valid-xhtml10.png"
+	        alt="Valid XHTML 1.0 Transitional" height="31" width="88" /></a>
+	 	</p>--></div>
+
+</div>
+
+</body>
+<!-- #EndTemplate -->
+</html>
\ No newline at end of file

Propchange: incubator/empire-db/site/documentation/api.htm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/empire-db/site/documentation/class_overview.htm
URL: http://svn.apache.org/viewvc/incubator/empire-db/site/documentation/class_overview.htm?rev=681719&view=auto
==============================================================================
--- incubator/empire-db/site/documentation/class_overview.htm (added)
+++ incubator/empire-db/site/documentation/class_overview.htm Fri Aug  1 08:15:26 2008
@@ -0,0 +1,336 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-gb" lang="en-gb" >
+<!-- #BeginTemplate "../main.dwt" -->
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+	<meta http-equiv="language" content="en" />
+	<meta name="robots" content="index, follow" />
+	<meta name="keywords" content="java, jar, jdbc, sql, data, metadata, persistence, rdbms, orm, mapping" />
+	<meta name="description" content="Open Source relational data persistence component." />
+	
+	<!-- #BeginEditable "doctitle" -->
+<title>Empire-db - Class overview</title>
+	<!-- #EndEditable -->
+	
+	<script type="text/javascript" src="../js/prototype.js"></script>
+	<script type="text/javascript" src="../js/menu.js"></script>
+	<!-- #BeginEditable "javascripts" -->
+	<!-- #EndEditable -->
+	
+	<link rel="shortcut icon" href="../empire-db.ico" />
+	<link rel="stylesheet" href="../css/layout.css" type="text/css" />
+	<!-- #BeginEditable "stylesheets" -->
+<style type="text/css">
+<!-- Wegen großem Bild muss Mindestbreite erhöht werden -->
+</style>
+	<!-- #EndEditable -->
+</head>
+
+<body>
+<div id="wrapper">
+
+	<!-- Header -->
+	<div id="header">
+		<div id="logo">
+			<img src="../images/logos/empire-db-logo.gif" alt="Empire-db: The relational data persistence component." />
+		</div>
+		<div id="asf">
+			<a target="_blank" href="http://incubator.apache.org/">
+			<img src="../images/logos/apache-incubator-logo.png" alt="Apache Incubator" /></a>
+		</div>
+		<div style="clear:both"></div>
+	</div>
+	
+	<!-- Top -->
+	<div id="top">
+		<div id="topbar">&nbsp;</div>
+	</div>
+	
+	<!-- Middle -->
+	<div id="middle">
+		<div id="left">    
+				<div id="menuBox">     
+					<ul id="mainMenu">
+						<li id="menu_home"><a href="../index.html">Home</a></li>
+						<li id="menu_news"><a href="../news.htm">News</a></li>
+						<li id="menu_empiredb">
+						<a href="../empiredb/empiredb.htm">Empire-db</a>
+								<ul class="subMenu">
+									<li id="menu_empiredb_extending_pattern">
+									<a href="../empiredb/pattern.htm">The Empire DAO-<br />pattern</a></li>
+									<li id="menu_empiredb_handling_metadata">
+									<a href="../empiredb/metadata.htm">Handling data and metadata</a></li>
+									<li id="menu_empiredb_wrong">
+									<a href="../empiredb/hibernate.htm">What's wrong with Hibernate and JPA</a></li>
+									<li id="menu_empiredb_stringfree">
+									<a href="../empiredb/stringfree.htm">The principle of<br/>string-free coding</a></li>
+									<li id="menu_empiredb_faq">
+									<a href="../empiredb/faq.htm">FAQ</a></li>
+								</ul>
+						</li>
+						<li id="menu_struts2ext">
+						<a href="../struts2ext/struts2ext.htm">Empire-db and Struts2</a>
+							<ul class="subMenu">
+								<li id="menu_struts2ext_forms_controls">
+								<a href="../struts2ext/forms_controls.htm">Forms and controls</a></li>
+								<li id="menu_struts2ext_rendering_parsing">
+								<a href="../struts2ext/rendering_parsing.htm">Rendering and parsing</a></li>
+								<!--<li id="menu_struts2ext_tag_reference"><a href="struts2ext/tag_reference.htm">Tag reference</a></li>-->
+								<li id="menu_struts2ext_input_controls">
+								<a href="../struts2ext/input_controls.htm">Input controls</a></li>
+							</ul>
+						</li>
+						<li id="menu_downloads">
+						<a href="../downloads/downloads.htm">Downloads</a>
+								<ul class="subMenu">
+									<li id="menu_downloads_license">
+									<a href="../downloads/license.htm">License</a></li>
+								</ul>
+						</li>
+						<li id="menu_documentation"><a href="documentation.htm">Documentation</a>					
+							<ul class="subMenu">
+								<li id="menu_documentation_class_overview">
+								<a href="class_overview.htm">Empire-db class<br />overview</a></li>
+								<li id="menu_documentation_tutorials">
+								<a href="tutorial.htm">Tutorial</a></li>
+								<li id="menu_documentation_getting_started">
+								<a href="getting_started.htm">Getting started</a></li>
+								<li id="menu_documentation_api">
+								<a href="api.htm">API</a></li>
+							</ul>
+						</li>
+						<li id="menu_community">
+						<a href="../community/community.htm">Community</a>					
+							<ul class="subMenu">
+								<li id="menu_community_mailing_lists">
+								<a href="../community/mailing_lists.htm">Mailing lists</a></li>
+								<!--<li id="menu_community_source_code"><a href="community/source_code.htm">Source code</a></li>-->
+								<li id="menu_community_jira">
+								<a href="../community/jira.htm">Ticketing system</a></li>
+								<!--<li id="menu_community_road_map"><a href="community/road_map.htm">Road map</a></li>-->
+								<li id="menu_community_contributors">
+								<a href="../community/contributors.htm">Contributors</a></li>
+							</ul>
+						</li>
+						<li id="menu_disclaimer"><a href="../disclaimer.htm">Disclaimer</a></li>
+					</ul>
+				</div>
+				
+		</div>
+	
+		<!-- #BeginEditable "menu" -->	
+		<script type="text/javascript">
+			var menu = new Menu( 'mainMenu', 'menu_documentation', 'menu_documentation_class_overview' );
+			var next_page = "tutorial.htm";
+		</script>
+		<!-- #EndEditable -->
+		<script type="text/javascript">
+			/* <![CDATA[ */
+			if( menu ) {
+				// Menu fully opened (comment out if not wanted)
+				// menu.openAll();
+			/* ]]> */
+			}
+		</script>
+	
+		<div id="main">		
+			
+			<div id="pathway">
+			<!-- #BeginEditable "pathway" -->
+	        	<a href="documentation.htm">Documentation</a> &raquo; Empire-db class overview
+	        <!-- #EndEditable -->
+	        </div>
+			
+			<div id="content">
+			<!-- #BeginEditable "content" -->
+			<h1>Empire class overview</h1>
+			<p>	To help you working with Empire-db this document gives you an overview of the most 
+				important Empire-db classes and how to apply them in your application.</p>
+			<p> The following chart shows very simplified in the top section (yellow) the most 
+				important Empire-db classes and their relationships. In the bottom section (orange) 
+				you see which classes you should extend in order to define your data model. All other 
+				Empire-db classes are usually used directly rather than extended unless you need to 
+				override their behavior.</p>
+			<img style="display: block; margin: auto;" src="../images/diagrams/empire-db-class-chart.gif" alt="Empire-db class chart"/>
+
+			<h1>DBDatabase</h1>			
+			<p> The database class is your root interface for accessing the data model description 
+				(i.e. the metadata) as well as for creating command objects and directly executing 
+				statements. In order to use this class you should extend it with your own database 
+				class in which you define all tables, views and relations. To make static references 
+				to your tables and views from your code you should provide a public final property for 
+				each table and view.</p>
+			<p> The <code>tables</code>, <code>views</code> and <code>relations</code> properties are collections for the corresponding 
+				object types. These collections may be used to write generic code like e.g. for data 
+				synchronization purposes.</p>	
+			<p> Before using any of the methods on DBDatabase the database must be opened using the 
+				open method. For this you will require an instance of a DBDatabaseDriver for the 
+				target DBMS (not shown here).</p>	
+			<p> Use the <code>createCommand()</code> method to obtain a DBCommand object for the target DBMS. 
+				Use this to dynamically create portable select, insert, update and delete statements.</p>
+			<p> Use <code>executeSQL()</code> to execute an SQL insert, update or delete statement.</p>
+			<p> Use <code>querySingleValue()</code> or any other of the query functions to perform simple queries 
+				without the overhead of using a DBReader.</p>
+				
+			<h1>DBTable / DBView</h1>
+			<p> The DBTable and DBView classes are used to describe the corresponding database object. 
+				You should first create one class for every single table and view in your data model and 
+				name the class accordingly. In the constructor you should add all columns using the <code>addColumn()</code>
+				method and in order to make static references to your columns from your 
+				code you should provide a public final property for each column. For tables you 
+				should additionally provide a primary key by calling 
+			    <code>setPrimaryKey()</code>.</p>
+			<p> Create an instance of each class in your DBDatabase derived class and assign it to a 
+				public final property as described above.</p>
+			
+			<h1>DBRecord</h1>
+			<p> The DBRecord class holds the data of one database entity i.e. of a single row in one 
+				of the database's tables or views. An instance of DBRecord can be used with any table 
+				or view and hence extending it is not required. However we still recommend 
+			to extend DBRecord and create an individual class for each of your 
+			entities 
+				for two reasons: first there is type-safety, since you want your internal code to rely 
+				on certain entities and second it is likely that, as your project grows, you will need 
+				to override existing and implement new methods there. Initially you 
+			can leave them empty i.e. without any declared properties or methods.</p>
+			<p> Use the <code>getValue()</code> and <code>setValue()</code> methods to obtain and modify record data.<br />
+				Use the <code>isNew()</code> and <code>isModified()</code> properties to evaluate a record's state or use the 
+				<code>getColumn()</code> method to obtain field meta data.</p>
+			<p> The methods <code>create()</code>, <code>read()</code>, <code>update()</code> and <code>delete()</code> 
+				are provided here for convenience. 
+				However they are only proxies. The implementation code resides in the corresponding 
+				DBRowSet derived object i.e. DBTable or DBView. So in order to changing or extending 
+				their behavior you should consider overriding the corresponding DBRowSet method.</p>
+			
+			<h1>DBCommand</h1>
+			<p> The DBCommand class provides methods for the creation of SQL commands for select, insert, 
+				update and delete operations. To obtain a command object, first create a database 
+				object and call the open method with a DBDatabaseDriver instance for you target DBMS.</p>
+			<p> Use the <code>select()</code>, <code>join()</code>, <code>where()</code>, <code>having()</code>, 
+				<code>groupBy()</code>, <code>orderBy()</code> and <code>set()</code> methods 
+				to define your command. Use one of the various factory functions on the DBColumn and 
+				DBColumnExpr objects to perform data transformation or to create constraints. Here are 
+				a few examples:</p>
+			<pre><span style="color: #008000; ">//</span><span style="color: #008000; "> obtain command object from database</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">DBCommand cmd </span><span style="color: #000000; ">=</span><span style="color: #000000; "> db.createCommand();
+</span><span style="color: #008000; ">//</span><span style="color: #008000; "> select the first 3 characters from lastname, </span><span style="color: #008000; ">set FOO if null</span><span style="color: #008000; ">, make them upper case etc  </span><span style="color: #008000; ">
+</span><span style="color: #000000; ">cmd.select(EMPLOYEES.LASTNAME.coalesce(</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">foo</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">).upper().substring(</span><span style="color: #000000; ">0</span><span style="color: #000000; ">, </span><span style="color: #000000; ">3</span><span style="color: #000000; ">).as(</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">INDEX</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">));
+</span><span style="color: #008000; ">//</span><span style="color: #008000; "> left join with departments</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">cmd.join(DEPARTMENTS.DEPARTMENT_ID, EMPLOYEES.DEPARTMENT_ID, DBJoinType.LEFT);
+</span><span style="color: #008000; ">//</span><span style="color: #008000; "> Set contraint that length of lastname must be greater than 3</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">cmd.where(EMPLOYEES.LASTNAME.length().isGreaterThan(</span><span style="color: #000000; ">3</span><span style="color: #000000; ">));
+</span><span style="color: #008000; ">//</span><span style="color: #008000; "> order descending by Lastname</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">cmd.orderBy(EMPLOYEES.LASTNAME, </span><span style="color: #0000FF; ">true</span><span style="color: #000000; ">);
+</span><span style="color: #008000; ">//</span><span style="color: #008000; "> Set Lastname to Foo (for updates and inserts)</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">cmd.set(EMPLOYEES.LASTNAME.to(</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">Foo</span><span style="color: #000000; ">&quot;</span><span style="color: #000000; ">));</span></pre>
+
+			<p> After completing your command you can either perform a query by using a DBReader object 
+				or obtain an SQL command string for your target DBMS calling either <code>getSelect()</code>, 
+				<code>getUpdate()</code>, <code>getInsert()</code> or <code>getDelete()</code>. Pass this string either to the database 
+				object's <code>executeSQL()</code> method or any of the various query methods.</p>
+				
+			<h1>DBReader</h1>
+			<p> The DBReader class is used to perform a database query and access the result rows. To 
+				work with a DBReader first create a DBCommand object and define your query. Then use 
+				the DBCommand object with the DBReader's open method to perform the query. Afterwards 
+				you can do one of the following to obtain the query results:</p>
+			<ol>
+				<li>Iterate through the results using the <code>moveNext()</code> method or using an iterator 
+					obtainted by the <code>iterator()</code> function. With every call the reader's cursor will 
+					be moved one row forward. Use the <code>getValue()</code> or any of the other value getters such 
+					as <code>getString()</code>, <code>getBoolean()</code>, <code>getDate()</code> etc. 
+					to access field data for a given column expression or field index.</li>
+				<li>Use the <code>getBeanList()</code> method to obtain a list of POJO objects. The POJO class must 
+					have either property setters for each of the query result fields or it must have a 
+					suitable constructor which arguments match the fields of the query. To find a setter 
+					method, the reader calls <code>getBeanPropertyName()</code> for every column expression used in 
+					the query. If no special property name has been set, then the property name is built 
+					from the column name with an underscore acting as the word separator. For example for 
+					a column named <code>LAST_ANNUAL_SALARY</code> a setter named <code>setLastAnnualSalary()</code> is required.</li>
+				<li>Use the <code>getXMLDocument()</code> method to create a DOM document from the entire query result. 
+					This document will also include the field descriptions. Alternatively use the methods 
+					<code>addColumnDesc()</code> and <code>addRows()</code> to add the query results to an existing DOM element.</li>
+			</ol>
+			<p> Remember to always close a reader after it has been opened. We recommend using a try / 
+				finally block as follows:</p>
+			<pre><span style="color: #000000; ">DBReader reader </span><span style="color: #000000; ">=</span><span style="color: #000000; "> </span><span style="color: #0000FF; ">new</span><span style="color: #000000; "> DBReader();
+</span><span style="color: #0000FF; ">try</span><span style="color: #000000; ">
+{   </span><span style="color: #008000; ">//</span><span style="color: #008000; "> Open Reader</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">    reader.open(cmd, conn);
+    </span><span style="color: #008000; ">//</span><span style="color: #008000; "> Use Reader</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">    ...
+} </span><span style="color: #0000FF; ">finally</span><span style="color: #000000; ">
+{   </span><span style="color: #008000; ">//</span><span style="color: #008000; "> close Reader</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">    reader.close();
+}</span></pre>
+
+			<h1>Other hints</h1>
+			<p> For the case of an error Empire-db offers an option of whether to work with exceptions or 
+				method return values. Most Empire-db object methods return a Boolean value indicating 
+			success or failure. However this applies only if exceptions are switched 
+				off, which is the case by default. In order to enable exceptions please use the following 
+				code on application startup:</p>
+			<pre><span style="color: #008000; ">//</span><span style="color: #008000; "> Enable Exceptions</span><span style="color: #008000; ">
+</span><span style="color: #000000; ">de.esteam.empire.commons.ErrorObject.setExceptionsEnabled(</span><span style="color: #0000FF; ">true</span><span style="color: #000000; ">);</span></pre>
+			<!-- #EndEditable --></div>
+					
+			<div id="nav">
+				<hr />
+				<div id="nav_prev">
+					<a id="prev" href=""><img src="../images/prev.gif" alt="" /> Previous Page</a> 
+					&nbsp;
+				</div>
+				<div id="nav_next">
+					&nbsp;
+					<a id="next" href="">Next Page 
+					<img src="../images/next.gif" alt="" /></a>
+				</div>
+				<div style="clear: both;"></div>
+			</div>
+			
+			<script type="text/javascript">
+			/* <![CDATA[ */
+				if( ( typeof(prev_page) == "undefined" || prev_page == "" ) &&
+					( typeof(next_page) == "undefined" || next_page == "" ) ) 
+				{
+					$( 'nav' ).hide();
+				}
+				else 
+				{			
+					if( typeof(prev_page) != "undefined" && prev_page != "" ) {
+						$( 'prev' ).href = prev_page;
+						$( 'prev' ).show();
+					}
+					else {
+						$( 'prev' ).hide();
+					}
+					
+					if( typeof(next_page) != "undefined" && next_page !="" ) {
+						$( 'next' ).href = next_page;
+						$( 'next' ).show();
+					}
+					else {
+						$( 'next' ).hide();
+					}
+				}
+			/* ]]> */
+			</script>
+
+		</div>
+
+	</div>
+	
+	<!-- Footer -->		
+	<div id="footer">
+		<small>Copyright &copy; 2008, The Apache Software Foundation</small>&nbsp;<!--<p style="padding-right: 25px; text-align: right;">
+	    <a href="http://validator.w3.org/check?uri=referer">
+		<img
+	        src="images/valid-xhtml10.png"
+	        alt="Valid XHTML 1.0 Transitional" height="31" width="88" /></a>
+	 	</p>--></div>
+
+</div>
+
+</body>
+<!-- #EndTemplate -->
+</html>
\ No newline at end of file

Propchange: incubator/empire-db/site/documentation/class_overview.htm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/empire-db/site/documentation/documentation.htm
URL: http://svn.apache.org/viewvc/incubator/empire-db/site/documentation/documentation.htm?rev=681719&view=auto
==============================================================================
--- incubator/empire-db/site/documentation/documentation.htm (added)
+++ incubator/empire-db/site/documentation/documentation.htm Fri Aug  1 08:15:26 2008
@@ -0,0 +1,224 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-gb" lang="en-gb" >
+<!-- #BeginTemplate "../main.dwt" -->
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+	<meta http-equiv="language" content="en" />
+	<meta name="robots" content="index, follow" />
+	<meta name="keywords" content="java, jar, jdbc, sql, data, metadata, persistence, rdbms, orm, mapping" />
+	<meta name="description" content="Open Source relational data persistence component." />
+	
+	<!-- #BeginEditable "doctitle" -->
+<title>Empire-db - Documentation</title>
+	<!-- #EndEditable -->
+	
+	<script type="text/javascript" src="../js/prototype.js"></script>
+	<script type="text/javascript" src="../js/menu.js"></script>
+	<!-- #BeginEditable "javascripts" -->
+	<!-- #EndEditable -->
+	
+	<link rel="shortcut icon" href="../empire-db.ico" />
+	<link rel="stylesheet" href="../css/layout.css" type="text/css" />
+	<!-- #BeginEditable "stylesheets" -->
+	<!-- #EndEditable -->
+</head>
+
+<body>
+<div id="wrapper">
+
+	<!-- Header -->
+	<div id="header">
+		<div id="logo">
+			<img src="../images/logos/empire-db-logo.gif" alt="Empire-db: The relational data persistence component." />
+		</div>
+		<div id="asf">
+			<a target="_blank" href="http://incubator.apache.org/">
+			<img src="../images/logos/apache-incubator-logo.png" alt="Apache Incubator" /></a>
+		</div>
+		<div style="clear:both"></div>
+	</div>
+	
+	<!-- Top -->
+	<div id="top">
+		<div id="topbar">&nbsp;</div>
+	</div>
+	
+	<!-- Middle -->
+	<div id="middle">
+		<div id="left">    
+				<div id="menuBox">     
+					<ul id="mainMenu">
+						<li id="menu_home"><a href="../index.html">Home</a></li>
+						<li id="menu_news"><a href="../news.htm">News</a></li>
+						<li id="menu_empiredb">
+						<a href="../empiredb/empiredb.htm">Empire-db</a>
+								<ul class="subMenu">
+									<li id="menu_empiredb_extending_pattern">
+									<a href="../empiredb/pattern.htm">The Empire DAO-<br />pattern</a></li>
+									<li id="menu_empiredb_handling_metadata">
+									<a href="../empiredb/metadata.htm">Handling data and metadata</a></li>
+									<li id="menu_empiredb_wrong">
+									<a href="../empiredb/hibernate.htm">What's wrong with Hibernate and JPA</a></li>
+									<li id="menu_empiredb_stringfree">
+									<a href="../empiredb/stringfree.htm">The principle of<br/>string-free coding</a></li>
+									<li id="menu_empiredb_faq">
+									<a href="../empiredb/faq.htm">FAQ</a></li>
+								</ul>
+						</li>
+						<li id="menu_struts2ext">
+						<a href="../struts2ext/struts2ext.htm">Empire-db and Struts2</a>
+							<ul class="subMenu">
+								<li id="menu_struts2ext_forms_controls">
+								<a href="../struts2ext/forms_controls.htm">Forms and controls</a></li>
+								<li id="menu_struts2ext_rendering_parsing">
+								<a href="../struts2ext/rendering_parsing.htm">Rendering and parsing</a></li>
+								<!--<li id="menu_struts2ext_tag_reference"><a href="struts2ext/tag_reference.htm">Tag reference</a></li>-->
+								<li id="menu_struts2ext_input_controls">
+								<a href="../struts2ext/input_controls.htm">Input controls</a></li>
+							</ul>
+						</li>
+						<li id="menu_downloads">
+						<a href="../downloads/downloads.htm">Downloads</a>
+								<ul class="subMenu">
+									<li id="menu_downloads_license">
+									<a href="../downloads/license.htm">License</a></li>
+								</ul>
+						</li>
+						<li id="menu_documentation"><a href="documentation.htm">Documentation</a>					
+							<ul class="subMenu">
+								<li id="menu_documentation_class_overview">
+								<a href="class_overview.htm">Empire-db class<br />overview</a></li>
+								<li id="menu_documentation_tutorials">
+								<a href="tutorial.htm">Tutorial</a></li>
+								<li id="menu_documentation_getting_started">
+								<a href="getting_started.htm">Getting started</a></li>
+								<li id="menu_documentation_api">
+								<a href="api.htm">API</a></li>
+							</ul>
+						</li>
+						<li id="menu_community">
+						<a href="../community/community.htm">Community</a>					
+							<ul class="subMenu">
+								<li id="menu_community_mailing_lists">
+								<a href="../community/mailing_lists.htm">Mailing lists</a></li>
+								<!--<li id="menu_community_source_code"><a href="community/source_code.htm">Source code</a></li>-->
+								<li id="menu_community_jira">
+								<a href="../community/jira.htm">Ticketing system</a></li>
+								<!--<li id="menu_community_road_map"><a href="community/road_map.htm">Road map</a></li>-->
+								<li id="menu_community_contributors">
+								<a href="../community/contributors.htm">Contributors</a></li>
+							</ul>
+						</li>
+						<li id="menu_disclaimer"><a href="../disclaimer.htm">Disclaimer</a></li>
+					</ul>
+				</div>
+				
+		</div>
+	
+		<!-- #BeginEditable "menu" -->	
+	<script type="text/javascript">
+		var menu = new Menu( 'mainMenu', 'menu_documentation' );
+	</script>
+		<!-- #EndEditable -->
+		<script type="text/javascript">
+			/* <![CDATA[ */
+			if( menu ) {
+				// Menu fully opened (comment out if not wanted)
+				// menu.openAll();
+			/* ]]> */
+			}
+		</script>
+	
+		<div id="main">		
+			
+			<div id="pathway">
+			<!-- #BeginEditable "pathway" -->
+	        	Documentation
+	        <!-- #EndEditable -->
+	        </div>
+			
+			<div id="content">
+			<!-- #BeginEditable "content" -->
+		<h1>Overview</h1>
+		<p> This section provides tutorial and reference documents which are 
+		helpful for application development. Please choose from the following:</p>
+		<table id="find_out_more">
+			<tr><th class="odd"><a href="class_overview.htm">Empire-db class overview</a></th>
+				<td class="odd">This article gives you an overview of the most important 
+				classes and tells you which to use wand which to extend. For 
+				every class a brief description of the most important methods is 
+				provided.</td></tr>
+			<tr><th><a href="tutorial.htm">Tutorial</a></th>
+				<td>This tutorial demonstrates in eight easy steps how to 
+				work with Empire-db and perform the most common tasks of 
+				data persistence: inserting, updating and deleting 
+				records as well as performing queries.</td></tr>
+			<tr><th class="odd"><a href="getting_started.htm">Getting started</a></th>
+				<td class="odd">This step by step guide explains how to set up
+				your environment for application development with Empire-db.</td></tr>
+			<tr><th><a href="api.htm">Application Programming Interface</a></th>
+				<td>Click here to browse the Empire-db Javadoc API documentation 
+				online for detailed information about the classes and interfaces.</td></tr>
+			</table>
+			<!-- #EndEditable --></div>
+					
+			<div id="nav">
+				<hr />
+				<div id="nav_prev">
+					<a id="prev" href=""><img src="../images/prev.gif" alt="" /> Previous Page</a> 
+					&nbsp;
+				</div>
+				<div id="nav_next">
+					&nbsp;
+					<a id="next" href="">Next Page 
+					<img src="../images/next.gif" alt="" /></a>
+				</div>
+				<div style="clear: both;"></div>
+			</div>
+			
+			<script type="text/javascript">
+			/* <![CDATA[ */
+				if( ( typeof(prev_page) == "undefined" || prev_page == "" ) &&
+					( typeof(next_page) == "undefined" || next_page == "" ) ) 
+				{
+					$( 'nav' ).hide();
+				}
+				else 
+				{			
+					if( typeof(prev_page) != "undefined" && prev_page != "" ) {
+						$( 'prev' ).href = prev_page;
+						$( 'prev' ).show();
+					}
+					else {
+						$( 'prev' ).hide();
+					}
+					
+					if( typeof(next_page) != "undefined" && next_page !="" ) {
+						$( 'next' ).href = next_page;
+						$( 'next' ).show();
+					}
+					else {
+						$( 'next' ).hide();
+					}
+				}
+			/* ]]> */
+			</script>
+
+		</div>
+
+	</div>
+	
+	<!-- Footer -->		
+	<div id="footer">
+		<small>Copyright &copy; 2008, The Apache Software Foundation</small>&nbsp;<!--<p style="padding-right: 25px; text-align: right;">
+	    <a href="http://validator.w3.org/check?uri=referer">
+		<img
+	        src="images/valid-xhtml10.png"
+	        alt="Valid XHTML 1.0 Transitional" height="31" width="88" /></a>
+	 	</p>--></div>
+
+</div>
+
+</body>
+<!-- #EndTemplate -->
+</html>
\ No newline at end of file

Propchange: incubator/empire-db/site/documentation/documentation.htm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/empire-db/site/documentation/getting_started.htm
URL: http://svn.apache.org/viewvc/incubator/empire-db/site/documentation/getting_started.htm?rev=681719&view=auto
==============================================================================
--- incubator/empire-db/site/documentation/getting_started.htm (added)
+++ incubator/empire-db/site/documentation/getting_started.htm Fri Aug  1 08:15:26 2008
@@ -0,0 +1,315 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-gb" lang="en-gb" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" >
+<!-- #BeginTemplate "../main.dwt" -->
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+	<meta http-equiv="language" content="en" />
+	<meta name="robots" content="index, follow" />
+	<meta name="keywords" content="java, jar, jdbc, sql, data, metadata, persistence, rdbms, orm, mapping" />
+	<meta name="description" content="Open Source relational data persistence component." />
+	
+	<!-- #BeginEditable "doctitle" -->
+<title>Empire-db - Getting started</title>
+	<!-- #EndEditable -->
+	
+	<script type="text/javascript" src="../js/prototype.js"></script>
+	<script type="text/javascript" src="../js/menu.js"></script>
+	<!-- #BeginEditable "javascripts" -->
+<script type="text/javascript" src="../js/maillink.js"></script>
+	<!-- #EndEditable -->
+	
+	<link rel="shortcut icon" href="../empire-db.ico" />
+	<link rel="stylesheet" href="../css/layout.css" type="text/css" />
+	<!-- #BeginEditable "stylesheets" -->
+<style type="text/css">
+
+ul.sublist {
+	margin-top:8px;
+}
+
+</style>
+	<!-- #EndEditable -->
+</head>
+
+<body>
+<div id="wrapper">
+
+	<!-- Header -->
+	<div id="header">
+		<div id="logo">
+			<img src="../images/logos/empire-db-logo.gif" alt="Empire-db: The relational data persistence component." />
+		</div>
+		<div id="asf">
+			<a target="_blank" href="http://incubator.apache.org/">
+			<img src="../images/logos/apache-incubator-logo.png" alt="Apache Incubator" /></a>
+		</div>
+		<div style="clear:both"></div>
+	</div>
+	
+	<!-- Top -->
+	<div id="top">
+		<div id="topbar">&nbsp;</div>
+	</div>
+	
+	<!-- Middle -->
+	<div id="middle">
+		<div id="left">    
+				<div id="menuBox">     
+					<ul id="mainMenu">
+						<li id="menu_home"><a href="../index.html">Home</a></li>
+						<li id="menu_news"><a href="../news.htm">News</a></li>
+						<li id="menu_empiredb">
+						<a href="../empiredb/empiredb.htm">Empire-db</a>
+								<ul class="subMenu">
+									<li id="menu_empiredb_extending_pattern">
+									<a href="../empiredb/pattern.htm">The Empire DAO-<br />pattern</a></li>
+									<li id="menu_empiredb_handling_metadata">
+									<a href="../empiredb/metadata.htm">Handling data and metadata</a></li>
+									<li id="menu_empiredb_wrong">
+									<a href="../empiredb/hibernate.htm">What's wrong with Hibernate and JPA</a></li>
+									<li id="menu_empiredb_stringfree">
+									<a href="../empiredb/stringfree.htm">The principle of<br/>string-free coding</a></li>
+									<li id="menu_empiredb_faq">
+									<a href="../empiredb/faq.htm">FAQ</a></li>
+								</ul>
+						</li>
+						<li id="menu_struts2ext">
+						<a href="../struts2ext/struts2ext.htm">Empire-db and Struts2</a>
+							<ul class="subMenu">
+								<li id="menu_struts2ext_forms_controls">
+								<a href="../struts2ext/forms_controls.htm">Forms and controls</a></li>
+								<li id="menu_struts2ext_rendering_parsing">
+								<a href="../struts2ext/rendering_parsing.htm">Rendering and parsing</a></li>
+								<!--<li id="menu_struts2ext_tag_reference"><a href="struts2ext/tag_reference.htm">Tag reference</a></li>-->
+								<li id="menu_struts2ext_input_controls">
+								<a href="../struts2ext/input_controls.htm">Input controls</a></li>
+							</ul>
+						</li>
+						<li id="menu_downloads">
+						<a href="../downloads/downloads.htm">Downloads</a>
+								<ul class="subMenu">
+									<li id="menu_downloads_license">
+									<a href="../downloads/license.htm">License</a></li>
+								</ul>
+						</li>
+						<li id="menu_documentation"><a href="documentation.htm">Documentation</a>					
+							<ul class="subMenu">
+								<li id="menu_documentation_class_overview">
+								<a href="class_overview.htm">Empire-db class<br />overview</a></li>
+								<li id="menu_documentation_tutorials">
+								<a href="tutorial.htm">Tutorial</a></li>
+								<li id="menu_documentation_getting_started">
+								<a href="getting_started.htm">Getting started</a></li>
+								<li id="menu_documentation_api">
+								<a href="api.htm">API</a></li>
+							</ul>
+						</li>
+						<li id="menu_community">
+						<a href="../community/community.htm">Community</a>					
+							<ul class="subMenu">
+								<li id="menu_community_mailing_lists">
+								<a href="../community/mailing_lists.htm">Mailing lists</a></li>
+								<!--<li id="menu_community_source_code"><a href="community/source_code.htm">Source code</a></li>-->
+								<li id="menu_community_jira">
+								<a href="../community/jira.htm">Ticketing system</a></li>
+								<!--<li id="menu_community_road_map"><a href="community/road_map.htm">Road map</a></li>-->
+								<li id="menu_community_contributors">
+								<a href="../community/contributors.htm">Contributors</a></li>
+							</ul>
+						</li>
+						<li id="menu_disclaimer"><a href="../disclaimer.htm">Disclaimer</a></li>
+					</ul>
+				</div>
+				
+		</div>
+	
+		<!-- #BeginEditable "menu" -->	
+	<script type="text/javascript">
+		var menu = new Menu( 'mainMenu', 'menu_documentation', 'menu_documentation_getting_started' );
+		var prev_page = "tutorial.htm";
+		var next_page = "api.htm";
+	</script>
+		<!-- #EndEditable -->
+		<script type="text/javascript">
+			/* <![CDATA[ */
+			if( menu ) {
+				// Menu fully opened (comment out if not wanted)
+				// menu.openAll();
+			/* ]]> */
+			}
+		</script>
+	
+		<div id="main">		
+			
+			<div id="pathway">
+			<!-- #BeginEditable "pathway" -->
+	        	<a href="documentation.htm">Documentation</a> &raquo; Getting started
+	        <!-- #EndEditable -->
+	        </div>
+			
+			<div id="content">
+			<!-- #BeginEditable "content" -->
+			<!--<h1>Tutorials</h1>-->
+		<h1>Getting started</h1>
+			<p> The following step by step directions may help you to get the 
+			sample applications provided with the distributions up and running 
+			and to get started with Empire-db.</p>
+		<ul>
+			<li><a href="#DBSample">Run the Empire-db sample application DBSample</a></li>
+			<li><a href="#DBWebSample">Run the Empire-Struts2-Extensions sample application DBWebSample</a></li>
+			<!--<li><a href="#websample">WebSample - How to create a WebApplication with JSPs, Struts2 and Empire-db</a></li>-->
+		</ul>
+		
+		<h1 id="DBSample">Run the Empire-db sample application DBSample from Eclipse </h1>
+			<p>The following steps describe how to run and debug the Empire-db sample application 
+			provided with the Emprie-db distribution package:</p>
+			<ol start="1" type="1">
+				<li>Download and unzip the <a href="../downloads/downloads.htm">Empire-db distribution package</a>.</li>
+				<li>In Eclipse choose <strong><em>File / Import</em></strong> 
+				and select <strong><em>Existing projects into 
+				workspace</em></strong>. When prompted for a root directory select the folder 
+				".../empire-db-2.0.0/examples/DBSample".</li>
+				<li>Open the file DBSampleApp.java and set a breakpoint on the first line of the main method.</li>
+				<li>From the Run menu select <strong><em>Debug as / Java Application</em></strong>. 
+				When prompted for a Java application class select <strong><em>SampleApp – 
+				de.esteam.sample.db</em></strong>.</li>
+			</ol>
+			<p>The sample should now run and stop at the breakpoint in the main method. 
+			You may then step through the code and play around with it. For further 
+			information please read the <a href="tutorial.htm">tutorial</a>.</p>
+			<p>In order to manually configure the project the following jar files need 
+			to be added to your classpath:</p>
+			<ul type="disc">
+				<li>commons-logging-1.0.4.jar</li>
+				<li>commons-collections-2.1.1.jar</li>
+				<li>commons-beanutils-1.7.0.jar</li>
+				<li>empire-db-2.0.0.jar</li>
+				<li>log4j-1.2.14.jar</li>
+				<li>hsqldb.jar</li>
+			</ul>
+
+		<h1 id="DBWebSample">Run the Empire-Struts2-Extensions sample application DBWebSample from Eclipse</h1>
+			<p>The following steps describe how to run the Empire-Struts2-Extensions sample 
+			application from Eclipse using Apache Tomcat 5.5 application server. 
+			Apache Tomcat 5.5. should be already installed on your system – otherwise 
+			it may be downloaded <a href="http://tomcat.apache.org/download-55.cgi" target="_blank">here</a>.</p>
+			<ol start="1" type="1">
+				<li>Download and unzip the <a href="../downloads/downloads.htm">Empire-Struts2-Extensions distribution package</a>.</li>
+				<li>In Eclipse choose <strong><em>File / Import</em></strong> 
+				and select <strong><em>Existing projects into workspace</em></strong>. 
+				When prompted for a root directory select the folder ".../empire-struts2-ext-1.x.x\examples\DBWebSample".</li>
+				<li>If you are reported an error that the type <code>javax.servlet.http.HttpSession</code> cannot be resolved 
+				please do one of the following:
+				<ul type="disc" class="sublist">
+					<li>In the Eclipse preferences panel, select <strong><em>Server / Installed Runtimes</em></strong> and add Apache 
+					Tomcat to the list of runtimes. Then open the project properties 
+					panel and 
+					check whether Apache Tomcat is listed on the Library tab. If not, 
+					choose <strong><em>Add Library / Server Runtime</em></strong> and select Apache Tomcat. 
+					Finally rebuild the project.</li>
+					<li>Alternatively you may add the required JARs directly. Choose 
+					<strong><em>Add External JARs</em></strong> and add 
+					the file servlet-api.jar from the Tomcat-5.5.x/common/lib folder.</li>
+				</ul>
+				</li>
+				<li>In order to run the sample you can do either of the following (depending on your environment):
+				<ul type="disc" class="sublist">
+					<li>From the <strong><em>Run</em></strong> menu select
+					<strong><em>Debug as / Debug on Server.</em></strong> When prompted for a 
+					server choose Apache Tomcat application class select <em>
+					<strong>
+					Apache Tomcat v5.5. Server at localhost</strong></em>.</li>
+					<li>If you prefer to use the <a href="http://www.eclipsetotale.com/tomcatPlugin.html">Sysdeo Eclipse Tomcat Launcher plugin</a>
+					right click on the DBWebSample project. From the context menu select 
+					<strong><em>Tomcat project / Add context in Tomcat</em></strong>. Please make sure, that the plugin’s DevLoader class 
+					has been copied to TOMCAT_HOME/server/classes (see also readmeDevLoader.html in 
+					/plugins/com.sysdeo.eclipse.tomcat_3.2.x). Now click on the Tomcat symbol in the toolbar 
+					in order to run tomcat.</li>
+				</ul>
+				</li>
+				<li>Open your browser and enter <code>http://localhost:8080/DBWebSample</code> in the URL field. 
+				The Empire Struts2 sample application should now prompt you with its login screen.</li>
+			</ol>	
+
+			<p><b>Note:</b> When running the sample you will be prompted for a username and 
+			password. This is just a fake login screen. Any non empty username 
+			will be accepted. The password field may even be left empty. On the 
+			search form leave all fields empty and simple press the search 
+			button in order to get all results.</p>
+			<p>Further we recommend to set breakpoints at the following locations:</p>
+			<ul type="disc">
+				<li>on the <code>SampleApplication.init()</code> method.</li>
+				<li>on the <code>EmployeeListAction.doList()</code> method.</li>
+				<li>on the <code>EmployeeDetailAction</code>’s <code>doLoad()</code>, <code>doCreate()</code> and <code>doSave()</code> methods.</li>
+			</ul>
+			
+			<p>If you have any problems running the samples please let us know. E-mail <a id="mail_support"><img style="vertical-align: bottom;padding-top:2px" src="../images/mail/empire-support.gif" alt="" /></a></p>
+			<script type="text/javascript">
+				new MailLink( 'mail_support', 'support', 'empire-db.org' );
+			</script>
+		
+		<!--<h1 id="websample">WebSample - Building a WebApplication with Empire-db</h1>
+		<p>
+		</p>-->
+			<!-- #EndEditable --></div>
+					
+			<div id="nav">
+				<hr />
+				<div id="nav_prev">
+					<a id="prev" href=""><img src="../images/prev.gif" alt="" /> Previous Page</a> 
+					&nbsp;
+				</div>
+				<div id="nav_next">
+					&nbsp;
+					<a id="next" href="">Next Page 
+					<img src="../images/next.gif" alt="" /></a>
+				</div>
+				<div style="clear: both;"></div>
+			</div>
+			
+			<script type="text/javascript">
+			/* <![CDATA[ */
+				if( ( typeof(prev_page) == "undefined" || prev_page == "" ) &&
+					( typeof(next_page) == "undefined" || next_page == "" ) ) 
+				{
+					$( 'nav' ).hide();
+				}
+				else 
+				{			
+					if( typeof(prev_page) != "undefined" && prev_page != "" ) {
+						$( 'prev' ).href = prev_page;
+						$( 'prev' ).show();
+					}
+					else {
+						$( 'prev' ).hide();
+					}
+					
+					if( typeof(next_page) != "undefined" && next_page !="" ) {
+						$( 'next' ).href = next_page;
+						$( 'next' ).show();
+					}
+					else {
+						$( 'next' ).hide();
+					}
+				}
+			/* ]]> */
+			</script>
+
+		</div>
+
+	</div>
+	
+	<!-- Footer -->		
+	<div id="footer">
+		<small>Copyright &copy; 2008, The Apache Software Foundation</small>&nbsp;<!--<p style="padding-right: 25px; text-align: right;">
+	    <a href="http://validator.w3.org/check?uri=referer">
+		<img
+	        src="images/valid-xhtml10.png"
+	        alt="Valid XHTML 1.0 Transitional" height="31" width="88" /></a>
+	 	</p>--></div>
+
+</div>
+
+</body>
+<!-- #EndTemplate -->
+</html>
\ No newline at end of file

Propchange: incubator/empire-db/site/documentation/getting_started.htm
------------------------------------------------------------------------------
    svn:mime-type = text/plain



Mime
View raw message