|
The JPOX code is structured as two (Maven) projects. The top-level project is for the core functionality of Maven. The second project is a work-in-progress project aimed at generating an IDE for JPOX. These are described below.
The core functionality of JPOX is, in simple terms, the JDO implementation. This provides the artifacts jpox-{version}.jar and jpox-{version}.rar. The file structure for this project is shown below.
- LICENSE.txt - This contains the license definition for JPOX. It is based on the Apache software license.
- README - This contains basic information about the JPOX project and is included with any JAR's, directing the user to the license terms and conditions.
- README.build - This file contains information about how to build JPOX using Maven.
- build.properties - This is used when building JPOX using Ant.
- build.xml - This is used when building JPOX using Ant
- checkstyle.xml - This is used by the Checkstyle application and reinforces the coding standards used on the project.
- maven.xml - This is used when building JPOX using Maven, and configures the Maven goals to link as we require.
- project.properties - This is used when building JPOX using Maven, and defines controls for the various Maven plugins used.
- project.xml - This is used when building JPOX using Maven, and is the main project definition for JPOX.
- test.properties - This defines which JPOX unit tests fit in which test scenario. Used when running unit tests.
- IDE/ - This contains the IDE sub-project (see below)
- TCK/ - This contains the files necessary to run the JDO Technology Compatibility Kit (TCK) with JPOX.
- src/ - This is the main directory for anyone wanting to develop JPOX. It contains the source code.
- src/conf/ - This contains sample configuration files for using JPOX with various RDBMS.
- src/java/ - This contains the source code for JPOX core, the JDO implementation.
- src/test/ - This contains the source code for the JPOX test suite (JUnit tests).
- jdo-tools/ - This contains the necessary files to run the SourceForge JDO-Tools project with JPOX. This will be contributed to the JDO-Tools project when it is complete.
- lib/ - This contains a few library dependencies that JPOX may require.
- maven-plugins/ - This contains any modified Maven plugins that have been tailored to meet what we require on JPOX.
- samples/ - This contains a series of code snippets demonstrating how to use the various aspects of JPOX.
- xdocs/ - This contains the documentation for JPOX. The majority of this is in XML format, and is converted (to HTML) by Maven when generating the website.
As you have maybe guessed from the above file structure, JPOX core can be built using either Maven (the preferred option), or Ant. So you have the choice.
The IDE project provides an integrated development environment for generating the necessary persistence specifications for using JPOX. This provides the artifact jpox-ide-{version}.jar. The file structure for this project is shown below
- README - This contains basic information about the JPOX-IDE project and is included with any JAR's, directing the user to the license terms and conditions.
- README.build - This file contains information about how to build JPOX-IDE using Maven.
- project.properties - This is used when building JPOX-IDE using Maven, and defines controls for the various Maven plugins used.
- project.xml - This is used when building JPOX-IDE using Maven, and is the main project definition for JPOX-IDE.
- src/conf/ - This contains anything that is required by the IDE at runtime (e.g images).
- src/java/ - This contains the source code for JPOX-IDE, the JPOX integrated development environment.
- src/test/ - This contains the source code for the JPOX-IDE test suite (JUnit tests).
The JPOX-IDE project is built using Maven.
|