blob: cc5d5607f9578d4f0002da81ada3cb44c8dfe6ee [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>PhysType (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PhysType (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":38,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PhysType.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.enumerable</a></div>
<h2 title="Interface PhysType" class="title">Interface PhysType</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="PhysTypeImpl.html" title="class in org.apache.calcite.adapter.enumerable">PhysTypeImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">PhysType</span></pre>
<div class="block">Physical type of a row.
<p>Consists of the SQL row type (returned by <a href="#getRowType()"><code>getRowType()</code></a>), the Java
type of the row (returned by <a href="#getJavaRowType()"><code>getJavaRowType()</code></a>), and methods to
generate expressions to access fields, generate records, and so forth.
Together, the records encapsulate how the logical type maps onto the physical
type.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accessors(org.apache.calcite.linq4j.tree.Expression,java.util.List)">accessors</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;argList)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#comparer()">comparer</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a expression that yields a comparer, or null if this type
is comparable.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#component(int)">component</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Returns the physical type of a given field's component type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.JavaRowFormat)">convertTo</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</code></th>
<td class="colLast">
<div class="block">Converts an enumerable of this physical type to an enumerable that uses
the <code>targetFormat</code> for representing its rows.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.PhysType)">convertTo</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
<a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;targetPhysType)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.JavaRowFormat)"><code>convertTo(Expression, JavaRowFormat)</code></a>.</div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#field(int)">field</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Returns the physical type of a field.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Class</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldClass(int)">fieldClass</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Returns the Java class of the field with the given ordinal.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldNullable(int)">fieldNullable</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Returns whether a given field allows null values.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldReference(org.apache.calcite.linq4j.tree.Expression,int)">fieldReference</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Generates a reference to a given field in an expression.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldReference(org.apache.calcite.linq4j.tree.Expression,int,java.lang.reflect.Type)">fieldReference</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
int&nbsp;field,
java.lang.reflect.Type&nbsp;storageType)</code></th>
<td class="colLast">
<div class="block">Generates a reference to a given field in an expression.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateAccessor(java.util.List)">generateAccessor</a></span>&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Generates an accessor function for a given list of fields.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>,&#8203;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateCollationKey(java.util.List)">generateCollationKey</a></span>&#8203;(java.util.List&lt;<a href="../../rel/RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;collations)</code></th>
<td class="colLast">
<div class="block">Returns a lambda to create a collation key and a comparator.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateComparator(org.apache.calcite.rel.RelCollation)">generateComparator</a></span>&#8203;(<a href="../../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation)</code></th>
<td class="colLast">
<div class="block">Returns a comparator.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List)">generateSelector</a></span>&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Generates a selector for the given fields from an expression, with the
default row format.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">generateSelector</a></span>&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
java.util.List&lt;java.lang.Integer&gt;&nbsp;usedFields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</code></th>
<td class="colLast">
<div class="block">Generates a lambda expression that is a selector for the given fields from
an expression.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">generateSelector</a></span>&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</code></th>
<td class="colLast">
<div class="block">Generates a lambda expression that is a selector for the given fields from
an expression.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFormat()">getFormat</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the format.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.reflect.Type</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaFieldType(int)">getJavaFieldType</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Returns the Java class that is used to store the field with the given
ordinal.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.reflect.Type</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaRowType()">getJavaRowType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the Java type (often a Class) that represents a row.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRowType()">getRowType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the SQL row type.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeNullable(boolean)">makeNullable</a></span>&#8203;(boolean&nbsp;nullable)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this type that allows nulls if <code>nullable</code> is
true.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project(java.util.List,boolean,org.apache.calcite.adapter.enumerable.JavaRowFormat)">project</a></span>&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;integers,
boolean&nbsp;indicator,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;format)</code></th>
<td class="colLast">
<div class="block">Projects a given collection of fields from this input record, optionally
with indicator fields, into a particular preferred output format.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project(java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">project</a></span>&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;integers,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;format)</code></th>
<td class="colLast">
<div class="block">Projects a given collection of fields from this input record, into
a particular preferred output format.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#record(java.util.List)">record</a></span>&#8203;(java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&nbsp;expressions)</code></th>
<td class="colLast">
<div class="block">Generates an expression that creates a record for a row, initializing
its fields with the given expressions.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.reflect.Type,&#8203;java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">selector</a></span>&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</code></th>
<td class="colLast">
<div class="block">Generates a selector for the given fields from an expression.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getJavaRowType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaRowType</h4>
<pre class="methodSignature">java.lang.reflect.Type&nbsp;getJavaRowType()</pre>
<div class="block">Returns the Java type (often a Class) that represents a row. For
example, in one row format, always returns <code>Object[].class</code>.</div>
</li>
</ul>
<a id="getJavaFieldType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaFieldType</h4>
<pre class="methodSignature">java.lang.reflect.Type&nbsp;getJavaFieldType&#8203;(int&nbsp;field)</pre>
<div class="block">Returns the Java class that is used to store the field with the given
ordinal.
<p>For instance, when the java row type is <code>Object[]</code>, the java
field type is <code>Object</code> even if the field is not nullable.</p></div>
</li>
</ul>
<a id="field(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>field</h4>
<pre class="methodSignature"><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;field&#8203;(int&nbsp;ordinal)</pre>
<div class="block">Returns the physical type of a field.</div>
</li>
</ul>
<a id="component(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>component</h4>
<pre class="methodSignature"><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;component&#8203;(int&nbsp;field)</pre>
<div class="block">Returns the physical type of a given field's component type.</div>
</li>
</ul>
<a id="getRowType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowType</h4>
<pre class="methodSignature"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;getRowType()</pre>
<div class="block">Returns the SQL row type.</div>
</li>
</ul>
<a id="fieldClass(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fieldClass</h4>
<pre class="methodSignature">java.lang.Class&nbsp;fieldClass&#8203;(int&nbsp;field)</pre>
<div class="block">Returns the Java class of the field with the given ordinal.</div>
</li>
</ul>
<a id="fieldNullable(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fieldNullable</h4>
<pre class="methodSignature">boolean&nbsp;fieldNullable&#8203;(int&nbsp;index)</pre>
<div class="block">Returns whether a given field allows null values.</div>
</li>
</ul>
<a id="fieldReference(org.apache.calcite.linq4j.tree.Expression,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fieldReference</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;fieldReference&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
int&nbsp;field)</pre>
<div class="block">Generates a reference to a given field in an expression.
<p>For example given <code>expression=employee</code> and <code>field=2</code>,
generates
<blockquote><pre><code>employee.deptno</code></pre></blockquote></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - Expression</dd>
<dd><code>field</code> - Ordinal of field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Expression to access the field of the expression</dd>
</dl>
</li>
</ul>
<a id="fieldReference(org.apache.calcite.linq4j.tree.Expression,int,java.lang.reflect.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fieldReference</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;fieldReference&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
int&nbsp;field,
java.lang.reflect.Type&nbsp;storageType)</pre>
<div class="block">Generates a reference to a given field in an expression.
<p>This method optimizes for the target storage type (i.e. avoids
casts).
<p>For example given <code>expression=employee</code> and <code>field=2</code>,
generates
<blockquote><pre><code>employee.deptno</code></pre></blockquote></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - Expression</dd>
<dd><code>field</code> - Ordinal of field</dd>
<dd><code>storageType</code> - optional hint for storage class</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Expression to access the field of the expression</dd>
</dl>
</li>
</ul>
<a id="generateAccessor(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateAccessor</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;generateAccessor&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;fields)</pre>
<div class="block">Generates an accessor function for a given list of fields. The resulting
object is a <code>List</code> (implementing <code>Object.hashCode()</code> and
<code>Object.equals(Object)</code> per that interface) and also implements
<code>Comparable</code>.
<p>For example:
<blockquote><pre>
new Function1&lt;Employee, Object[]&gt; {
public Object[] apply(Employee v1) {
return FlatLists.of(v1.&lt;fieldN&gt;, v1.&lt;fieldM&gt;);
}
}
}</pre></blockquote></div>
</li>
</ul>
<a id="generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSelector</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;generateSelector&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields)</pre>
<div class="block">Generates a selector for the given fields from an expression, with the
default row format.</div>
</li>
</ul>
<a id="generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSelector</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;generateSelector&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</pre>
<div class="block">Generates a lambda expression that is a selector for the given fields from
an expression.</div>
</li>
</ul>
<a id="generateSelector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSelector</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;generateSelector&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
java.util.List&lt;java.lang.Integer&gt;&nbsp;usedFields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</pre>
<div class="block">Generates a lambda expression that is a selector for the given fields from
an expression.
<p><code>usedFields</code> must be a subset of <code>fields</code>.
For each field, there is a corresponding indicator field.
If a field is used, its value is assigned and its indicator is left
<code>false</code>.
If a field is not used, its value is not assigned and its indicator is
set to <code>true</code>;
This will become a value of 1 when <code>GROUPING(field)</code> is called.</div>
</li>
</ul>
<a id="selector(org.apache.calcite.linq4j.tree.ParameterExpression,java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selector</h4>
<pre class="methodSignature"><a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.reflect.Type,&#8203;java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&gt;&nbsp;selector&#8203;(<a href="../../linq4j/tree/ParameterExpression.html" title="class in org.apache.calcite.linq4j.tree">ParameterExpression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;fields,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</pre>
<div class="block">Generates a selector for the given fields from an expression.
Only used by EnumerableWindow.</div>
</li>
</ul>
<a id="project(java.util.List,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>project</h4>
<pre class="methodSignature"><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;project&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;integers,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;format)</pre>
<div class="block">Projects a given collection of fields from this input record, into
a particular preferred output format. The output format is optimized
if there are 0 or 1 fields.</div>
</li>
</ul>
<a id="project(java.util.List,boolean,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>project</h4>
<pre class="methodSignature"><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;project&#8203;(java.util.List&lt;java.lang.Integer&gt;&nbsp;integers,
boolean&nbsp;indicator,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;format)</pre>
<div class="block">Projects a given collection of fields from this input record, optionally
with indicator fields, into a particular preferred output format.
<p>The output format is optimized if there are 0 or 1 fields
and indicators are disabled.</div>
</li>
</ul>
<a id="generateCollationKey(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateCollationKey</h4>
<pre class="methodSignature"><a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>,&#8203;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&nbsp;generateCollationKey&#8203;(java.util.List&lt;<a href="../../rel/RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;collations)</pre>
<div class="block">Returns a lambda to create a collation key and a comparator. The
comparator is sometimes null.</div>
</li>
</ul>
<a id="generateComparator(org.apache.calcite.rel.RelCollation)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateComparator</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;generateComparator&#8203;(<a href="../../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation)</pre>
<div class="block">Returns a comparator. Unlike the comparator returned by
<a href="#generateCollationKey(java.util.List)"><code>generateCollationKey(java.util.List)</code></a>, this comparator acts on the
whole element.</div>
</li>
</ul>
<a id="comparer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comparer</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;comparer()</pre>
<div class="block">Returns a expression that yields a comparer, or null if this type
is comparable.</div>
</li>
</ul>
<a id="record(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>record</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;record&#8203;(java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&nbsp;expressions)</pre>
<div class="block">Generates an expression that creates a record for a row, initializing
its fields with the given expressions. There must be one expression per
field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expressions</code> - Expression to initialize each field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Expression to create a row</dd>
</dl>
</li>
</ul>
<a id="getFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormat</h4>
<pre class="methodSignature"><a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;getFormat()</pre>
<div class="block">Returns the format.</div>
</li>
</ul>
<a id="accessors(org.apache.calcite.linq4j.tree.Expression,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessors</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&nbsp;accessors&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;parameter,
java.util.List&lt;java.lang.Integer&gt;&nbsp;argList)</pre>
</li>
</ul>
<a id="makeNullable(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeNullable</h4>
<pre class="methodSignature"><a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;makeNullable&#8203;(boolean&nbsp;nullable)</pre>
<div class="block">Returns a copy of this type that allows nulls if <code>nullable</code> is
true.</div>
</li>
</ul>
<a id="convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.PhysType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertTo</h4>
<pre class="methodSignature">@Deprecated
<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;convertTo&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
<a href="PhysType.html" title="interface in org.apache.calcite.adapter.enumerable">PhysType</a>&nbsp;targetPhysType)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.JavaRowFormat)"><code>convertTo(Expression, JavaRowFormat)</code></a>.
The use of PhysType as a second parameter is misleading since only the row
format of the expression is affected by the conversion. Moreover it requires
to have at hand a PhysType object which is not really necessary for achieving
the desired result.</div>
</div>
<div class="block">Converts an enumerable of this physical type to an enumerable that uses a
given physical type for its rows.</div>
</li>
</ul>
<a id="convertTo(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.JavaRowFormat)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>convertTo</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;convertTo&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;expression,
<a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a>&nbsp;targetFormat)</pre>
<div class="block">Converts an enumerable of this physical type to an enumerable that uses
the <code>targetFormat</code> for representing its rows.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PhysType.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>