blob: 917c14b057108636eebbc26a6d2464066319da86 [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_121) on Fri Jan 06 19:36:35 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComparisonStyle (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComparisonStyle (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</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/ComparisonStyle.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/openjpa/persistence/criteria/BindableParameter.html" title="interface in org.apache.openjpa.persistence.criteria"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.Default.html" title="class in org.apache.openjpa.persistence.criteria"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/criteria/ComparisonStyle.html" target="_top">Frames</a></li>
<li><a href="ComparisonStyle.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><a href="#nested_class_summary">Nested</a>&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.openjpa.persistence.criteria</div>
<h2 title="Interface ComparisonStyle" class="title">Interface ComparisonStyle</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/openjpa/persistence/criteria/ComparisonStyle.Default.html" title="class in org.apache.openjpa.persistence.criteria">ComparisonStyle.Default</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ComparisonStyle</span></pre>
<div class="block">Defines a comparison style to be applied for query-by-example attribute comparison.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Pinaki Poddar</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.Default.html" title="class in org.apache.openjpa.persistence.criteria">ComparisonStyle.Default</a></strong></code>
<div class="block">Default implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.StringComparisonMode.html" title="enum in org.apache.openjpa.persistence.criteria">ComparisonStyle.StringComparisonMode</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#excludeDefault()">excludeDefault</a></strong>()</code>
<div class="block">Affirms if the default-valued attribute be excluded from comparison.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#excludeIdentity()">excludeIdentity</a></strong>()</code>
<div class="block">Affirms if the identity attribute be excluded from comparison.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#excludeNull()">excludeNull</a></strong>()</code>
<div class="block">Affirms if the null-valued attribute be excluded from comparison.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#excludeVersion()">excludeVersion</a></strong>()</code>
<div class="block">Affirms if the version attribute be excluded from comparison.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.StringComparisonMode.html" title="enum in org.apache.openjpa.persistence.criteria">ComparisonStyle.StringComparisonMode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#getStringComparsionMode()">getStringComparsionMode</a></strong>()</code>
<div class="block">Gets how string-valued attributes be compared.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#isDisjunction()">isDisjunction</a></strong>()</code>
<div class="block">Affirms if the attribute comparisons are OR'ed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setDisjunction(boolean)">setDisjunction</a></strong>(boolean&nbsp;flag)</code>
<div class="block">Sets whether the comparison to OR the attribute comparisons.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setExcludeDefault(boolean)">setExcludeDefault</a></strong>(boolean&nbsp;flag)</code>
<div class="block">Sets whether the comparison excludes default-valued attributes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setExcludeIdentity(boolean)">setExcludeIdentity</a></strong>(boolean&nbsp;flag)</code>
<div class="block">Sets whether the comparison excludes identity attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setExcludeNull(boolean)">setExcludeNull</a></strong>(boolean&nbsp;flag)</code>
<div class="block">Sets whether the comparison excludes null-valued attributes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setExcludeVersion(boolean)">setExcludeVersion</a></strong>(boolean&nbsp;flag)</code>
<div class="block">Sets whether the comparison excludes version attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html#setStringComparisonMode(org.apache.openjpa.persistence.criteria.ComparisonStyle.StringComparisonMode)">setStringComparisonMode</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.StringComparisonMode.html" title="enum in org.apache.openjpa.persistence.criteria">ComparisonStyle.StringComparisonMode</a>&nbsp;mode)</code>
<div class="block">Sets the comparison mode for String-valued attributes.</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="isDisjunction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDisjunction</h4>
<pre>boolean&nbsp;isDisjunction()</pre>
<div class="block">Affirms if the attribute comparisons are OR'ed.
Defaults to false.</div>
</li>
</ul>
<a name="setDisjunction(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisjunction</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setDisjunction(boolean&nbsp;flag)</pre>
<div class="block">Sets whether the comparison to OR the attribute comparisons.</div>
</li>
</ul>
<a name="excludeNull()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeNull</h4>
<pre>boolean&nbsp;excludeNull()</pre>
<div class="block">Affirms if the null-valued attribute be excluded from comparison.
Defaults to true.</div>
</li>
</ul>
<a name="setExcludeNull(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludeNull</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setExcludeNull(boolean&nbsp;flag)</pre>
<div class="block">Sets whether the comparison excludes null-valued attributes.</div>
</li>
</ul>
<a name="excludeIdentity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeIdentity</h4>
<pre>boolean&nbsp;excludeIdentity()</pre>
<div class="block">Affirms if the identity attribute be excluded from comparison.
Defaults to true.</div>
</li>
</ul>
<a name="setExcludeIdentity(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludeIdentity</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setExcludeIdentity(boolean&nbsp;flag)</pre>
<div class="block">Sets whether the comparison excludes identity attribute.</div>
</li>
</ul>
<a name="excludeVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeVersion</h4>
<pre>boolean&nbsp;excludeVersion()</pre>
<div class="block">Affirms if the version attribute be excluded from comparison.
Defaults to true.</div>
</li>
</ul>
<a name="setExcludeVersion(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludeVersion</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setExcludeVersion(boolean&nbsp;flag)</pre>
<div class="block">Sets whether the comparison excludes version attribute.</div>
</li>
</ul>
<a name="excludeDefault()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeDefault</h4>
<pre>boolean&nbsp;excludeDefault()</pre>
<div class="block">Affirms if the default-valued attribute be excluded from comparison.
Defaults to true.</div>
</li>
</ul>
<a name="setExcludeDefault(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludeDefault</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setExcludeDefault(boolean&nbsp;flag)</pre>
<div class="block">Sets whether the comparison excludes default-valued attributes.</div>
</li>
</ul>
<a name="getStringComparsionMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringComparsionMode</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.StringComparisonMode.html" title="enum in org.apache.openjpa.persistence.criteria">ComparisonStyle.StringComparisonMode</a>&nbsp;getStringComparsionMode()</pre>
<div class="block">Gets how string-valued attributes be compared.</div>
</li>
</ul>
<a name="setStringComparisonMode(org.apache.openjpa.persistence.criteria.ComparisonStyle.StringComparisonMode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setStringComparisonMode</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.html" title="interface in org.apache.openjpa.persistence.criteria">ComparisonStyle</a>&nbsp;setStringComparisonMode(<a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.StringComparisonMode.html" title="enum in org.apache.openjpa.persistence.criteria">ComparisonStyle.StringComparisonMode</a>&nbsp;mode)</pre>
<div class="block">Sets the comparison mode for String-valued attributes.</div>
</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/ComparisonStyle.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/openjpa/persistence/criteria/BindableParameter.html" title="interface in org.apache.openjpa.persistence.criteria"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/criteria/ComparisonStyle.Default.html" title="class in org.apache.openjpa.persistence.criteria"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/criteria/ComparisonStyle.html" target="_top">Frames</a></li>
<li><a href="ComparisonStyle.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><a href="#nested_class_summary">Nested</a>&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; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>