Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.1 / apidocs / org / apache / openjpa / jdbc / kernel / exps / FilterValue.html
blob: ce0818c493c9747e3eea869950a743c20a3e8a77 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:43 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FilterValue (OpenJPA Parent POM 2.4.1 API)</title>
<meta name="date" content="2016-03-21">
<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="FilterValue (OpenJPA Parent POM 2.4.1 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/FilterValue.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/jdbc/kernel/exps/ExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/GeneralCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" target="_top">Frames</a></li>
<li><a href="FilterValue.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.openjpa.jdbc.kernel.exps</div>
<h2 title="Interface FilterValue" class="title">Interface FilterValue</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">FilterValue</span></pre>
<div class="block">The simplified public view of any non-operator in a query filter,
including constants, variables, and object fields.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</dd></dl>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer)">appendTo</a></strong>(<a href="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</a>&nbsp;buf)</code>
<div class="block">Append the first SQL element for this value to the given buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer,%20int)">appendTo</a></strong>(<a href="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</a>&nbsp;buf,
int&nbsp;index)</code>
<div class="block">Append the <code>index</code>th SQL element for this value to the
given buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getClassMapping()">getClassMapping</a></strong>()</code>
<div class="block">If this is a path to a persistent object, return its class mapping,
else return null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/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/openjpa/jdbc/kernel/exps/FilterValue.html#getColumnAlias(org.apache.openjpa.jdbc.schema.Column)">getColumnAlias</a></strong>(<a href="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>&nbsp;col)</code>
<div class="block">Return the alias to use for the given column (this includes the table
alias prefix, if any).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/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/openjpa/jdbc/kernel/exps/FilterValue.html#getColumnAlias(java.lang.String,%20org.apache.openjpa.jdbc.schema.Table)">getColumnAlias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;col,
<a href="../../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</code>
<div class="block">Return the alias to use for the given column (this includes the table
alias prefix, if any).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getFieldMapping()">getFieldMapping</a></strong>()</code>
<div class="block">If this is a path to a persistent field, return its mapping, else
return null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getSQLValue()">getSQLValue</a></strong>()</code>
<div class="block">If this is a constant, returns its value as it would be represented
in the database in this context, else return null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getType()">getType</a></strong>()</code>
<div class="block">Return the expected type of this value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getValue()">getValue</a></strong>()</code>
<div class="block">If this is a constant, return its value, else return null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getXmlMapping()">getXmlMapping</a></strong>()</code>
<div class="block">If this is an XPath, return XML mapping metadata,
else return null;</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/PCPath.html" title="class in org.apache.openjpa.jdbc.kernel.exps">PCPath</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#getXPath()">getXPath</a></strong>()</code>
<div class="block">If this is an XPath, return it,
else return null;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#isConstant()">isConstant</a></strong>()</code>
<div class="block">Return true if this value represents a literal or parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#isPath()">isPath</a></strong>()</code>
<div class="block">Return true if this value represents a persistent field traversal,
such as 'this', 'address.street', or 'projectVariable.title'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#length()">length</a></strong>()</code>
<div class="block">Return the number of SQL elements in this value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#requiresCast()">requiresCast</a></strong>()</code>
<div class="block">return true if CAST is required for this filter value
else return false.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html#toDataStoreValue(java.lang.Object)">toDataStoreValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Transform the given value into its datastore equivalent.</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="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getType()</pre>
<div class="block">Return the expected type of this value.</div>
</li>
</ul>
<a name="length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre>int&nbsp;length()</pre>
<div class="block">Return the number of SQL elements in this value. Usually 1.</div>
</li>
</ul>
<a name="appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTo</h4>
<pre>void&nbsp;appendTo(<a href="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</a>&nbsp;buf)</pre>
<div class="block">Append the first SQL element for this value to the given buffer.</div>
</li>
</ul>
<a name="appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTo</h4>
<pre>void&nbsp;appendTo(<a href="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</a>&nbsp;buf,
int&nbsp;index)</pre>
<div class="block">Append the <code>index</code>th SQL element for this value to the
given buffer.</div>
</li>
</ul>
<a name="getColumnAlias(org.apache.openjpa.jdbc.schema.Column)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnAlias</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getColumnAlias(<a href="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>&nbsp;col)</pre>
<div class="block">Return the alias to use for the given column (this includes the table
alias prefix, if any).</div>
</li>
</ul>
<a name="getColumnAlias(java.lang.String, org.apache.openjpa.jdbc.schema.Table)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnAlias</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getColumnAlias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;col,
<a href="../../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</pre>
<div class="block">Return the alias to use for the given column (this includes the table
alias prefix, if any).</div>
</li>
</ul>
<a name="toDataStoreValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDataStoreValue</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;toDataStoreValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block">Transform the given value into its datastore equivalent.</div>
</li>
</ul>
<a name="isConstant()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConstant</h4>
<pre>boolean&nbsp;isConstant()</pre>
<div class="block">Return true if this value represents a literal or parameter.</div>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getValue()</pre>
<div class="block">If this is a constant, return its value, else return null.</div>
</li>
</ul>
<a name="getSQLValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSQLValue</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getSQLValue()</pre>
<div class="block">If this is a constant, returns its value as it would be represented
in the database in this context, else return null.</div>
</li>
</ul>
<a name="isPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPath</h4>
<pre>boolean&nbsp;isPath()</pre>
<div class="block">Return true if this value represents a persistent field traversal,
such as 'this', 'address.street', or 'projectVariable.title'.</div>
</li>
</ul>
<a name="getClassMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassMapping</h4>
<pre><a href="../../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;getClassMapping()</pre>
<div class="block">If this is a path to a persistent object, return its class mapping,
else return null.</div>
</li>
</ul>
<a name="getFieldMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldMapping</h4>
<pre><a href="../../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a>&nbsp;getFieldMapping()</pre>
<div class="block">If this is a path to a persistent field, return its mapping, else
return null.</div>
</li>
</ul>
<a name="getXPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXPath</h4>
<pre><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/PCPath.html" title="class in org.apache.openjpa.jdbc.kernel.exps">PCPath</a>&nbsp;getXPath()</pre>
<div class="block">If this is an XPath, return it,
else return null;</div>
</li>
</ul>
<a name="getXmlMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXmlMapping</h4>
<pre><a href="../../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;getXmlMapping()</pre>
<div class="block">If this is an XPath, return XML mapping metadata,
else return null;</div>
</li>
</ul>
<a name="requiresCast()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>requiresCast</h4>
<pre>boolean&nbsp;requiresCast()</pre>
<div class="block">return true if CAST is required for this filter value
else return false.</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/FilterValue.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/jdbc/kernel/exps/ExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/GeneralCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" target="_top">Frames</a></li>
<li><a href="FilterValue.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; 2006&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>