| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>VariantSchema (Drill : 1.20.3 API)</title> |
| <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="VariantSchema (Drill : 1.20.3 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":9,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/VariantSchema.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/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/record/metadata/VariantSchema.html" target="_top">Frames</a></li> |
| <li><a href="VariantSchema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.drill.exec.record.metadata</div> |
| <h2 title="Class VariantSchema" class="title">Class VariantSchema</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.drill.exec.record.metadata.VariantSchema</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">VariantSchema</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/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#VariantSchema--">VariantSchema</a></span>()</code> </td> |
| </tr> |
| </table> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/drill/exec/record/metadata/VariantSchema.html#addList-org.apache.drill.exec.record.metadata.VariantColumnMetadata-">addList</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">VariantColumnMetadata</a> listCol)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#addMap-org.apache.drill.exec.record.metadata.MapColumnMetadata-">addMap</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/MapColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">MapColumnMetadata</a> mapCol)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#addType-org.apache.drill.exec.record.metadata.ColumnMetadata-">addType</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> col)</code> |
| <div class="block">Add a column for any supported type to the variant.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#addType-org.apache.drill.exec.record.MaterializedField-">addType</a></span>(<a href="../../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a> field)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#addType-org.apache.drill.common.types.TypeProtos.MinorType-">addType</a></span>(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</code> |
| <div class="block">Add any supported type to the variant.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#becomeSimple--">becomeSimple</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#bind-org.apache.drill.exec.record.metadata.VariantColumnMetadata-">bind</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">VariantColumnMetadata</a> parent)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#cloneEmpty--">cloneEmpty</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#copy--">copy</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#hasType-org.apache.drill.common.types.TypeProtos.MinorType-">hasType</a></span>(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</code> |
| <div class="block">Determine if the given type is a member of the variant.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#isEquivalent-org.apache.drill.exec.record.metadata.VariantSchema-">isEquivalent</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a> other)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#isSimple--">isSimple</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#isSingleType--">isSingleType</a></span>()</code> |
| <div class="block">A list is defined as a list of variants at the metadata layer.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#listSubtype--">listSubtype</a></span>()</code> |
| <div class="block">Lists are odd creatures: they contain a union if they have more |
| than one subtype, but are like a nullable repeated type if they |
| contain only one type.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#member-org.apache.drill.common.types.TypeProtos.MinorType-">member</a></span>(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</code> |
| <div class="block">Retrieve the virtual column for a given type.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#memberMetadata-org.apache.drill.common.types.TypeProtos.MinorType-">memberMetadata</a></span>(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#members--">members</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#parent--">parent</a></span>()</code> |
| <div class="block">Return the column that defines this variant structure</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#size--">size</a></span>()</code> |
| <div class="block">Returns the number of types in the variant.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <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/drill/exec/record/metadata/VariantSchema.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html#types--">types</a></span>()</code> |
| <div class="block">Returns the list of types which are members of this variant.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="VariantSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VariantSchema</h4> |
| <pre>public VariantSchema()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="bind-org.apache.drill.exec.record.metadata.VariantColumnMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>protected void bind(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">VariantColumnMetadata</a> parent)</pre> |
| </li> |
| </ul> |
| <a name="memberMetadata-org.apache.drill.common.types.TypeProtos.MinorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>memberMetadata</h4> |
| <pre>public static <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> memberMetadata(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</pre> |
| </li> |
| </ul> |
| <a name="addType-org.apache.drill.common.types.TypeProtos.MinorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addType</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> addType(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#addType-org.apache.drill.common.types.TypeProtos.MinorType-">VariantMetadata</a></code></span></div> |
| <div class="block">Add any supported type to the variant. |
| <p> |
| At present, the union |
| vector does not support the decimal types. This class does not |
| reject such types; but they will cause a runtime exception when |
| code asks the union vector for these types.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#addType-org.apache.drill.common.types.TypeProtos.MinorType-">addType</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - type to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the "virtual" column for that type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addType-org.apache.drill.exec.record.metadata.ColumnMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addType</h4> |
| <pre>public void addType(<a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> col)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#addType-org.apache.drill.exec.record.metadata.ColumnMetadata-">VariantMetadata</a></code></span></div> |
| <div class="block">Add a column for any supported type to the variant. |
| Use this to add structure to a list or map member.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#addType-org.apache.drill.exec.record.metadata.ColumnMetadata-">addType</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>col</code> - column to add. The column must have the correct |
| mode. The column's type is used as the type key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="size--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>public int size()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#size--">VariantMetadata</a></code></span></div> |
| <div class="block">Returns the number of types in the variant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#size--">size</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of types in the variant</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasType-org.apache.drill.common.types.TypeProtos.MinorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasType</h4> |
| <pre>public boolean hasType(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#hasType-org.apache.drill.common.types.TypeProtos.MinorType-">VariantMetadata</a></code></span></div> |
| <div class="block">Determine if the given type is a member of the variant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#hasType-org.apache.drill.common.types.TypeProtos.MinorType-">hasType</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - type to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the type is a member, |
| <tt>false</tt> if not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="member-org.apache.drill.common.types.TypeProtos.MinorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>member</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> member(<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a> type)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#member-org.apache.drill.common.types.TypeProtos.MinorType-">VariantMetadata</a></code></span></div> |
| <div class="block">Retrieve the virtual column for a given type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#member-org.apache.drill.common.types.TypeProtos.MinorType-">member</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the virtual column, or <tt>null</tt> if the type |
| is not a member of the variant</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parent</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> parent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#parent--">VariantMetadata</a></code></span></div> |
| <div class="block">Return the column that defines this variant structure</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#parent--">parent</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the column that returns this variant structure |
| from its <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html#variantSchema--"><code>variantSchema()</code></a> |
| method</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="types--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>types</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/common/types/TypeProtos.MinorType.html" title="enum in org.apache.drill.common.types">TypeProtos.MinorType</a>> types()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#types--">VariantMetadata</a></code></span></div> |
| <div class="block">Returns the list of types which are members of this variant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#types--">types</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="members--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>members</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a>> members()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#members--">members</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMap-org.apache.drill.exec.record.metadata.MapColumnMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMap</h4> |
| <pre>public void addMap(<a href="../../../../../../org/apache/drill/exec/record/metadata/MapColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">MapColumnMetadata</a> mapCol)</pre> |
| </li> |
| </ul> |
| <a name="addList-org.apache.drill.exec.record.metadata.VariantColumnMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addList</h4> |
| <pre>public void addList(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">VariantColumnMetadata</a> listCol)</pre> |
| </li> |
| </ul> |
| <a name="addType-org.apache.drill.exec.record.MaterializedField-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addType</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> addType(<a href="../../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a> field)</pre> |
| </li> |
| </ul> |
| <a name="isSingleType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSingleType</h4> |
| <pre>public boolean isSingleType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#isSingleType--">VariantMetadata</a></code></span></div> |
| <div class="block">A list is defined as a list of variants at the metadata layer. |
| But, in implementation, a list will do special processing if the |
| variant (union) contains only one type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#isSingleType--">isSingleType</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if this variant contains only one type, |
| </tt>false</tt> if the variant contains 0, 2 or more types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listSubtype--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listSubtype</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> listSubtype()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#listSubtype--">VariantMetadata</a></code></span></div> |
| <div class="block">Lists are odd creatures: they contain a union if they have more |
| than one subtype, but are like a nullable repeated type if they |
| contain only one type. This method returns the type of the array: |
| either the single type (if <a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#isSingleType--"><code>VariantMetadata.isSingleType()</code></a> is <tt>true</tt>) |
| or a reference to the synthetic union column nested inside the |
| list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#listSubtype--">listSubtype</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the metadata for the implicit column within the list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="becomeSimple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>becomeSimple</h4> |
| <pre>public void becomeSimple()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#becomeSimple--">becomeSimple</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSimple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSimple</h4> |
| <pre>public boolean isSimple()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html#isSimple--">isSimple</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> 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> in class <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="cloneEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cloneEmpty</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a> cloneEmpty()</pre> |
| </li> |
| </ul> |
| <a name="copy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a> copy()</pre> |
| </li> |
| </ul> |
| <a name="isEquivalent-org.apache.drill.exec.record.metadata.VariantSchema-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isEquivalent</h4> |
| <pre>public boolean isEquivalent(<a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a> other)</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/VariantSchema.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/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/record/metadata/VariantSchema.html" target="_top">Frames</a></li> |
| <li><a href="VariantSchema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
