You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by tr...@apache.org on 2015/04/08 22:34:17 UTC
svn commit: r1672168 [22/33] - in /jackrabbit/site/live/jcr: ./ components/
css/ images/ images/logos/ images/profiles/ img/ js/ ocm/ status/
Added: jackrabbit/site/live/jcr/ocm/mapping-stategies.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/ocm/mapping-stategies.html?rev=1672168&view=auto
==============================================================================
--- jackrabbit/site/live/jcr/ocm/mapping-stategies.html (added)
+++ jackrabbit/site/live/jcr/ocm/mapping-stategies.html Wed Apr 8 20:34:14 2015
@@ -0,0 +1,588 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-04-08
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20150408" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Jackrabbit - Mapping Strategies</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <a class="brand" href="../index.html" title="Apache Jackrabbit">
+
+
+ <img src="../images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="Welcome">Welcome</a>
+</li>
+
+ <li> <a href="../downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="../articles.html" title="Articles">Articles</a>
+</li>
+
+ <li> <a href="../frequently-asked-questions.html" title="FAQ">FAQ</a>
+</li>
+
+ <li> <a href="http://wiki.apache.org/jackrabbit/FrontPage" title="Jackrabbit Wiki">Jackrabbit Wiki</a>
+</li>
+
+ <li> <a href="../jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../standalone-server.html" title="Standalone Server">Standalone Server</a>
+</li>
+
+ <li> <a href="../jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
+</li>
+
+ <li> <a href="../first-hops.html" title="First Hops">First Hops</a>
+</li>
+
+ <li> <a href="../jcr-api.html" title="JCR & API">JCR & API</a>
+</li>
+
+ <li> <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
+</li>
+
+ <li> <a href="../deployment-models.html" title="Deployment Models">Deployment Models</a>
+</li>
+
+ <li> <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
+</li>
+
+ <li> <a href="../node-types.html" title="Node Types">Node Types</a>
+</li>
+
+ <li> <a href="../object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
+</li>
+
+ <li> <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
+</li>
+
+ <li> <a href="../building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
+</li>
+
+ <li> <a href="../mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="../issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="../website.html" title="Website">Website</a>
+</li>
+
+ <li> <a href="../creating-releases.html" title="Creating Releases">Creating Releases</a>
+</li>
+
+ <li> <a href="../supporting-software-attribution.html" title="Attribution">Attribution</a>
+</li>
+
+ <li> <a href="../privacy-policy.html" title="Privacy">Privacy</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Apache Jackrabbit Site</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2015-04-08
+ </li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+
+ <li>
+
+ <a href="../index.html" title="Welcome">
+ <i class="none"></i>
+ Welcome</a>
+ </li>
+
+ <li>
+
+ <a href="../downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="../articles.html" title="Articles">
+ <i class="none"></i>
+ Articles</a>
+ </li>
+
+ <li>
+
+ <a href="../frequently-asked-questions.html" title="FAQ">
+ <i class="none"></i>
+ FAQ</a>
+ </li>
+
+ <li>
+
+ <a href="http://wiki.apache.org/jackrabbit/FrontPage" class="externalLink" title="Jackrabbit Wiki">
+ <i class="none"></i>
+ Jackrabbit Wiki</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-history.html" title="Jackrabbit History">
+ <i class="none"></i>
+ Jackrabbit History</a>
+ </li>
+ <li class="nav-header">Documentation</li>
+
+ <li>
+
+ <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="../standalone-server.html" title="Standalone Server">
+ <i class="none"></i>
+ Standalone Server</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-components.html" title="Jackrabbit Components">
+ <i class="none"></i>
+ Jackrabbit Components</a>
+ </li>
+
+ <li>
+
+ <a href="../first-hops.html" title="First Hops">
+ <i class="none"></i>
+ First Hops</a>
+ </li>
+
+ <li>
+
+ <a href="../jcr-api.html" title="JCR & API">
+ <i class="none"></i>
+ JCR & API</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">
+ <i class="none"></i>
+ Jackrabbit Architecture</a>
+ </li>
+
+ <li>
+
+ <a href="../deployment-models.html" title="Deployment Models">
+ <i class="none"></i>
+ Deployment Models</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">
+ <i class="none"></i>
+ Jackrabbit Configuration</a>
+ </li>
+
+ <li>
+
+ <a href="../node-types.html" title="Node Types">
+ <i class="none"></i>
+ Node Types</a>
+ </li>
+
+ <li>
+
+ <a href="../object-content-mapping.html" title="Object Content Mapping">
+ <i class="none"></i>
+ Object Content Mapping</a>
+ </li>
+ <li class="nav-header">Development</li>
+
+ <li>
+
+ <a href="../jackrabbit-team.html" title="Jackrabbit Team">
+ <i class="none"></i>
+ Jackrabbit Team</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
+ <i class="none"></i>
+ Jackrabbit Roadmap</a>
+ </li>
+
+ <li>
+
+ <a href="../building-jackrabbit.html" title="Building Jackrabbit">
+ <i class="none"></i>
+ Building Jackrabbit</a>
+ </li>
+
+ <li>
+
+ <a href="../mailing-lists.html" title="Mailing Lists">
+ <i class="none"></i>
+ Mailing Lists</a>
+ </li>
+
+ <li>
+
+ <a href="../issue-tracker.html" title="Issue Tracker">
+ <i class="none"></i>
+ Issue Tracker</a>
+ </li>
+
+ <li>
+
+ <a href="../source-repository.html" title="Source Repository">
+ <i class="none"></i>
+ Source Repository</a>
+ </li>
+
+ <li>
+
+ <a href="../continuous-integration.html" title="Continuous Integration">
+ <i class="none"></i>
+ Continuous Integration</a>
+ </li>
+
+ <li>
+
+ <a href="../website.html" title="Website">
+ <i class="none"></i>
+ Website</a>
+ </li>
+
+ <li>
+
+ <a href="../creating-releases.html" title="Creating Releases">
+ <i class="none"></i>
+ Creating Releases</a>
+ </li>
+
+ <li>
+
+ <a href="../supporting-software-attribution.html" title="Attribution">
+ <i class="none"></i>
+ Attribution</a>
+ </li>
+
+ <li>
+
+ <a href="../privacy-policy.html" title="Privacy">
+ <i class="none"></i>
+ Privacy</a>
+ </li>
+ <li class="nav-header">Apache Software Foundation</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
+ <i class="none"></i>
+ Introduction</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ <i class="none"></i>
+ Sponsorship</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
+ <i class="none"></i>
+ Current Sponsors</a>
+ </li>
+ </ul>
+
+
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- 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. --><h1>Mapping Strategies</h1>
+<p>We are calling “Mapping strategy” the algorithm used by the Persistence Manager to map a Java class into JCR nodes and/or properties.</p>
+<div class="section">
+<h2>The Object Model<a name="The_Object_Model"></a></h2>
+<p>In order to explain the basic mapping strategies, we will use the following simple object model :</p>
+
+<ul>
+
+<li>A page contains a path (of course), a pageInfo and a collection of paragraphs.</li>
+
+<li>The PageInfo class contains the title and the page description. We are using the pageInfo here to see all mapping features (see the bean-descriptors). In real application, this class is not necessary :-)</li>
+
+<li>Each paragraph contains a path and a text field.</li>
+</ul>
+<p>{center}!sample-model-doc.png!{center}</p>
+<p>This object model could be too simple for real applications and it is just used here to simplify the description of the different mapping strategies.</p></div>
+<div class="section">
+<h2>The Java Classes<a name="The_Java_Classes"></a></h2>
+<p>Based on that object model, we can define the following Java classes:</p>
+<p><b>Page.java</b></p>
+
+<div class="source">
+<pre>public class Page
+{
+ String path;
+ PageInfo pageInfo;
+ Collection paragraphs;
+
+ /* Add here the getter and setter methods */
+
+ public void addParagraph(Paragraph paragraph)
+ {
+ if (paragraphs == null)
+ {
+ paragraphs = new ArrayList();
+ }
+
+ paragraphs.add(paragraph);
+ }
+}
+</pre></div>
+<p><b>PageInfo.java</b></p>
+
+<div class="source">
+<pre>public class PageInfo
+{
+ String path;
+ String title;
+ String description;
+
+ /* Add here the getter and setter methods */
+
+}
+</pre></div>
+<p><b>Paragraph.java</b></p>
+
+<div class="source">
+<pre>public class Paragraph
+{
+ private String path;
+ private String text;
+
+ /* Add here the getter and setter methods */
+
+}
+</pre></div></div>
+<div class="section">
+<h2>The JCR Structure<a name="The_JCR_Structure"></a></h2>
+<p>Here is the resulting JCR structure if the page is stored on the path “/mysite/mypage1” and contains 2 paragraphs:</p>
+
+<div class="source">
+<pre>/mysite/page1
+ /mysite/page1/pageInfo
+ my:title = "This is my page title"
+ my:description = "This is my page description"
+ /mysite/page1/paragraphs
+ /mysite/page1/paragraphs/paragraph1
+ my:text = "This is the content of para1"
+ /mysite/page1/paragraphs/paragraph2
+ my:text = "This is the content of para2"
+</pre></div>
+<p>It is possible to have another kind of jcr structure by using other mapping strategies. See the sections <a href="mapping-atomic-fields.html">Mapping Atomic Fields</a> , [Mapping Bean Fields] , [Mapping Collection Fields] to get more information on that.</p></div>
+<div class="section">
+<h2>The Class Descriptors<a name="The_Class_Descriptors"></a></h2>
+<p>When you decide to map a bean class, you have to create a new class descriptor entry in the Persistence Manager descriptor file. Let’s start with the simplest class-descriptor:</p>
+<p>This class descriptor maps the class “org.apache.jackrabbit.ocm.testmodel.Paragraph” into the JCR type “nt:unstructured”. Each field-descriptor maps one bean field into a JCR property. For example, the first field descriptor maps the java bean field “text” into the jcr property called “myjcrtext”. The second field-descriptor is a specific case because it maps the jcr node path into a bean field called “path” (see below the section “The Path Field”).</p>
+<p>You can find more information on the field-descriptors in the page <a href="mapping-atomic-fields.html">Mapping Atomic Fields</a>.</p>
+<p>It is also possible to map a bean class to a particular JCR node type by specifying the desired type in the attribute jcrType. The following class-descriptor map the class “org.apache.jackrabbit.ocm.testmodel.Paragraph” into the node type “my:paragraph”.</p>
+<p>Here are the class-descriptors required to map the classes Page, PageInfo and Paragraph:</p>
+<p>In order to use correctly our example class with Apache Jackrabbit, you should import the following node type definitions with the Jackrabbit API.</p>
+<p>Of course, node types “my:Page” and “my:PageInfo” are also required.</p>
+<p>We are currently building a node type management tools which can import the node types from the class-descriptors.</p></div>
+<div class="section">
+<h2>The Path Field<a name="The_Path_Field"></a></h2>
+<p>Each mapped class contains a mandatory field called the “path field”. It contains the JCR path associated to the object. For example, the following descriptor specify the bean field “myPath” as the path field.</p>
+
+<div class="source">
+<pre><field-descriptor fieldName="myPath" path="true" />
+</pre></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Added: jackrabbit/site/live/jcr/ocm/object-content-manager.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/ocm/object-content-manager.html?rev=1672168&view=auto
==============================================================================
--- jackrabbit/site/live/jcr/ocm/object-content-manager.html (added)
+++ jackrabbit/site/live/jcr/ocm/object-content-manager.html Wed Apr 8 20:34:14 2015
@@ -0,0 +1,595 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-04-08
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20150408" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Jackrabbit - Object Content Manager</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <a class="brand" href="../index.html" title="Apache Jackrabbit">
+
+
+ <img src="../images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="Welcome">Welcome</a>
+</li>
+
+ <li> <a href="../downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="../articles.html" title="Articles">Articles</a>
+</li>
+
+ <li> <a href="../frequently-asked-questions.html" title="FAQ">FAQ</a>
+</li>
+
+ <li> <a href="http://wiki.apache.org/jackrabbit/FrontPage" title="Jackrabbit Wiki">Jackrabbit Wiki</a>
+</li>
+
+ <li> <a href="../jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../standalone-server.html" title="Standalone Server">Standalone Server</a>
+</li>
+
+ <li> <a href="../jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
+</li>
+
+ <li> <a href="../first-hops.html" title="First Hops">First Hops</a>
+</li>
+
+ <li> <a href="../jcr-api.html" title="JCR & API">JCR & API</a>
+</li>
+
+ <li> <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
+</li>
+
+ <li> <a href="../deployment-models.html" title="Deployment Models">Deployment Models</a>
+</li>
+
+ <li> <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
+</li>
+
+ <li> <a href="../node-types.html" title="Node Types">Node Types</a>
+</li>
+
+ <li> <a href="../object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
+</li>
+
+ <li> <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
+</li>
+
+ <li> <a href="../building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
+</li>
+
+ <li> <a href="../mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="../issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="../website.html" title="Website">Website</a>
+</li>
+
+ <li> <a href="../creating-releases.html" title="Creating Releases">Creating Releases</a>
+</li>
+
+ <li> <a href="../supporting-software-attribution.html" title="Attribution">Attribution</a>
+</li>
+
+ <li> <a href="../privacy-policy.html" title="Privacy">Privacy</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Apache Jackrabbit Site</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2015-04-08
+ </li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+
+ <li>
+
+ <a href="../index.html" title="Welcome">
+ <i class="none"></i>
+ Welcome</a>
+ </li>
+
+ <li>
+
+ <a href="../downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="../articles.html" title="Articles">
+ <i class="none"></i>
+ Articles</a>
+ </li>
+
+ <li>
+
+ <a href="../frequently-asked-questions.html" title="FAQ">
+ <i class="none"></i>
+ FAQ</a>
+ </li>
+
+ <li>
+
+ <a href="http://wiki.apache.org/jackrabbit/FrontPage" class="externalLink" title="Jackrabbit Wiki">
+ <i class="none"></i>
+ Jackrabbit Wiki</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-history.html" title="Jackrabbit History">
+ <i class="none"></i>
+ Jackrabbit History</a>
+ </li>
+ <li class="nav-header">Documentation</li>
+
+ <li>
+
+ <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="../standalone-server.html" title="Standalone Server">
+ <i class="none"></i>
+ Standalone Server</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-components.html" title="Jackrabbit Components">
+ <i class="none"></i>
+ Jackrabbit Components</a>
+ </li>
+
+ <li>
+
+ <a href="../first-hops.html" title="First Hops">
+ <i class="none"></i>
+ First Hops</a>
+ </li>
+
+ <li>
+
+ <a href="../jcr-api.html" title="JCR & API">
+ <i class="none"></i>
+ JCR & API</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">
+ <i class="none"></i>
+ Jackrabbit Architecture</a>
+ </li>
+
+ <li>
+
+ <a href="../deployment-models.html" title="Deployment Models">
+ <i class="none"></i>
+ Deployment Models</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">
+ <i class="none"></i>
+ Jackrabbit Configuration</a>
+ </li>
+
+ <li>
+
+ <a href="../node-types.html" title="Node Types">
+ <i class="none"></i>
+ Node Types</a>
+ </li>
+
+ <li>
+
+ <a href="../object-content-mapping.html" title="Object Content Mapping">
+ <i class="none"></i>
+ Object Content Mapping</a>
+ </li>
+ <li class="nav-header">Development</li>
+
+ <li>
+
+ <a href="../jackrabbit-team.html" title="Jackrabbit Team">
+ <i class="none"></i>
+ Jackrabbit Team</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
+ <i class="none"></i>
+ Jackrabbit Roadmap</a>
+ </li>
+
+ <li>
+
+ <a href="../building-jackrabbit.html" title="Building Jackrabbit">
+ <i class="none"></i>
+ Building Jackrabbit</a>
+ </li>
+
+ <li>
+
+ <a href="../mailing-lists.html" title="Mailing Lists">
+ <i class="none"></i>
+ Mailing Lists</a>
+ </li>
+
+ <li>
+
+ <a href="../issue-tracker.html" title="Issue Tracker">
+ <i class="none"></i>
+ Issue Tracker</a>
+ </li>
+
+ <li>
+
+ <a href="../source-repository.html" title="Source Repository">
+ <i class="none"></i>
+ Source Repository</a>
+ </li>
+
+ <li>
+
+ <a href="../continuous-integration.html" title="Continuous Integration">
+ <i class="none"></i>
+ Continuous Integration</a>
+ </li>
+
+ <li>
+
+ <a href="../website.html" title="Website">
+ <i class="none"></i>
+ Website</a>
+ </li>
+
+ <li>
+
+ <a href="../creating-releases.html" title="Creating Releases">
+ <i class="none"></i>
+ Creating Releases</a>
+ </li>
+
+ <li>
+
+ <a href="../supporting-software-attribution.html" title="Attribution">
+ <i class="none"></i>
+ Attribution</a>
+ </li>
+
+ <li>
+
+ <a href="../privacy-policy.html" title="Privacy">
+ <i class="none"></i>
+ Privacy</a>
+ </li>
+ <li class="nav-header">Apache Software Foundation</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
+ <i class="none"></i>
+ Introduction</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ <i class="none"></i>
+ Sponsorship</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
+ <i class="none"></i>
+ Current Sponsors</a>
+ </li>
+ </ul>
+
+
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- 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. --><h1>Object Content Manager</h1>
+<p>The main component in the OCM framework is the ObjectContentManager. It converts an object graph into JCR nodes and properties and vice versa. The ObjectContentManager is always associated with a JCR Session. It is used to retrieve, create, update and delete objects from a JCR content repository. Usually there is one ObjectContentManager per user session.</p>
+<p>This page describes how an ObjectContentManager is working and how it can be initialised in your applications. </p>
+<div class="section">
+<h2>How does the Object Content Manager work ?<a name="How_does_the_Object_Content_Manager_work_"></a></h2>
+<p>Thanks to a Mapping Descriptor, the ObjectContentManager is able to use the appropriate mapping strategy for each persistent object (pojo). The Mapping Descriptor contains one Class Descriptor per persistent class. Each Class Descriptor contains mapping information for the corresponding class attributes.</p>
+<p>In the point of view implementation, the Mappring Descriptor is a java object injected into the ObjectContentManager (see the interface org.apache.jackrabbit.ocm.mapper.Mapper). Right now, there are 2 different Mapping Descriptor implementations:</p>
+
+<ul>
+
+<li>Annotation : each persistent object is annoted in order to provide to the ObjectContentManager all the required information on its mapping strategy (see the class org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl).</li>
+
+<li>XML configuration file : the class descriptors are defined in one or more XML config files used by the ObjectContentManager when it is instantiated (see the class org.apache.jackrabbit.ocm.mapper.impl.digester.DigesterMapperImpl).</li>
+</ul>
+<p>For a business developer, it is not necessary to know how the ObjectContentManager is using the Class Descriptors. He has to make only a choice between annotated classes or XML files. Below, you can see how to setup correctly an ObjectContentManager. </p></div>
+<div class="section">
+<h2>How does an object is persisted into a JCR repository ?<a name="How_does_an_object_is_persisted_into_a_JCR_repository_"></a></h2>
+<p>In all cases, a persistent object (a pojo) is mapped into a JCR node and its fields are mapped into subnodes or properties depending on their types.</p>
+<p>There are 3 “field types”:</p>
+
+<ul>
+
+<li>
+<p>Atomic fields<br />Primitive data types and simple objects (String, Long, Double, …) . Those fields are mapped into JCR properties.</p></li>
+
+<li>
+<p>Bean fields<br />One class can contain an 1..1 association to another bean. In this case, the field is a custom object. Those fields are mapped into JCR subnodes or a referenced node. </p></li>
+
+<li>
+<p>Collection fields<br />One class can contain an 1..n association to a collection of beans (or Map). Those fields are mapped into a collection of JCR subnodes or a collection of referenced nodes. It is also possible to map a java collection into a multivalue property. </p></li>
+</ul>
+<p>The Mapping descriptor contains also information on inheritances, interface mapping strategy, lazy loading, custom converter, cache strategy, etc. </p></div>
+<div class="section">
+<h2>Basic setup (with annotated persistent classes)<a name="Basic_setup_with_annotated_persistent_classes"></a></h2>
+<p>When you start your application, you need the following code to initialize correctly the Object Content Manager.</p>
+
+<div class="source">
+<pre>import javax.jcr.Session;
+import javax.jcr.Repository;
+
+import org.apache.jackrabbit.ocm.manager.impl.ObjectContentManagerImpl;
+import org.apache.jackrabbit.ocm.mapper.Mapper;
+import org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl;
+
+
+// 1. Instantiate a JCR session
+Repository repository = ...;
+Session session = repository.login(...);
+
+// 2. Register the different persistent classes
+List classes = new ArrayList();
+classes.add(MyContent.class); // Call this method for each persistent class
+
+
+// 3. Instantiate the object content manager
+Mapper mapper = new AnnotationMapperImpl(classes);
+ObjectContentManager ocm = new ObjectContentManagerImpl(session, mapper);
+</pre></div></div>
+<div class="section">
+<h2>Basic setup (with one or more XML Mapping Descriptor files)<a name="Basic_setup_with_one_or_more_XML_Mapping_Descriptor_files"></a></h2>
+<p>When you start your application, you need the following code to initialize correctly the Object Content Manager.</p>
+
+<div class="source">
+<pre>import javax.jcr.Session;
+import javax.jcr.Repository;
+
+import org.apache.jackrabbit.ocm.mapper.Mapper;
+import org.apache.jackrabbit.ocm.mapper.impl.digester.DigesterMapperImpl;
+import org.apache.jackrabbit.ocm.manager.ObjectContentManager;
+import org.apache.jackrabbit.ocm.manager.impl.ObjectContentManagerImpl;
+import org.apache.jackrabbit.ocm.manager.atomictypeconverter.AtomicTypeConverterProvider;
+import org.apache.jackrabbit.ocm.manager.atomictypeconverter.impl.DefaultAtomicTypeConverterProvider;
+import org.apache.jackrabbit.ocm.manager.objectconverter.ObjectConverter;
+import org.apache.jackrabbit.ocm.manager.objectconverter.impl.ObjectConverterImpl;
+import org.apache.jackrabbit.ocm.query.QueryManager;
+import org.apache.jackrabbit.ocm.query.impl.QueryManagerImpl;
+
+// 1. Instantiate a JCR session
+Repository repository = ...;
+Session session = repository.login(...);
+
+// 2. Specify the different mapping files
+String[] files = {
+ "./src/test-config/jcrmapping.xml",
+ "./src/test-config/jcrmapping-atomic.xml",
+ "./src/test-config/jcrmapping-beandescriptor.xml"
+ };
+
+// 3. Instantiate the object content manager
+ObjectContentManager ocm = new ObjectContentManagerImpl(session, files);
+</pre></div></div>
+<div class="section">
+<h2>API Overview<a name="API_Overview"></a></h2>
+<p>With the current Object Manager API, it is possible to:</p>
+
+<ul>
+
+<li>Manage the object life cycle (insert, update, delete, retrieve). See <a href="basic-ocm-operations.html">Basic OCM operations</a> .</li>
+
+<li>Search single object or collections with criteria. See <a href="ocm-search.html">OCM Search</a> .</li>
+
+<li>Lock objects. See <a href="ocm-locking.html">OCM Locking</a> .</li>
+
+<li>Manage versions (check int, check out, create a new version, show history). See <a href="ocm-version-management.html">OCM Version Management</a> .</li>
+</ul>
+<p>We plan to add other features in a future release. </p></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Added: jackrabbit/site/live/jcr/ocm/ocm-locking.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/ocm/ocm-locking.html?rev=1672168&view=auto
==============================================================================
--- jackrabbit/site/live/jcr/ocm/ocm-locking.html (added)
+++ jackrabbit/site/live/jcr/ocm/ocm-locking.html Wed Apr 8 20:34:14 2015
@@ -0,0 +1,555 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-04-08
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20150408" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Jackrabbit - OCM Locking</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <a class="brand" href="../index.html" title="Apache Jackrabbit">
+
+
+ <img src="../images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="Welcome">Welcome</a>
+</li>
+
+ <li> <a href="../downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="../articles.html" title="Articles">Articles</a>
+</li>
+
+ <li> <a href="../frequently-asked-questions.html" title="FAQ">FAQ</a>
+</li>
+
+ <li> <a href="http://wiki.apache.org/jackrabbit/FrontPage" title="Jackrabbit Wiki">Jackrabbit Wiki</a>
+</li>
+
+ <li> <a href="../jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../standalone-server.html" title="Standalone Server">Standalone Server</a>
+</li>
+
+ <li> <a href="../jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
+</li>
+
+ <li> <a href="../first-hops.html" title="First Hops">First Hops</a>
+</li>
+
+ <li> <a href="../jcr-api.html" title="JCR & API">JCR & API</a>
+</li>
+
+ <li> <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
+</li>
+
+ <li> <a href="../deployment-models.html" title="Deployment Models">Deployment Models</a>
+</li>
+
+ <li> <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
+</li>
+
+ <li> <a href="../node-types.html" title="Node Types">Node Types</a>
+</li>
+
+ <li> <a href="../object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
+</li>
+
+ <li> <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
+</li>
+
+ <li> <a href="../building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
+</li>
+
+ <li> <a href="../mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="../issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="../website.html" title="Website">Website</a>
+</li>
+
+ <li> <a href="../creating-releases.html" title="Creating Releases">Creating Releases</a>
+</li>
+
+ <li> <a href="../supporting-software-attribution.html" title="Attribution">Attribution</a>
+</li>
+
+ <li> <a href="../privacy-policy.html" title="Privacy">Privacy</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Apache Jackrabbit Site</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2015-04-08
+ </li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+
+ <li>
+
+ <a href="../index.html" title="Welcome">
+ <i class="none"></i>
+ Welcome</a>
+ </li>
+
+ <li>
+
+ <a href="../downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="../articles.html" title="Articles">
+ <i class="none"></i>
+ Articles</a>
+ </li>
+
+ <li>
+
+ <a href="../frequently-asked-questions.html" title="FAQ">
+ <i class="none"></i>
+ FAQ</a>
+ </li>
+
+ <li>
+
+ <a href="http://wiki.apache.org/jackrabbit/FrontPage" class="externalLink" title="Jackrabbit Wiki">
+ <i class="none"></i>
+ Jackrabbit Wiki</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-history.html" title="Jackrabbit History">
+ <i class="none"></i>
+ Jackrabbit History</a>
+ </li>
+ <li class="nav-header">Documentation</li>
+
+ <li>
+
+ <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="../standalone-server.html" title="Standalone Server">
+ <i class="none"></i>
+ Standalone Server</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-components.html" title="Jackrabbit Components">
+ <i class="none"></i>
+ Jackrabbit Components</a>
+ </li>
+
+ <li>
+
+ <a href="../first-hops.html" title="First Hops">
+ <i class="none"></i>
+ First Hops</a>
+ </li>
+
+ <li>
+
+ <a href="../jcr-api.html" title="JCR & API">
+ <i class="none"></i>
+ JCR & API</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">
+ <i class="none"></i>
+ Jackrabbit Architecture</a>
+ </li>
+
+ <li>
+
+ <a href="../deployment-models.html" title="Deployment Models">
+ <i class="none"></i>
+ Deployment Models</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">
+ <i class="none"></i>
+ Jackrabbit Configuration</a>
+ </li>
+
+ <li>
+
+ <a href="../node-types.html" title="Node Types">
+ <i class="none"></i>
+ Node Types</a>
+ </li>
+
+ <li>
+
+ <a href="../object-content-mapping.html" title="Object Content Mapping">
+ <i class="none"></i>
+ Object Content Mapping</a>
+ </li>
+ <li class="nav-header">Development</li>
+
+ <li>
+
+ <a href="../jackrabbit-team.html" title="Jackrabbit Team">
+ <i class="none"></i>
+ Jackrabbit Team</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
+ <i class="none"></i>
+ Jackrabbit Roadmap</a>
+ </li>
+
+ <li>
+
+ <a href="../building-jackrabbit.html" title="Building Jackrabbit">
+ <i class="none"></i>
+ Building Jackrabbit</a>
+ </li>
+
+ <li>
+
+ <a href="../mailing-lists.html" title="Mailing Lists">
+ <i class="none"></i>
+ Mailing Lists</a>
+ </li>
+
+ <li>
+
+ <a href="../issue-tracker.html" title="Issue Tracker">
+ <i class="none"></i>
+ Issue Tracker</a>
+ </li>
+
+ <li>
+
+ <a href="../source-repository.html" title="Source Repository">
+ <i class="none"></i>
+ Source Repository</a>
+ </li>
+
+ <li>
+
+ <a href="../continuous-integration.html" title="Continuous Integration">
+ <i class="none"></i>
+ Continuous Integration</a>
+ </li>
+
+ <li>
+
+ <a href="../website.html" title="Website">
+ <i class="none"></i>
+ Website</a>
+ </li>
+
+ <li>
+
+ <a href="../creating-releases.html" title="Creating Releases">
+ <i class="none"></i>
+ Creating Releases</a>
+ </li>
+
+ <li>
+
+ <a href="../supporting-software-attribution.html" title="Attribution">
+ <i class="none"></i>
+ Attribution</a>
+ </li>
+
+ <li>
+
+ <a href="../privacy-policy.html" title="Privacy">
+ <i class="none"></i>
+ Privacy</a>
+ </li>
+ <li class="nav-header">Apache Software Foundation</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
+ <i class="none"></i>
+ Introduction</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ <i class="none"></i>
+ Sponsorship</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
+ <i class="none"></i>
+ Current Sponsors</a>
+ </li>
+ </ul>
+
+
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- 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. --><h1>OCM Locking</h1>
+<p>Following the Jcr specification, it is possible to lock nodes and their children (see section 8.4). You can see on this page the OCM API used to lock on the object level. In order to lock an object, its matching node has to implement the jcr mixin type “mix:lockable”. It is possible to specify this node type in the class descriptor:</p>
+<div class="section">
+<h2>A basic example<a name="A_basic_example"></a></h2>
+
+<div class="source">
+<pre>// --------------------------------------------------------------------------------
+// Create and store an object graph in the repository
+// --------------------------------------------------------------------------------
+A a = new A();
+a.setPath("/test");
+a.setA1("a1");
+a.setA2("a2");
+B b = new B();
+b.setB1("b1");
+b.setB2("b2");
+a.setB(b);
+
+C c1 = new C();
+c1.setId("first");
+c1.setName("First Element");
+C c2 = new C();
+c2.setId("second");
+c2.setName("Second Element");
+
+C c3 = new C();
+c3.setId("third");
+c3.setName("Third Element");
+
+Collection collection = new ArrayList();
+collection.add(c1);
+collection.add(c2);
+collection.add(c3);
+
+a.setCollection(collection);
+
+ocm.insert(a);
+ocm.save();
+
+
+// --------------------------------------------------------------------------------
+// Check if the object is not locked
+// --------------------------------------------------------------------------------
+if (ocm.isLocked("/test"))
+{
+ System.out.println("Error : The object is locked- humm ??");
+}
+
+// --------------------------------------------------------------------------------
+// Lock the object
+// --------------------------------------------------------------------------------
+String lockToken = ocm.lock("/test", true, false);
+
+// --------------------------------------------------------------------------------
+// Check if the object is not locked
+// --------------------------------------------------------------------------------
+if (! ocm.isLocked("/test"))
+{
+ System.out.println("Error : The object is not locked- humm ??");
+}
+
+// --------------------------------------------------------------------------------
+// Unlock the object
+// --------------------------------------------------------------------------------
+ocm.unlock("/test", lockToken);
+</pre></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Added: jackrabbit/site/live/jcr/ocm/ocm-search.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/ocm/ocm-search.html?rev=1672168&view=auto
==============================================================================
--- jackrabbit/site/live/jcr/ocm/ocm-search.html (added)
+++ jackrabbit/site/live/jcr/ocm/ocm-search.html Wed Apr 8 20:34:14 2015
@@ -0,0 +1,534 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-04-08
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20150408" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Jackrabbit - OCM Search</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <a class="brand" href="../index.html" title="Apache Jackrabbit">
+
+
+ <img src="../images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="Welcome">Welcome</a>
+</li>
+
+ <li> <a href="../downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="../articles.html" title="Articles">Articles</a>
+</li>
+
+ <li> <a href="../frequently-asked-questions.html" title="FAQ">FAQ</a>
+</li>
+
+ <li> <a href="http://wiki.apache.org/jackrabbit/FrontPage" title="Jackrabbit Wiki">Jackrabbit Wiki</a>
+</li>
+
+ <li> <a href="../jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../standalone-server.html" title="Standalone Server">Standalone Server</a>
+</li>
+
+ <li> <a href="../jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
+</li>
+
+ <li> <a href="../first-hops.html" title="First Hops">First Hops</a>
+</li>
+
+ <li> <a href="../jcr-api.html" title="JCR & API">JCR & API</a>
+</li>
+
+ <li> <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
+</li>
+
+ <li> <a href="../deployment-models.html" title="Deployment Models">Deployment Models</a>
+</li>
+
+ <li> <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
+</li>
+
+ <li> <a href="../node-types.html" title="Node Types">Node Types</a>
+</li>
+
+ <li> <a href="../object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
+</li>
+
+ <li> <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
+</li>
+
+ <li> <a href="../building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
+</li>
+
+ <li> <a href="../mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="../issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="../website.html" title="Website">Website</a>
+</li>
+
+ <li> <a href="../creating-releases.html" title="Creating Releases">Creating Releases</a>
+</li>
+
+ <li> <a href="../supporting-software-attribution.html" title="Attribution">Attribution</a>
+</li>
+
+ <li> <a href="../privacy-policy.html" title="Privacy">Privacy</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Apache Jackrabbit Site</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2015-04-08
+ </li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+
+ <li>
+
+ <a href="../index.html" title="Welcome">
+ <i class="none"></i>
+ Welcome</a>
+ </li>
+
+ <li>
+
+ <a href="../downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="../articles.html" title="Articles">
+ <i class="none"></i>
+ Articles</a>
+ </li>
+
+ <li>
+
+ <a href="../frequently-asked-questions.html" title="FAQ">
+ <i class="none"></i>
+ FAQ</a>
+ </li>
+
+ <li>
+
+ <a href="http://wiki.apache.org/jackrabbit/FrontPage" class="externalLink" title="Jackrabbit Wiki">
+ <i class="none"></i>
+ Jackrabbit Wiki</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-history.html" title="Jackrabbit History">
+ <i class="none"></i>
+ Jackrabbit History</a>
+ </li>
+ <li class="nav-header">Documentation</li>
+
+ <li>
+
+ <a href="../getting-started-with-apache-jackrabbit.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="../standalone-server.html" title="Standalone Server">
+ <i class="none"></i>
+ Standalone Server</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-components.html" title="Jackrabbit Components">
+ <i class="none"></i>
+ Jackrabbit Components</a>
+ </li>
+
+ <li>
+
+ <a href="../first-hops.html" title="First Hops">
+ <i class="none"></i>
+ First Hops</a>
+ </li>
+
+ <li>
+
+ <a href="../jcr-api.html" title="JCR & API">
+ <i class="none"></i>
+ JCR & API</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-architecture.html" title="Jackrabbit Architecture">
+ <i class="none"></i>
+ Jackrabbit Architecture</a>
+ </li>
+
+ <li>
+
+ <a href="../deployment-models.html" title="Deployment Models">
+ <i class="none"></i>
+ Deployment Models</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-configuration.html" title="Jackrabbit Configuration">
+ <i class="none"></i>
+ Jackrabbit Configuration</a>
+ </li>
+
+ <li>
+
+ <a href="../node-types.html" title="Node Types">
+ <i class="none"></i>
+ Node Types</a>
+ </li>
+
+ <li>
+
+ <a href="../object-content-mapping.html" title="Object Content Mapping">
+ <i class="none"></i>
+ Object Content Mapping</a>
+ </li>
+ <li class="nav-header">Development</li>
+
+ <li>
+
+ <a href="../jackrabbit-team.html" title="Jackrabbit Team">
+ <i class="none"></i>
+ Jackrabbit Team</a>
+ </li>
+
+ <li>
+
+ <a href="../jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
+ <i class="none"></i>
+ Jackrabbit Roadmap</a>
+ </li>
+
+ <li>
+
+ <a href="../building-jackrabbit.html" title="Building Jackrabbit">
+ <i class="none"></i>
+ Building Jackrabbit</a>
+ </li>
+
+ <li>
+
+ <a href="../mailing-lists.html" title="Mailing Lists">
+ <i class="none"></i>
+ Mailing Lists</a>
+ </li>
+
+ <li>
+
+ <a href="../issue-tracker.html" title="Issue Tracker">
+ <i class="none"></i>
+ Issue Tracker</a>
+ </li>
+
+ <li>
+
+ <a href="../source-repository.html" title="Source Repository">
+ <i class="none"></i>
+ Source Repository</a>
+ </li>
+
+ <li>
+
+ <a href="../continuous-integration.html" title="Continuous Integration">
+ <i class="none"></i>
+ Continuous Integration</a>
+ </li>
+
+ <li>
+
+ <a href="../website.html" title="Website">
+ <i class="none"></i>
+ Website</a>
+ </li>
+
+ <li>
+
+ <a href="../creating-releases.html" title="Creating Releases">
+ <i class="none"></i>
+ Creating Releases</a>
+ </li>
+
+ <li>
+
+ <a href="../supporting-software-attribution.html" title="Attribution">
+ <i class="none"></i>
+ Attribution</a>
+ </li>
+
+ <li>
+
+ <a href="../privacy-policy.html" title="Privacy">
+ <i class="none"></i>
+ Privacy</a>
+ </li>
+ <li class="nav-header">Apache Software Foundation</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
+ <i class="none"></i>
+ Introduction</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ <i class="none"></i>
+ Sponsorship</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
+ <i class="none"></i>
+ Current Sponsors</a>
+ </li>
+ </ul>
+
+
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- 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. --><h1>OCM Search</h1>
+<div class="section">
+<h2>Searching a single object<a name="Searching_a_single_object"></a></h2>
+
+<div class="source">
+<pre>QueryManager queryManager = ocm.getQueryManager();
+
+// Build the search filter
+Filter filter = queryManager.createFilter(Paragraph.class);
+filter.addEqualTo("text", "Para 1"); // Text is an attribute in the class Paragraph
+
+// Build the query
+Query query = queryManager.createQuery(filter);
+Paragraph paragraph = (Paragraph) ocm.getObject(query);
+</pre></div></div>
+<div class="section">
+<h2>Searching a collection<a name="Searching_a_collection"></a></h2>
+
+<div class="source">
+<pre>QueryManager queryManager = ocm.getQueryManager();
+Filter filter = queryManager.createFilter(Paragraph.class);
+filter.setScope("/test/node1//");
+Query query = queryManager.createQuery(filter);
+Collection result = ocm.getObjects(query);
+</pre></div></div>
+<div class="section">
+<h2>Searching with an iterator<a name="Searching_with_an_iterator"></a></h2>
+
+<div class="source">
+<pre>QueryManager queryManager = ocm.getQueryManager();
+Filter filter = queryManager.createFilter(Paragraph.class);
+filter.setScope("/test/node1//");
+Query query = queryManager.createQuery(filter);
+Iterator iterator = ocm.getObjectIterator(query);
+</pre></div></div>
+<div class="section">
+<h2>Remove objects based on a query<a name="Remove_objects_based_on_a_query"></a></h2>
+
+<div class="source">
+<pre>QueryManager queryManager = ocm.getQueryManager();
+Filter filter = queryManager.createFilter(Paragraph.class);
+filter.setScope("/test/node1//");
+Query query = queryManager.createQuery(filter);
+ocm.remove(query);
+</pre></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file