From 40c1480039bab3cc67e035203fad3c62ba1957f9 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Sun, 16 Nov 2008 06:08:56 +0000 Subject: [PATCH] More tidying, added Javadoc overview. --- build.xml | 21 +++---- src/java/com/samskivert/depot/overview.html | 65 +++++++++++++++++++++ 2 files changed, 74 insertions(+), 12 deletions(-) create mode 100644 src/java/com/samskivert/depot/overview.html diff --git a/build.xml b/build.xml index d122ba5..777b400 100644 --- a/build.xml +++ b/build.xml @@ -12,7 +12,6 @@ - @@ -52,10 +51,10 @@ Velocity: ${jakarta.velocity.present} - + - + @@ -84,7 +83,6 @@ - @@ -98,8 +96,8 @@ - - + + @@ -108,17 +106,16 @@ - - + + - Copyright © 2000-${year} ${copyright.holder}. All Rights Reserved. + Copyright © 2006-${year} ${copyright.holder}. All Rights Reserved. diff --git a/src/java/com/samskivert/depot/overview.html b/src/java/com/samskivert/depot/overview.html new file mode 100644 index 0000000..eba4c39 --- /dev/null +++ b/src/java/com/samskivert/depot/overview.html @@ -0,0 +1,65 @@ + + + + + + + + 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. + +

Design Goals

+ +
    +

  • 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.

    + +

  • 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.

    + +

  • Use annotations to layer database metadata over the top of (almost) + POJOs.

    + +

  • Use annotations that are syntactically and semantically equivalent + to EJB3 persistence annotations wherever possible.

    + +

  • Support multiple database backends (currently MySQL and Postgresql).

    + +

  • Provide caching support (currently integrated with EHCache).

    + +

  • Keep an eye toward eventual support for sharded databases.

    +
+ +

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. + +

-- mdb@samskivert.com + + +