Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / 0.10.0 / maven / apidocs / org / apache / chemistry / opencmis / jcr / query / IdentifierMap.html
blob: 9149117b9c7aed80867286fdc8d1761b5584d4ca [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_07) on Wed Sep 18 17:57:26 EDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IdentifierMap (Apache Chemistry OpenCMIS 0.10.0 API)</title>
<meta name="date" content="2013-09-18">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IdentifierMap (Apache Chemistry OpenCMIS 0.10.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IdentifierMap.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/EvaluatorXPath.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMapBase.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html" target="_top">Frames</a></li>
<li><a href="IdentifierMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.chemistry.opencmis.jcr.query</div>
<h2 title="Interface IdentifierMap" class="title">Interface IdentifierMap</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/jcr/impl/DefaultDocumentIdentifierMap.html" title="class in org.apache.chemistry.opencmis.jcr.impl">DefaultDocumentIdentifierMap</a>, <a href="../../../../../../org/apache/chemistry/opencmis/jcr/impl/DefaultIdentifierMapBase.html" title="class in org.apache.chemistry.opencmis.jcr.impl">DefaultIdentifierMapBase</a>, <a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMapBase.html" title="class in org.apache.chemistry.opencmis.jcr.query">IdentifierMapBase</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IdentifierMap</span></pre>
<div class="block">The methods of this class map CMIS identifiers to JCR identifiers. Each implementation
of this interface is bound to a specific CMIS object type. That is, it implements the
identifier maps for that object type.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrPathFromCol(java.lang.String)">jcrPathFromCol</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Map a column name in the CMIS query to the corresponding relative JCR path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrTypeCondition()">jcrTypeCondition</a></strong>()</code>
<div class="block">Create and additional condition in order for the query to only return nodes
of the right type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrTypeName()">jcrTypeName</a></strong>()</code>
<div class="block">JCR type name corresponding to the CMIS type bound to this instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="jcrPathFromCol(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jcrPathFromCol</h4>
<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jcrPathFromCol(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Map a column name in the CMIS query to the corresponding relative JCR path.
The path must be relative to the context node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - column name</dd>
<dt><span class="strong">Returns:</span></dt><dd>relative JCR path</dd></dl>
</li>
</ul>
<a name="jcrTypeName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jcrTypeName</h4>
<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jcrTypeName()</pre>
<div class="block">JCR type name corresponding to the CMIS type bound to this instance.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>name of the JCR type</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrTypeCondition()"><code>jcrTypeCondition()</code></a></dd></dl>
</li>
</ul>
<a name="jcrTypeCondition()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jcrTypeCondition</h4>
<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jcrTypeCondition()</pre>
<div class="block">Create and additional condition in order for the query to only return nodes
of the right type. This condition and-ed to the condition determined by the
CMIS query's where clause.
<p/>
A CMIS query for non versionable documents should for example result in the
following XPath query:
<p/>
<pre>
element(*, nt:file)[not(@jcr:mixinTypes = 'mix:simpleVersionable')]
</pre>
Here the element test is covered by <a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrTypeName()"><code>jcrTypeName()</code></a>
while the predicate is covered by this method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Additional condition or <code>null</code> if none.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html#jcrTypeName()"><code>jcrTypeName()</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IdentifierMap.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/EvaluatorXPath.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/IdentifierMapBase.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/jcr/query/IdentifierMap.html" target="_top">Frames</a></li>
<li><a href="IdentifierMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>