| <!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 (1.8.0_292) on Tue Jun 15 06:13:00 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ColumnPrefix (Apache Hadoop YARN TimelineService HBase Common 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <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="ColumnPrefix (Apache Hadoop YARN TimelineService HBase Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ColumnPrefix.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/hadoop/yarn/server/timelineservice/storage/common/ColumnHelper.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/EventColumnName.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html" target="_top">Frames</a></li> |
| <li><a href="ColumnPrefix.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.hadoop.yarn.server.timelineservice.storage.common</div> |
| <h2 title="Interface ColumnPrefix" class="title">Interface ColumnPrefix<T extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a><T>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/application/ApplicationColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.application">ApplicationColumnPrefix</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/apptoflow/AppToFlowColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.apptoflow">AppToFlowColumnPrefix</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/entity/EntityColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.entity">EntityColumnPrefix</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowActivityColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowActivityColumnPrefix</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/FlowRunColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.flow">FlowRunColumnPrefix</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/subapplication/SubApplicationColumnPrefix.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage.subapplication">SubApplicationColumnPrefix</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ColumnPrefix<T extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTable.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTable</a><T>></span></pre> |
| <div class="block">Used to represent a partially qualified column, where the actual column name |
| will be composed of a prefix and the remainder of the column qualifier. The |
| prefix can be null, in which case the column qualifier will be completely |
| determined when the values are stored.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getColumnFamilyBytes--">getColumnFamilyBytes</a></span>()</code> |
| <div class="block">Returns column family name(as bytes) associated with this column prefix.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getColumnPrefixBytes-byte:A-">getColumnPrefixBytes</a></span>(byte[] qualifierPrefix)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getColumnPrefixBytes-java.lang.String-">getColumnPrefixBytes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> qualifierPrefix)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getColumnPrefixInBytes--">getColumnPrefixInBytes</a></span>()</code> |
| <div class="block">Get the column prefix in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/Attribute.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">Attribute</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getCombinedAttrsWithAggr-org.apache.hadoop.yarn.server.timelineservice.storage.flow.Attribute...-">getCombinedAttrsWithAggr</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/Attribute.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">Attribute</a>... attributes)</code> |
| <div class="block">Return attributed combined with aggregations, if any.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ValueConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">ValueConverter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#getValueConverter--">getValueConverter</a></span>()</code> |
| <div class="block">Returns value converter implementation associated with this column prefix.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html#supplementCellTimeStamp--">supplementCellTimeStamp</a></span>()</code> |
| <div class="block">Return true if the cell timestamp needs to be supplemented.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getColumnPrefixBytes-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnPrefixBytes</h4> |
| <pre>byte[] getColumnPrefixBytes(<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> qualifierPrefix)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qualifierPrefix</code> - Column qualifier or prefix of qualifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array encoding column prefix and qualifier/prefix passed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnPrefixBytes-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnPrefixBytes</h4> |
| <pre>byte[] getColumnPrefixBytes(byte[] qualifierPrefix)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qualifierPrefix</code> - Column qualifier or prefix of qualifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array encoding column prefix and qualifier/prefix passed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnPrefixInBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnPrefixInBytes</h4> |
| <pre>byte[] getColumnPrefixInBytes()</pre> |
| <div class="block">Get the column prefix in bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>column prefix in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnFamilyBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnFamilyBytes</h4> |
| <pre>byte[] getColumnFamilyBytes()</pre> |
| <div class="block">Returns column family name(as bytes) associated with this column prefix.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array encoding column family for this prefix.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueConverter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueConverter</h4> |
| <pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ValueConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common">ValueConverter</a> getValueConverter()</pre> |
| <div class="block">Returns value converter implementation associated with this column prefix.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/ValueConverter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage.common"><code>ValueConverter</code></a> implementation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCombinedAttrsWithAggr-org.apache.hadoop.yarn.server.timelineservice.storage.flow.Attribute...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCombinedAttrsWithAggr</h4> |
| <pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/Attribute.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">Attribute</a>[] getCombinedAttrsWithAggr(<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/flow/Attribute.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.flow">Attribute</a>... attributes)</pre> |
| <div class="block">Return attributed combined with aggregations, if any.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of Attributes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supplementCellTimeStamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>supplementCellTimeStamp</h4> |
| <pre>boolean supplementCellTimeStamp()</pre> |
| <div class="block">Return true if the cell timestamp needs to be supplemented.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the cell timestamp needs to be supplemented</dd> |
| </dl> |
| </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/ColumnPrefix.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/hadoop/yarn/server/timelineservice/storage/common/ColumnHelper.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/EventColumnName.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/common/ColumnPrefix.html" target="_top">Frames</a></li> |
| <li><a href="ColumnPrefix.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
