/Java/PrimaNotaFacileClient/poi-3.15/docs/apidocs/org/apache/poi/hssf/record/Record.html
HTML | 364 lines | 315 code | 0 blank | 49 comment | 0 complexity | 3f88f3d011a33e41fb94d5c5b58ba537 MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <title>Record (POI API Documentation)</title>
- <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Record (POI API Documentation)";
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar_top">
- <!-- -->
- </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Record.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/poi/hssf/record/RecalcIdRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/poi/hssf/record/Record.html" target="_top">Frames</a></li>
- <li><a href="Record.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.poi.hssf.record</div>
- <h2 title="Class Record" class="title">Class Record</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li><a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record">org.apache.poi.hssf.record.RecordBase</a></li>
- <li>
- <ul class="inheritance">
- <li>org.apache.poi.hssf.record.Record</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>Direct Known Subclasses:</dt>
- <dd><a href="../../../../../org/apache/poi/hssf/record/AbstractEscherHolderRecord.html" title="class in org.apache.poi.hssf.record">AbstractEscherHolderRecord</a>, <a href="../../../../../org/apache/poi/hssf/record/cont/ContinuableRecord.html" title="class in org.apache.poi.hssf.record.cont">ContinuableRecord</a>, <a href="../../../../../org/apache/poi/hssf/record/LabelRecord.html" title="class in org.apache.poi.hssf.record">LabelRecord</a>, <a href="../../../../../org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.html" title="class in org.apache.poi.hssf.eventusermodel.dummyrecord">LastCellOfRowDummyRecord</a>, <a href="../../../../../org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.html" title="class in org.apache.poi.hssf.eventusermodel.dummyrecord">MissingCellDummyRecord</a>, <a href="../../../../../org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.html" title="class in org.apache.poi.hssf.eventusermodel.dummyrecord">MissingRowDummyRecord</a>, <a href="../../../../../org/apache/poi/hssf/record/ObjRecord.html" title="class in org.apache.poi.hssf.record">ObjRecord</a>, <a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">StandardRecord</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public abstract class <span class="strong">Record</span>
- extends <a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record">RecordBase</a></pre>
- <div class="block">All HSSF Records inherit from this class.</div>
- </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="overviewSummary" 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="colFirst" scope="col">Modifier</th>
- <th class="colLast" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected </code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#Record()">Record</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span>Methods</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>java.lang.Object</code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#clone()">clone</a></strong>()</code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#cloneViaReserialise()">cloneViaReserialise</a></strong>()</code>
- <div class="block">Clone the current record, via a call to serialize
- it, and another to create a new record from the
- bytes.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>abstract short</code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#getSid()">getSid</a></strong>()</code>
- <div class="block">return the non static version of the id for this record.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>byte[]</code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#serialize()">serialize</a></strong>()</code>
- <div class="block">called by the class that is responsible for writing this sucker.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#toString()">toString</a></strong>()</code>
- <div class="block">get a string representation of the record (for biffview/debugging)</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hssf.record.RecordBase">
- <!-- -->
- </a>
- <h3>Methods inherited from class org.apache.poi.hssf.record.<a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record">RecordBase</a></h3>
- <code><a href="../../../../../org/apache/poi/hssf/record/RecordBase.html#getRecordSize()">getRecordSize</a>, <a href="../../../../../org/apache/poi/hssf/record/RecordBase.html#serialize(int,%20byte[])">serialize</a></code></li>
- </ul>
- <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>equals, finalize, getClass, hashCode, notify, notifyAll, 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="Record()">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Record</h4>
- <pre>protected Record()</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="serialize()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>serialize</h4>
- <pre>public final byte[] serialize()</pre>
- <div class="block">called by the class that is responsible for writing this sucker.
- Subclasses should implement this so that their data is passed back in a
- byte array.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>byte array containing instance data</dd></dl>
- </li>
- </ul>
- <a name="toString()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toString</h4>
- <pre>public java.lang.String toString()</pre>
- <div class="block">get a string representation of the record (for biffview/debugging)</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
- </dl>
- </li>
- </ul>
- <a name="getSid()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSid</h4>
- <pre>public abstract short getSid()</pre>
- <div class="block">return the non static version of the id for this record.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>he id for this record</dd></dl>
- </li>
- </ul>
- <a name="clone()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>clone</h4>
- <pre>public java.lang.Object clone()
- throws java.lang.CloneNotSupportedException</pre>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <dd><code>clone</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="strong">Throws:</span></dt>
- <dd><code>java.lang.CloneNotSupportedException</code></dd></dl>
- </li>
- </ul>
- <a name="cloneViaReserialise()">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>cloneViaReserialise</h4>
- <pre>public <a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a> cloneViaReserialise()</pre>
- <div class="block">Clone the current record, via a call to serialize
- it, and another to create a new record from the
- bytes.
- May only be used for classes which don't have
- internal counts / ids in them. For those which
- do, a full model-aware cloning is needed, which
- allocates new ids / counts as needed.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>the cloned current record</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Record.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/poi/hssf/record/RecalcIdRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/poi/hssf/record/Record.html" target="_top">Frames</a></li>
- <li><a href="Record.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>
- <i>Copyright 2016 The Apache Software Foundation or
- its licensors, as applicable.</i>
- </small></p>
- </body>
- </html>