=========================
Welcome to Jackrabbit OCM
=========================

This Jackrabbit subproject is an object/JCR persistence and query service.
This tools lets you to persist Java objects into a JCR compliant repository
- including association, inheritance, polymorphism, composition, and the
Java Collections framework.

Furthermore, this object-content mapping component allows you to express
queries with Java-based criteria, as well as in JCR query language. It
offers also features like version support and object locking.

See the Apache Jackrabbit web site (http://jackrabbit.apache.org/)
for documentation and other information. You are welcome to join the
Jackrabbit mailing lists (http://jackrabbit.apache.org/mail-lists.html)
to discuss this component and to use the Jackrabbit issue tracker
(http://issues.apache.org/jira/browse/JCR) to report issues or request
new features.

Apache Jackrabbit is a project of the Apache Software Foundation
(http://www.apache.org).


License (see also LICENSE.txt)
==============================

Collective work: Copyright 2007 The Apache Software Foundation.

Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


Getting Started
===============

This component uses a Maven 2 (http://maven.apache.org/) build
environment. If you have Maven 2 installed, you can compile and
package the jackrabbit-ocm jar using the following command:

    mvn package

See the Maven 2 documentation for other build features.

Note that you need Java 5 to build this component. A special downgraded
Java 1.4 version of the resulting jar file is generated by the build process
for use as a dependency in older Java environments. The annotation mapping
feature is not available in Java 1.4.

The latest source code for this component is available in the
Subversion (http://subversion.tigris.org/) source repository of
the Apache Software Foundation. If you have Subversion installed,
you can checkout the latest source using the following command:

    svn checkout http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-ocm

See the Subversion documentation for other source control features.