| <!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 --> |
| <title>Metrics</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="Metrics"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/iceberg/MetadataUpdateParser.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/MetricsConfig.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Metrics.html" target="_top">Frames</a></li> |
| <li><a href="Metrics.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.iceberg</div> |
| <h2 title="Class Metrics" class="title">Class Metrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.Metrics</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Metrics</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Iceberg file format metrics.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#org.apache.iceberg.Metrics">Serialized Form</a></dd> |
| </dl> |
| </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/iceberg/Metrics.html#Metrics--">Metrics</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#Metrics-java.lang.Long-java.util.Map-java.util.Map-java.util.Map-java.util.Map-">Metrics</a></span>(java.lang.Long rowCount, |
| java.util.Map<java.lang.Integer,java.lang.Long> columnSizes, |
| java.util.Map<java.lang.Integer,java.lang.Long> valueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nanValueCounts)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#Metrics-java.lang.Long-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-">Metrics</a></span>(java.lang.Long rowCount, |
| java.util.Map<java.lang.Integer,java.lang.Long> columnSizes, |
| java.util.Map<java.lang.Integer,java.lang.Long> valueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nanValueCounts, |
| java.util.Map<java.lang.Integer,java.nio.ByteBuffer> lowerBounds, |
| java.util.Map<java.lang.Integer,java.nio.ByteBuffer> upperBounds)</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="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>java.util.Map<java.lang.Integer,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#columnSizes--">columnSizes</a></span>()</code> |
| <div class="block">Get the number of bytes for all fields in a file.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,java.nio.ByteBuffer></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#lowerBounds--">lowerBounds</a></span>()</code> |
| <div class="block">Get the non-null lower bound values for all fields in a file.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#nanValueCounts--">nanValueCounts</a></span>()</code> |
| <div class="block">Get the number of NaN values for all float and double fields in a file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#nullValueCounts--">nullValueCounts</a></span>()</code> |
| <div class="block">Get the number of null values for all fields in a file.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#recordCount--">recordCount</a></span>()</code> |
| <div class="block">Get the number of records (rows) in file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,java.nio.ByteBuffer></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#upperBounds--">upperBounds</a></span>()</code> |
| <div class="block">Get the non-null upper bound values for all fields in a file.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Metrics.html#valueCounts--">valueCounts</a></span>()</code> |
| <div class="block">Get the number of all values, including nulls, NaN and repeated.</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="Metrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Metrics</h4> |
| <pre>public Metrics()</pre> |
| </li> |
| </ul> |
| <a name="Metrics-java.lang.Long-java.util.Map-java.util.Map-java.util.Map-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Metrics</h4> |
| <pre>public Metrics(java.lang.Long rowCount, |
| java.util.Map<java.lang.Integer,java.lang.Long> columnSizes, |
| java.util.Map<java.lang.Integer,java.lang.Long> valueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nanValueCounts)</pre> |
| </li> |
| </ul> |
| <a name="Metrics-java.lang.Long-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Metrics</h4> |
| <pre>public Metrics(java.lang.Long rowCount, |
| java.util.Map<java.lang.Integer,java.lang.Long> columnSizes, |
| java.util.Map<java.lang.Integer,java.lang.Long> valueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts, |
| java.util.Map<java.lang.Integer,java.lang.Long> nanValueCounts, |
| java.util.Map<java.lang.Integer,java.nio.ByteBuffer> lowerBounds, |
| java.util.Map<java.lang.Integer,java.nio.ByteBuffer> upperBounds)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="recordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recordCount</h4> |
| <pre>public java.lang.Long recordCount()</pre> |
| <div class="block">Get the number of records (rows) in file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the count of records (rows) in the file as a long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="columnSizes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnSizes</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.lang.Long> columnSizes()</pre> |
| <div class="block">Get the number of bytes for all fields in a file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueCounts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueCounts</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.lang.Long> valueCounts()</pre> |
| <div class="block">Get the number of all values, including nulls, NaN and repeated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the number of all values including nulls, NaN and repeated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nullValueCounts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullValueCounts</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.lang.Long> nullValueCounts()</pre> |
| <div class="block">Get the number of null values for all fields in a file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the number of nulls</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nanValueCounts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nanValueCounts</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.lang.Long> nanValueCounts()</pre> |
| <div class="block">Get the number of NaN values for all float and double fields in a file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the number of NaN counts</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lowerBounds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lowerBounds</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.nio.ByteBuffer> lowerBounds()</pre> |
| <div class="block">Get the non-null lower bound values for all fields in a file. |
| |
| <p>To convert the <code>ByteBuffer</code> back to a value, use <a href="../../../org/apache/iceberg/types/Conversions.html#fromByteBuffer-org.apache.iceberg.types.Type-java.nio.ByteBuffer-"><code>Conversions.fromByteBuffer(org.apache.iceberg.types.Type, java.nio.ByteBuffer)</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the lower bound value as a ByteBuffer</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://iceberg.apache.org/spec/#appendix-d-single-value-serialization">Iceberg |
| Spec - Appendix D: Single-value serialization</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="upperBounds--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>upperBounds</h4> |
| <pre>public java.util.Map<java.lang.Integer,java.nio.ByteBuffer> upperBounds()</pre> |
| <div class="block">Get the non-null upper bound values for all fields in a file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of fieldId to the upper bound value as a ByteBuffer</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="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/iceberg/MetadataUpdateParser.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/MetricsConfig.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Metrics.html" target="_top">Frames</a></li> |
| <li><a href="Metrics.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 ======= --> |
| </body> |
| </html> |
