You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by dg...@apache.org on 2003/09/08 06:37:27 UTC
cvs commit: jakarta-commons-sandbox/mapper/xdocs todo.xml navigation.xml index.xml
dgraham 2003/09/07 21:37:27
Added: mapper project.xml
mapper/xdocs todo.xml navigation.xml index.xml
Log:
Added Maven build files to generate website.
Revision Changes Path
1.1 jakarta-commons-sandbox/mapper/project.xml
Index: project.xml
===================================================================
<?xml version="1.0"?>
<project>
<pomVersion>3</pomVersion>
<name>Commons Mapper</name>
<id>commons-mapper</id>
<currentVersion>0.6-dev</currentVersion>
<organization>
<name>Apache Software Foundation</name>
<url>http://jakarta.apache.org/</url>
</organization>
<inceptionYear>2003</inceptionYear>
<package>org.apache.commons.mapper</package>
<shortDescription>Commons Mapper</shortDescription>
<!-- Gump integration -->
<gumpRepositoryId>jakarta</gumpRepositoryId>
<description>
Mapper is a thin abstraction layer around a project's chosen data
mapping technology.
</description>
<url>http://jakarta.apache.org/commons/sandbox/mapper/</url>
<issueTrackingUrl>http://issues.apache.org/bugzilla/</issueTrackingUrl>
<siteAddress>jakarta.apache.org</siteAddress>
<siteDirectory>/www/jakarta.apache.org/commons/sandbox/mapper/</siteDirectory>
<distributionDirectory>/www/jakarta.apache.org/builds/jakarta-commons-sandbox/mapper/</distributionDirectory>
<repository>
<connection>
scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-commons-sandbox/mapper
</connection>
<url>
http://cvs.apache.org/viewcvs.cgi/jakarta-commons-sandbox/mapper/
</url>
</repository>
<mailingLists>
<mailingList>
<name>Commons User List</name>
<subscribe>
commons-user-subscribe@jakarta.apache.org
</subscribe>
<unsubscribe>
commons-user-unsubscribe@jakarta.apache.org
</unsubscribe>
<archive>
http://www.mail-archive.com/commons-user@jakarta.apache.org/
</archive>
</mailingList>
<mailingList>
<name>Commons Developer List</name>
<subscribe>
commons-dev-subscribe@jakarta.apache.org
</subscribe>
<unsubscribe>
commons-dev-unsubscribe@jakarta.apache.org
</unsubscribe>
<archive>
http://www.mail-archive.com/commons-dev@jakarta.apache.org/
</archive>
</mailingList>
</mailingLists>
<developers>
<developer>
<name>David Graham</name>
<id>dgraham</id>
<email>dgraham@apache.org</email>
<organization></organization>
</developer>
</developers>
<dependencies>
<!-- for testing -->
<dependency>
<id>junit</id>
<version>3.8.1</version>
</dependency>
</dependencies>
<build>
<nagEmailAddress>commons-dev@jakarta.apache.org</nagEmailAddress>
<sourceDirectory>src/share</sourceDirectory>
<unitTestSourceDirectory>src/test</unitTestSourceDirectory>
<!-- Unit test cases -->
<unitTest>
<includes>
<include>**/*Test.java</include>
</includes>
</unitTest>
<!-- Resources that are packaged up inside the JAR file -->
<resources>
<includes>
<include>**/*.properties</include>
</includes>
</resources>
<!-- Integration unit test cases -->
<integrationUnitTest/>
<jars>
</jars>
</build>
</project>
1.1 jakarta-commons-sandbox/mapper/xdocs/todo.xml
Index: todo.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>TODO</title>
<author email="dgraham@apache.org">David Graham</author>
</properties>
<body>
<section name="TODO">
<p>
The following is a list of items that need to be completed in
Mapper. Contributions are welcome!.
</p>
<table border="1">
<tr>
<th>Action Item</th>
<th>Volunteer</th>
</tr>
<tr>
<td>
<strong>Documentation</strong> - Provide more examples and a basic
User's Guide information in a <code>package.html</code> file.
</td>
<td align="center"></td>
</tr>
</table>
</section>
</body>
</document>
1.1 jakarta-commons-sandbox/mapper/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Mapper">
<title>Mapper</title>
<organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo>
<body>
<menu name="Mapper">
<item name="Overview" href="/index.html"/>
<item name="To Do List" href="/todo.html"/>
</menu>
</body>
</project>
1.1 jakarta-commons-sandbox/mapper/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Mapper: Data Mapping Abstraction Component</title>
<author email="dgraham@apache.org">David Graham</author>
</properties>
<body>
<section name="Mapper: Data Mapping Abstraction Component">
<section name="Rationale">
<p>
Most Java applications must store data to a data store whether it's XML files or
a relational database. Changes to the mapping technology should be transparent
to the rest of the application allowing changes to be localized in the mapping
layer.
</p>
<p>
Commons Mapper is a thin abstraction layer around a project's chosen data mapping
technology. It allows the developer to vary the mapping technique behind
this layer (often combining several technologies) so that the rest of the
application doesn't change. Technologies such as EJB, JDO, Hibernate, XML,
and JDBC can all be used to map Java objects to a data store.
</p>
<p>
The purpose of Mapper is similar to Commons Logging. It isn't a mapping technology
itself, it merely exposes common functionality of other mapping APIs.
</p>
<p>
Commons Mapper is based on the Data Mapper pattern presented in "Patterns of
Enterprise Application Architecture" by Martin Fowler.
</p>
</section>
<section name="Scope of the Package">
<p>
Commons Mapper is <strong>not</strong> a data mapping implementation. It is meant
to be an API allowing pluggable mapper objects of varying implementations.
</p>
<p>
All mappers must implement the <code>Mapper</code> interface.
<code>MapperFactory</code> is the main object in the framework. It allows clients
to lookup <code>Mapper</code> implementations without them knowing the underlying
type.
</p>
<pre>
// Setup MapperFactory (this is best done in a .properties file).
// The keys in the file are fully qualified class names of objects to
// persist. The values are the fully qualified class names of the Mapper
// objects.
Map mappers = new HashMap();
mappers.add("com.yourcorp.Person", "com.yourcorp.PersonMapper");
MapperFactory factory = new MapperFactory(mappers);
Person p = new Person("Joe", "User");
Mapper m = factory.getMapper(Person.class);
m.create(p);
</pre>
</section>
<section name="Interaction With Other Packages">
<p>
Commons Mapper relies on the standard JDK 1.2 (or later) APIs.
</p>
</section>
</section>
</body>
</document>