[Apache JDO Wiki] New: ProjectStructure

[jd...@db.apache.org]

   Date: 2005-01-08T15:47:20
   Editor: CraigRussell
   Wiki: Apache JDO Wiki
   Page: ProjectStructure
   URL: http://wiki.apache.org/jdo/ProjectStructure

   no comment

New Page:

= Apache JDO Project Structure =

Apache JDO uses maven for project builds. Each sub-project appears as a directory underneath the top level jdo directory. Each sub-project contains some combination of:

 * a src directory which contains the Java sources
 * a test directory which contains the Java sources for the JUnit tests
 * an xdocs directory which contains the maven site building documents
 * project.properties maven file
 * project.xml maven file
 * maven.xml maven file

= Dependencies =

 * Apache JDO uses maven for builds. Get more information about maven [http://maven.apache.org here].
 * The jnditest11 sub-project requires a jndi provider (download with click license from Sun)

= Sub-Projects =

The following sub-projects have been defined:

 ||api11||JDO 1.0 API. This is the standard definition of the JDO API as defined by the JSR-12 standard. No additional work is expected in this project.||
 ||ri11||JDO 1.1 Reference Implementation. This is a file-based, single-user store for persistent Java objects. The storage component is called File Object Store (FOStore). The version number is 1.1 to reflect that the Java package has changed from com.sun.jdori to org.apache.jdo. The license has also changed.||
 ||btree||This sub-project contains an adapter to the btree open source implementation developed by Netbeans. The maven build for this directory downloads the btree package sources from Netbeans and builds it. The ri11 project depends on this sub-project.||
 ||tck11||JDO 1.1 Technology Compatibility Kit. This set of programs tests that a JDO 1.0 implementation is in compliance with the standard. The version number is 1.1 to reflect that the test framework has changed from [http://java.sun.com/developer/technicalArticles/JCPtools2/ JavaTest] (a proprietary Sun package not suitable for open source projects) to[http://www.junit.org/index.htm JUnit], an open source test framework. The license has also changed.||
 ||api20||JDO 2.0 API. This is the standard definition of the JDO API as defined by the JSR-243 standard.||
 ||tck20||JDO 2.0 Technology Compatibility Kit. This set of programs tests that a JDO 2.0 implementation is in compliance with the standard.||
 ||fostore20||JDO 2.0 FOStore (File Object Store) implementation. This is an implementation of JDO 2.0 based on the JDO 1.0 Reference Implementation. It does not support relational data access, so it is inappropriate for the JDO 2.0 Reference Implementation. See below.||
 ||geronimo||JDO 2.0 Geronimo Integration. This project will build the glue between the JDO 2.0 Reference Implementation and the J2EE compliant application server. We expect to use a common persistence framework (Tranql) to provide both EJB3 and JDO persistence services. We also expect to allow FOStore to be able to be defined as a Connector, and looked up as a JNDI resource.||
 ||jnditest11||This project contains test programs for the JNDI functionality of the ri. It is in a separate sub-project because of dependencies on a naming implementation. The current naming implementation is available by download from Sun, only via a click-license. This dependency requires a manual step in the install process, and as such, is undesirable. Users wishing to avoid the manual step can run the ri but cannot use the JNDI functionality without accessing a naming service. We would like to use the Apache directory project components to avoid the extra manual step.||