Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.1.0 / apidocs / org / apache / openjpa / jdbc / meta / QueryResultMapping.html
blob: 82fcb1b977c77e27635f45380bd979b5e3c10d69 [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 (1.8.0_201) on Wed Apr 24 20:07:05 CEST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QueryResultMapping (OpenJPA Parent POM 3.1.0 API)</title>
<meta name="date" content="2019-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryResultMapping (OpenJPA Parent POM 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/QueryResultMapping.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/meta/PropertiesReverseCustomizer.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/QueryResultMapping.html" target="_top">Frames</a></li>
<li><a href="QueryResultMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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.jdbc.meta</div>
<h2 title="Class QueryResultMapping" class="title">Class QueryResultMapping</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.jdbc.meta.QueryResultMapping</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a>, <a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">QueryResultMapping</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a>, <a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a>, <a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></pre>
<div class="block">Mapping of a query result set to scalar and/or persistence-capable
object-level values.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pinaki Poddar, Abe White</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="memberSummary" 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">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping.PCResult</a></span></code>
<div class="block">A persistence-capable result.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.meta.MetaDataModes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3>
<code><a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ALL">MODE_ALL</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META">MODE_META</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_NONE">MODE_NONE</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY">MODE_QUERY</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.lib.meta.SourceTracker">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.lib.meta.<a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_ANNOTATIONS">SRC_ANNOTATIONS</a>, <a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_OTHER">SRC_OTHER</a>, <a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_XML">SRC_XML</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.lib.xml.Commentable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.lib.xml.<a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html#EMPTY_COMMENTS">EMPTY_COMMENTS</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#addColumnResult-java.lang.Object-">addColumnResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;id)</code>
<div class="block">Add the id of a mapped column in the query result.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping.PCResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#addPCResult-java.lang.Class-">addPCResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;candidate)</code>
<div class="block">Add a mapped persistence-capable result with the given candidate type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getColNumber--">getColNumber</a></span>()</code>
<div class="block">Return the column number in the line of the file at which this
instance was parsed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getColumnResults--">getColumnResults</a></span>()</code>
<div class="block">Ids of mapped scalar columns in the result.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getComments--">getComments</a></span>()</code>
<div class="block">Return comments, or empty array if none.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getDefiningType--">getDefiningType</a></span>()</code>
<div class="block">The class that defines this query result, or null if none.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getLineNumber--">getLineNumber</a></span>()</code>
<div class="block">Return the line number of the file at which this instance was parsed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getListingIndex--">getListingIndex</a></span>()</code>
<div class="block">Relative order of result mapping in metadata.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getName--">getName</a></span>()</code>
<div class="block">Return the name for this query result.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping.PCResult</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getPCResults--">getPCResults</a></span>()</code>
<div class="block">Return the mapped persistence-capable types in the query result.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getResourceName--">getResourceName</a></span>()</code>
<div class="block">Return the domain-meaningful name of the resource that was loaded
from this source.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getSourceFile--">getSourceFile</a></span>()</code>
<div class="block">Return the file from which this instance was parsed.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getSourceMode--">getSourceMode</a></span>()</code>
<div class="block">The source mode of this query result.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getSourceScope--">getSourceScope</a></span>()</code>
<div class="block">Return the domain-dependent scope of this instance within its file.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#getSourceType--">getSourceType</a></span>()</code>
<div class="block">Return the type of source.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setColNumber-int-">setColNumber</a></span>(int&nbsp;colNum)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setComments-java.lang.String:A-">setComments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;comments)</code>
<div class="block">Set comments.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setDefiningType-java.lang.Class-">setDefiningType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</code>
<div class="block">The class that defines this query result, or null if none.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setLineNumber-int-">setLineNumber</a></span>(int&nbsp;lineNum)</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setListingIndex-int-">setListingIndex</a></span>(int&nbsp;idx)</code>
<div class="block">Relative order of result mapping in metadata.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setSource-java.io.File-java.lang.Object-int-">setSource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;scope,
int&nbsp;srcType)</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#setSourceMode-int-">setSourceMode</a></span>(int&nbsp;mode)</code>
<div class="block">The source mode of this query result.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Return the name for this query result.</div>
</li>
</ul>
<a name="getDefiningType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefiningType</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getDefiningType()</pre>
<div class="block">The class that defines this query result, or null if none.</div>
</li>
</ul>
<a name="setDefiningType-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefiningType</h4>
<pre>public&nbsp;void&nbsp;setDefiningType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</pre>
<div class="block">The class that defines this query result, or null if none.</div>
</li>
</ul>
<a name="getColumnResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnResults</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;getColumnResults()</pre>
<div class="block">Ids of mapped scalar columns in the result. These will typically be
column names.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a></dd>
</dl>
</li>
</ul>
<a name="addColumnResult-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumnResult</h4>
<pre>public&nbsp;void&nbsp;addColumnResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;id)</pre>
<div class="block">Add the id of a mapped column in the query result. This will typically
be a column name.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a></dd>
</dl>
</li>
</ul>
<a name="getPCResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPCResults</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping.PCResult</a>[]&nbsp;getPCResults()</pre>
<div class="block">Return the mapped persistence-capable types in the query result.</div>
</li>
</ul>
<a name="addPCResult-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPCResult</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping.PCResult</a>&nbsp;addPCResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;candidate)</pre>
<div class="block">Add a mapped persistence-capable result with the given candidate type.</div>
</li>
</ul>
<a name="getSourceMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceMode</h4>
<pre>public&nbsp;int&nbsp;getSourceMode()</pre>
<div class="block">The source mode of this query result.</div>
</li>
</ul>
<a name="setSourceMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSourceMode</h4>
<pre>public&nbsp;void&nbsp;setSourceMode(int&nbsp;mode)</pre>
<div class="block">The source mode of this query result.</div>
</li>
</ul>
<a name="getListingIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListingIndex</h4>
<pre>public&nbsp;int&nbsp;getListingIndex()</pre>
<div class="block">Relative order of result mapping in metadata.</div>
</li>
</ul>
<a name="setListingIndex-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setListingIndex</h4>
<pre>public&nbsp;void&nbsp;setListingIndex(int&nbsp;idx)</pre>
<div class="block">Relative order of result mapping in metadata.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="getComments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComments</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getComments()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html#getComments--">Commentable</a></code></span></div>
<div class="block">Return comments, or empty array if none.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html#getComments--">getComments</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd>
</dl>
</li>
</ul>
<a name="setComments-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setComments</h4>
<pre>public&nbsp;void&nbsp;setComments(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;comments)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html#setComments-java.lang.String:A-">Commentable</a></code></span></div>
<div class="block">Set comments.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html#setComments-java.lang.String:A-">setComments</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd>
</dl>
</li>
</ul>
<a name="getSourceFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceFile</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getSourceFile()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceFile--">SourceTracker</a></code></span></div>
<div class="block">Return the file from which this instance was parsed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceFile--">getSourceFile</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="getSourceScope--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceScope</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getSourceScope()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceScope--">SourceTracker</a></code></span></div>
<div class="block">Return the domain-dependent scope of this instance within its file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceScope--">getSourceScope</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="getSourceType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceType</h4>
<pre>public&nbsp;int&nbsp;getSourceType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceType--">SourceTracker</a></code></span></div>
<div class="block">Return the type of source.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceType--">getSourceType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="setSource-java.io.File-java.lang.Object-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre>public&nbsp;void&nbsp;setSource(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;scope,
int&nbsp;srcType)</pre>
</li>
</ul>
<a name="getResourceName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResourceName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getResourceName--">SourceTracker</a></code></span></div>
<div class="block">Return the domain-meaningful name of the resource that was loaded
from this source. I.e., if we had loaded the source for a Java
class, this would return the name of the class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getResourceName--">getResourceName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="getLineNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumber</h4>
<pre>public&nbsp;int&nbsp;getLineNumber()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getLineNumber--">SourceTracker</a></code></span></div>
<div class="block">Return the line number of the file at which this instance was parsed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getLineNumber--">getLineNumber</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="setLineNumber-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineNumber</h4>
<pre>public&nbsp;void&nbsp;setLineNumber(int&nbsp;lineNum)</pre>
</li>
</ul>
<a name="getColNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColNumber</h4>
<pre>public&nbsp;int&nbsp;getColNumber()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getColNumber--">SourceTracker</a></code></span></div>
<div class="block">Return the column number in the line of the file at which this
instance was parsed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getColNumber--">getColNumber</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd>
</dl>
</li>
</ul>
<a name="setColNumber-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setColNumber</h4>
<pre>public&nbsp;void&nbsp;setColNumber(int&nbsp;colNum)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/QueryResultMapping.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/meta/PropertiesReverseCustomizer.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.PCResult.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/QueryResultMapping.html" target="_top">Frames</a></li>
<li><a href="QueryResultMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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;2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>