blob: f15a7d0bdb0e493a6586646ebbc25f5fe5aaeb35 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>DynamicTupleRecordType (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.piglet, class: DynamicTupleRecordType">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.piglet</a></div>
<h1 title="Class DynamicTupleRecordType" class="title">Class DynamicTupleRecordType</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../rel/type/RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.RelDataTypeImpl</a>
<div class="inheritance"><a href="../rel/type/DynamicRecordType.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.DynamicRecordType</a>
<div class="inheritance"><a href="../rel/type/DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.DynamicRecordTypeImpl</a>
<div class="inheritance">org.apache.calcite.piglet.DynamicTupleRecordType</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code>, <code><a href="../rel/type/RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DynamicTupleRecordType</span>
<span class="extends-implements">extends <a href="../rel/type/DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">DynamicRecordTypeImpl</a></span></div>
<div class="block">Represents Pig Tuples with unknown fields. The tuple field
can only be accessed via name '$index', like ('$0', '$1').
The tuple is then resized to match the index.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.DynamicRecordType">Fields inherited from class&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></h3>
<code><a href="../rel/type/DynamicRecordType.html#DYNAMIC_STAR_PREFIX">DYNAMIC_STAR_PREFIX</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeImpl">Fields inherited from class&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3>
<code><a href="../rel/type/RelDataTypeImpl.html#digest">digest</a>, <a href="../rel/type/RelDataTypeImpl.html#fieldList">fieldList</a>, <a href="../rel/type/RelDataTypeImpl.html#NON_NULLABLE_SUFFIX">NON_NULLABLE_SUFFIX</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.RelDataType">Fields inherited from interface&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3>
<code><a href="../rel/type/RelDataType.html#PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a>, <a href="../rel/type/RelDataType.html#SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></code></div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getField(java.lang.String,boolean,boolean)" class="member-name-link">getField</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fieldName,
boolean&nbsp;caseSensitive,
boolean&nbsp;elideRecord)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Looks up a field by name.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.DynamicRecordTypeImpl">Methods inherited from class&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">DynamicRecordTypeImpl</a></h3>
<code><a href="../rel/type/DynamicRecordTypeImpl.html#generateTypeString(java.lang.StringBuilder,boolean)">generateTypeString</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getFamily()">getFamily</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getFieldCount()">getFieldCount</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getFieldList()">getFieldList</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getFieldNames()">getFieldNames</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getPrecedenceList()">getPrecedenceList</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#getSqlTypeName()">getSqlTypeName</a>, <a href="../rel/type/DynamicRecordTypeImpl.html#isStruct()">isStruct</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.DynamicRecordType">Methods inherited from class&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></h3>
<code><a href="../rel/type/DynamicRecordType.html#isDynamicStarColName(java.lang.String)">isDynamicStarColName</a>, <a href="../rel/type/DynamicRecordType.html#isDynamicStruct()">isDynamicStruct</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeImpl">Methods inherited from class&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3>
<code><a href="../rel/type/RelDataTypeImpl.html#computeDigest()">computeDigest</a>, <a href="../rel/type/RelDataTypeImpl.html#equals(java.lang.Object)">equals</a>, <a href="../rel/type/RelDataTypeImpl.html#extra(org.apache.calcite.rel.type.RelDataType)">extra</a>, <a href="../rel/type/RelDataTypeImpl.html#getCharset()">getCharset</a>, <a href="../rel/type/RelDataTypeImpl.html#getCollation()">getCollation</a>, <a href="../rel/type/RelDataTypeImpl.html#getComparability()">getComparability</a>, <a href="../rel/type/RelDataTypeImpl.html#getComponentType()">getComponentType</a>, <a href="../rel/type/RelDataTypeImpl.html#getFieldMap()">getFieldMap</a>, <a href="../rel/type/RelDataTypeImpl.html#getFullTypeString()">getFullTypeString</a>, <a href="../rel/type/RelDataTypeImpl.html#getIntervalQualifier()">getIntervalQualifier</a>, <a href="../rel/type/RelDataTypeImpl.html#getKeyType()">getKeyType</a>, <a href="../rel/type/RelDataTypeImpl.html#getPrecision()">getPrecision</a>, <a href="../rel/type/RelDataTypeImpl.html#getScale()">getScale</a>, <a href="../rel/type/RelDataTypeImpl.html#getSqlIdentifier()">getSqlIdentifier</a>, <a href="../rel/type/RelDataTypeImpl.html#getStructKind()">getStructKind</a>, <a href="../rel/type/RelDataTypeImpl.html#getValueType()">getValueType</a>, <a href="../rel/type/RelDataTypeImpl.html#hashCode()">hashCode</a>, <a href="../rel/type/RelDataTypeImpl.html#isNullable()">isNullable</a>, <a href="../rel/type/RelDataTypeImpl.html#proto(org.apache.calcite.rel.type.RelDataType)">proto</a>, <a href="../rel/type/RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,boolean)">proto</a>, <a href="../rel/type/RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,int,boolean)">proto</a>, <a href="../rel/type/RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,int,int,boolean)">proto</a>, <a href="../rel/type/RelDataTypeImpl.html#toString()">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.RelDataType">Methods inherited from interface&nbsp;org.apache.calcite.rel.type.<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3>
<code><a href="../rel/type/RelDataType.html#equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)">equalsSansFieldNames</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getField(java.lang.String,boolean,boolean)">
<h3>getField</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span>&nbsp;<span class="element-name">getField</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fieldName,
boolean&nbsp;caseSensitive,
boolean&nbsp;elideRecord)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../rel/type/RelDataType.html#getField(java.lang.String,boolean,boolean)">RelDataType</a></code></span></div>
<div class="block">Looks up a field by name.
<p>NOTE: Be careful choosing the value of <code>caseSensitive</code>:</p>
<ul>
<li>If the field name was supplied by an end-user (e.g. as a column alias
in SQL), use your session's case-sensitivity setting.</li>
<li>Only hard-code <code>true</code> if you are sure that the field name is
internally generated.</li>
<li>Hard-coding <code>false</code> is almost certainly wrong.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../rel/type/RelDataType.html#getField(java.lang.String,boolean,boolean)">getField</a></code>&nbsp;in interface&nbsp;<code><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../rel/type/DynamicRecordTypeImpl.html#getField(java.lang.String,boolean,boolean)">getField</a></code>&nbsp;in class&nbsp;<code><a href="../rel/type/DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">DynamicRecordTypeImpl</a></code></dd>
<dt>Parameters:</dt>
<dd><code>fieldName</code> - Name of field to find</dd>
<dd><code>caseSensitive</code> - Whether match is case-sensitive</dd>
<dd><code>elideRecord</code> - Whether to find fields nested within records</dd>
<dt>Returns:</dt>
<dd>named field, or null if not found</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>