AfflictionNetworks/depot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More tidying, added Javadoc overview.

Browse Source
This commit is contained in:
Michael Bayne
2008-11-16 06:08:56 +00:00
parent 745c380e8d
commit 40c1480039
2 changed files with 74 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
build.xml
+9 -12
View File
@@ -12,7 +12,6 @@
<property name="classes.dir" value="${deploy.dir}/classes"/>
<property name="javadoc.dir" value="${deploy.dir}/docs"/>
<property name="libs.dir" value="lib"/>
<property name="gwtjar.dir" value="${deploy.dir}/gwt-jar"/>
<!-- declare our classpath business -->
<path id="classpath">
@@ -52,10 +51,10 @@
<echo level="info">Velocity: ${jakarta.velocity.present}</echo>
<!-- combines package availability into build controls -->
<condition property="build.depot.ehcache">
<condition property="build.ehcache">
<and><isset property="ehcache.present"/></and>
</condition>
<condition property="build.depot.tools">
<condition property="build.tools">
<and><isset property="ant.present"/>
<isset property="velocity.present"/></and>
</condition>
@@ -84,7 +83,6 @@
<target name="clean">
<delete dir="${classes.dir}"/>
<delete dir="${deploy.dir}/docs"/>
<delete dir="${gwtjar.dir}"/>
<delete failonerror="false"><fileset dir="${deploy.dir}" includes="*.jar"/></delete>
</target>
@@ -98,8 +96,8 @@
<javac srcdir="${src.dir}" destdir="${classes.dir}" includeAntRuntime="false"
debug="on" optimize="${build.optimize}" source="1.5" target="1.5" encoding="utf-8">
<classpath refid="classpath"/>
<exclude name="com/samskivert/depot/EHCacheAdapter.java" unless="build.depot.ehcache"/>
<exclude name="com/samskivert/depot/tools/**" unless="build.depot.tools"/>
<exclude name="com/samskivert/depot/EHCacheAdapter.java" unless="build.ehcache"/>
<exclude name="com/samskivert/depot/tools/**" unless="build.tools"/>
<exclude name="com/samskivert/depot/tests/**" unless="build.tests"/>
<compilerarg value="-Xlint"/>
<compilerarg value="-Xlint:-serial"/>
@@ -108,17 +106,16 @@
<!-- build the javadoc documentation -->
<target name="javadoc" depends="prepare,compute-builds">
<javadoc windowtitle="${app.name} API"
doctitle="${app.name} API"
overview="${src.dir}/${doc.overview}"
destdir="${javadoc.dir}"
<javadoc windowtitle="${app.name} API" doctitle="${app.name} API"
overview="${src.dir}/${doc.overview}" destdir="${javadoc.dir}"
additionalparam="-breakiterator"
link="http://samskivert.com/code/samskivert/samskivert/docs/api/">
<packageset dir="${src.dir}">
<exclude name="com/samskivert/depot/EHCacheAdapter.java" unless="ehcache.present"/>
<exclude name="com/samskivert/depot/EHCacheAdapter.java" unless="build.ehcache"/>
<exclude name="com/samskivert/depot/tools/**" unless="build.tools"/>
<exclude name="com/samskivert/depot/tests/**" unless="build.tests"/>
</packageset>
<bottom>Copyright &#169; 2000-${year} ${copyright.holder}. All Rights Reserved.</bottom>
<bottom>Copyright &#169; 2006-${year} ${copyright.holder}. All Rights Reserved.</bottom>
<classpath refid="classpath"/>
<link href="http://java.sun.com/j2se/1.5/docs/api/"/>
</javadoc>
src/java/com/samskivert/depot/overview.html
+65
View File
@@ -0,0 +1,65 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!--
$Id: overview.html,v 1.1 2001/08/12 01:45:46 mdb Exp $
Depot library - useful routines for java programs
Copyright (C) 2006-2008 Michael Bayne
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
</head>
<body bgcolor="white">
Depot is something like an ORM library in Java, but has aims that are
somewhat different from the popular "managed" persistence libraries like
Hibernate and others.
<h3>Design Goals</h3>
<ul>
<li><p> Eliminate (as much as possible) the use of raw SQL (or any textual
query language), instead providing Java classes that allow the
expressions of queries and updates in as concise but compile-time
checkable a manner as possible. </p>
<li><p> Reduce the pain of schema and data migrations as much as possible,
but not so much that the system used to do the migrations is too
complex for anyone to understand or use properly. </p>
<li><p> Use annotations to layer database metadata over the top of (almost)
POJOs. </p>
<li><p> Use annotations that are syntactically and semantically equivalent
to EJB3 persistence annotations wherever possible. </p>
<li><p> Support multiple database backends (currently MySQL and Postgresql). </p>
<li><p> Provide caching support (currently integrated with EHCache). </p>
<li><p> Keep an eye toward eventual support for sharded databases. </p>
</ul>
<p> I and others who have contributed to the library hope that you find it
useful, easy to use and time saving. Comments and contributions are
always welcome.
<p> -- <a href="mailto:mdb@samskivert.com">mdb@samskivert.com</a>
</body>
</html>