PageRenderTime 29ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/Java/PrimaNotaFacileClient/poi-3.15/docs/apidocs/org/apache/poi/hssf/record/Record.html

https://gitlab.com/fabi.gjuzi/Portfolio
HTML | 364 lines | 315 code | 0 blank | 49 comment | 0 complexity | 3f88f3d011a33e41fb94d5c5b58ba537 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <title>Record (POI API Documentation)</title>
    6. 

  6. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <script type="text/javascript"><!--
    10. 

  10.     if (location.href.indexOf('is-external=true') == -1) {
    11. 

  11.         parent.document.title="Record (POI API Documentation)";
    12. 

  12.     }
    13. 

  13. //-->
    14. 

  14. </script>
    15. 

  15. <noscript>
    16. 

  16. <div>JavaScript is disabled on your browser.</div>
    17. 

  17. </noscript>
    18. 

  18. <!-- ========= START OF TOP NAVBAR ======= -->
    19. 

  19. <div class="topNav"><a name="navbar_top">
    20. 

  20. <!--   -->
    21. 

  21. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    22. 

  22. <!--   -->
    23. 

  23. </a>
    24. 

  24. <ul class="navList" title="Navigation">
    25. 

  25. <li><a href="../../../../../overview-summary.html">Overview</a></li>
    26. 

  26. <li><a href="package-summary.html">Package</a></li>
    27. 

  27. <li class="navBarCell1Rev">Class</li>
    28. 

  28. <li><a href="class-use/Record.html">Use</a></li>
    29. 

  29. <li><a href="package-tree.html">Tree</a></li>
    30. 

  30. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
    31. 

  31. <li><a href="../../../../../index-all.html">Index</a></li>
    32. 

  32. <li><a href="../../../../../help-doc.html">Help</a></li>
    33. 

  33. </ul>
    34. 

  34. </div>
    35. 

  35. <div class="subNav">
    36. 

  36. <ul class="navList">
    37. 

  37. <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>
    38. 

  38. <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>
    39. 

  39. </ul>
    40. 

  40. <ul class="navList">
    41. 

  41. <li><a href="../../../../../index.html?org/apache/poi/hssf/record/Record.html" target="_top">Frames</a></li>
    42. 

  42. <li><a href="Record.html" target="_top">No Frames</a></li>
    43. 

  43. </ul>
    44. 

  44. <ul class="navList" id="allclasses_navbar_top">
    45. 

  45. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
    46. 

  46. </ul>
    47. 

  47. <div>
    48. 

  48. <script type="text/javascript"><!--
    49. 

  49.   allClassesLink = document.getElementById("allclasses_navbar_top");
    50. 

  50.   if(window==top) {
    51. 

  51.     allClassesLink.style.display = "block";
    52. 

  52.   }
    53. 

  53.   else {
    54. 

  54.     allClassesLink.style.display = "none";
    55. 

  55.   }
    56. 

  56.   //-->
    57. 

  57. </script>
    58. 

  58. </div>
    59. 

  59. <div>
    60. 

  60. <ul class="subNavList">
    61. 

  61. <li>Summary:&nbsp;</li>
    62. 

  62. <li>Nested&nbsp;|&nbsp;</li>
    63. 

  63. <li>Field&nbsp;|&nbsp;</li>
    64. 

  64. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    65. 

  65. <li><a href="#method_summary">Method</a></li>
    66. 

  66. </ul>
    67. 

  67. <ul class="subNavList">
    68. 

  68. <li>Detail:&nbsp;</li>
    69. 

  69. <li>Field&nbsp;|&nbsp;</li>
    70. 

  70. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    71. 

  71. <li><a href="#method_detail">Method</a></li>
    72. 

  72. </ul>
    73. 

  73. </div>
    74. 

  74. <a name="skip-navbar_top">
    75. 

  75. <!--   -->
    76. 

  76. </a></div>
    77. 

  77. <!-- ========= END OF TOP NAVBAR ========= -->
    78. 

  78. <!-- ======== START OF CLASS DATA ======== -->
    79. 

  79. <div class="header">
    80. 

  80. <div class="subTitle">org.apache.poi.hssf.record</div>
    81. 

  81. <h2 title="Class Record" class="title">Class Record</h2>
    82. 

  82. </div>
    83. 

  83. <div class="contentContainer">
    84. 

  84. <ul class="inheritance">
    85. 

  85. <li>java.lang.Object</li>
    86. 

  86. <li>
    87. 

  87. <ul class="inheritance">
    88. 

  88. <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>
    89. 

  89. <li>
    90. 

  90. <ul class="inheritance">
    91. 

  91. <li>org.apache.poi.hssf.record.Record</li>
    92. 

  92. </ul>
    93. 

  93. </li>
    94. 

  94. </ul>
    95. 

  95. </li>
    96. 

  96. </ul>
    97. 

  97. <div class="description">
    98. 

  98. <ul class="blockList">
    99. 

  99. <li class="blockList">
    100. 

  100. <dl>
    101. 

  101. <dt>Direct Known Subclasses:</dt>
    102. 

  102. <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>
    103. 

  103. </dl>
    104. 

  104. <hr>
    105. 

  105. <br>
    106. 

  106. <pre>public abstract class <span class="strong">Record</span>
    107. 

  107. extends <a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record">RecordBase</a></pre>
    108. 

  108. <div class="block">All HSSF Records inherit from this class.</div>
    109. 

  109. </li>
    110. 

  110. </ul>
    111. 

  111. </div>
    112. 

  112. <div class="summary">
    113. 

  113. <ul class="blockList">
    114. 

  114. <li class="blockList">
    115. 

  115. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    116. 

  116. <ul class="blockList">
    117. 

  117. <li class="blockList"><a name="constructor_summary">
    118. 

  118. <!--   -->
    119. 

  119. </a>
    120. 

  120. <h3>Constructor Summary</h3>
    121. 

  121. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    122. 

  122. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    123. 

  123. <tr>
    124. 

  124. <th class="colFirst" scope="col">Modifier</th>
    125. 

  125. <th class="colLast" scope="col">Constructor and Description</th>
    126. 

  126. </tr>
    127. 

  127. <tr class="altColor">
    128. 

  128. <td class="colFirst"><code>protected </code></td>
    129. 

  129. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#Record()">Record</a></strong>()</code>&nbsp;</td>
    130. 

  130. </tr>
    131. 

  131. </table>
    132. 

  132. </li>
    133. 

  133. </ul>
    134. 

  134. <!-- ========== METHOD SUMMARY =========== -->
    135. 

  135. <ul class="blockList">
    136. 

  136. <li class="blockList"><a name="method_summary">
    137. 

  137. <!--   -->
    138. 

  138. </a>
    139. 

  139. <h3>Method Summary</h3>
    140. 

  140. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    141. 

  141. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    142. 

  142. <tr>
    143. 

  143. <th class="colFirst" scope="col">Modifier and Type</th>
    144. 

  144. <th class="colLast" scope="col">Method and Description</th>
    145. 

  145. </tr>
    146. 

  146. <tr class="altColor">
    147. 

  147. <td class="colFirst"><code>java.lang.Object</code></td>
    148. 

  148. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#clone()">clone</a></strong>()</code>&nbsp;</td>
    149. 

  149. </tr>
    150. 

  150. <tr class="rowColor">
    151. 

  151. <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>
    152. 

  152. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#cloneViaReserialise()">cloneViaReserialise</a></strong>()</code>
    153. 

  153. <div class="block">Clone the current record, via a call to serialize
    154. 

  154.   it, and another to create a new record from the
    155. 

  155.   bytes.</div>
    156. 

  156. </td>
    157. 

  157. </tr>
    158. 

  158. <tr class="altColor">
    159. 

  159. <td class="colFirst"><code>abstract short</code></td>
    160. 

  160. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#getSid()">getSid</a></strong>()</code>
    161. 

  161. <div class="block">return the non static version of the id for this record.</div>
    162. 

  162. </td>
    163. 

  163. </tr>
    164. 

  164. <tr class="rowColor">
    165. 

  165. <td class="colFirst"><code>byte[]</code></td>
    166. 

  166. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#serialize()">serialize</a></strong>()</code>
    167. 

  167. <div class="block">called by the class that is responsible for writing this sucker.</div>
    168. 

  168. </td>
    169. 

  169. </tr>
    170. 

  170. <tr class="altColor">
    171. 

  171. <td class="colFirst"><code>java.lang.String</code></td>
    172. 

  172. <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/Record.html#toString()">toString</a></strong>()</code>
    173. 

  173. <div class="block">get a string representation of the record (for biffview/debugging)</div>
    174. 

  174. </td>
    175. 

  175. </tr>
    176. 

  176. </table>
    177. 

  177. <ul class="blockList">
    178. 

  178. <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hssf.record.RecordBase">
    179. 

  179. <!--   -->
    180. 

  180. </a>
    181. 

  181. <h3>Methods inherited from class&nbsp;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>
    182. 

  182. <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>
    183. 

  183. </ul>
    184. 

  184. <ul class="blockList">
    185. 

  185. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
    186. 

  186. <!--   -->
    187. 

  187. </a>
    188. 

  188. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    189. 

  189. <code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
    190. 

  190. </ul>
    191. 

  191. </li>
    192. 

  192. </ul>
    193. 

  193. </li>
    194. 

  194. </ul>
    195. 

  195. </div>
    196. 

  196. <div class="details">
    197. 

  197. <ul class="blockList">
    198. 

  198. <li class="blockList">
    199. 

  199. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    200. 

  200. <ul class="blockList">
    201. 

  201. <li class="blockList"><a name="constructor_detail">
    202. 

  202. <!--   -->
    203. 

  203. </a>
    204. 

  204. <h3>Constructor Detail</h3>
    205. 

  205. <a name="Record()">
    206. 

  206. <!--   -->
    207. 

  207. </a>
    208. 

  208. <ul class="blockListLast">
    209. 

  209. <li class="blockList">
    210. 

  210. <h4>Record</h4>
    211. 

  211. <pre>protected&nbsp;Record()</pre>
    212. 

  212. </li>
    213. 

  213. </ul>
    214. 

  214. </li>
    215. 

  215. </ul>
    216. 

  216. <!-- ============ METHOD DETAIL ========== -->
    217. 

  217. <ul class="blockList">
    218. 

  218. <li class="blockList"><a name="method_detail">
    219. 

  219. <!--   -->
    220. 

  220. </a>
    221. 

  221. <h3>Method Detail</h3>
    222. 

  222. <a name="serialize()">
    223. 

  223. <!--   -->
    224. 

  224. </a>
    225. 

  225. <ul class="blockList">
    226. 

  226. <li class="blockList">
    227. 

  227. <h4>serialize</h4>
    228. 

  228. <pre>public final&nbsp;byte[]&nbsp;serialize()</pre>
    229. 

  229. <div class="block">called by the class that is responsible for writing this sucker.
    230. 

  230.  Subclasses should implement this so that their data is passed back in a
    231. 

  231.  byte array.</div>
    232. 

  232. <dl><dt><span class="strong">Returns:</span></dt><dd>byte array containing instance data</dd></dl>
    233. 

  233. </li>
    234. 

  234. </ul>
    235. 

  235. <a name="toString()">
    236. 

  236. <!--   -->
    237. 

  237. </a>
    238. 

  238. <ul class="blockList">
    239. 

  239. <li class="blockList">
    240. 

  240. <h4>toString</h4>
    241. 

  241. <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
    242. 

  242. <div class="block">get a string representation of the record (for biffview/debugging)</div>
    243. 

  243. <dl>
    244. 

  244. <dt><strong>Overrides:</strong></dt>
    245. 

  245. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
    246. 

  246. </dl>
    247. 

  247. </li>
    248. 

  248. </ul>
    249. 

  249. <a name="getSid()">
    250. 

  250. <!--   -->
    251. 

  251. </a>
    252. 

  252. <ul class="blockList">
    253. 

  253. <li class="blockList">
    254. 

  254. <h4>getSid</h4>
    255. 

  255. <pre>public abstract&nbsp;short&nbsp;getSid()</pre>
    256. 

  256. <div class="block">return the non static version of the id for this record.</div>
    257. 

  257. <dl><dt><span class="strong">Returns:</span></dt><dd>he id for this record</dd></dl>
    258. 

  258. </li>
    259. 

  259. </ul>
    260. 

  260. <a name="clone()">
    261. 

  261. <!--   -->
    262. 

  262. </a>
    263. 

  263. <ul class="blockList">
    264. 

  264. <li class="blockList">
    265. 

  265. <h4>clone</h4>
    266. 

  266. <pre>public&nbsp;java.lang.Object&nbsp;clone()
    267. 

  267.                        throws java.lang.CloneNotSupportedException</pre>
    268. 

  268. <dl>
    269. 

  269. <dt><strong>Overrides:</strong></dt>
    270. 

  270. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
    271. 

  271. <dt><span class="strong">Throws:</span></dt>
    272. 

  272. <dd><code>java.lang.CloneNotSupportedException</code></dd></dl>
    273. 

  273. </li>
    274. 

  274. </ul>
    275. 

  275. <a name="cloneViaReserialise()">
    276. 

  276. <!--   -->
    277. 

  277. </a>
    278. 

  278. <ul class="blockListLast">
    279. 

  279. <li class="blockList">
    280. 

  280. <h4>cloneViaReserialise</h4>
    281. 

  281. <pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&nbsp;cloneViaReserialise()</pre>
    282. 

  282. <div class="block">Clone the current record, via a call to serialize
    283. 

  283.   it, and another to create a new record from the
    284. 

  284.   bytes.
    285. 

  285.  May only be used for classes which don't have
    286. 

  286.   internal counts / ids in them. For those which
    287. 

  287.   do, a full model-aware cloning is needed, which
    288. 

  288.   allocates new ids / counts as needed.</div>
    289. 

  289. <dl><dt><span class="strong">Returns:</span></dt><dd>the cloned current record</dd></dl>
    290. 

  290. </li>
    291. 

  291. </ul>
    292. 

  292. </li>
    293. 

  293. </ul>
    294. 

  294. </li>
    295. 

  295. </ul>
    296. 

  296. </div>
    297. 

  297. </div>
    298. 

  298. <!-- ========= END OF CLASS DATA ========= -->
    299. 

  299. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    300. 

  300. <div class="bottomNav"><a name="navbar_bottom">
    301. 

  301. <!--   -->
    302. 

  302. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    303. 

  303. <!--   -->
    304. 

  304. </a>
    305. 

  305. <ul class="navList" title="Navigation">
    306. 

  306. <li><a href="../../../../../overview-summary.html">Overview</a></li>
    307. 

  307. <li><a href="package-summary.html">Package</a></li>
    308. 

  308. <li class="navBarCell1Rev">Class</li>
    309. 

  309. <li><a href="class-use/Record.html">Use</a></li>
    310. 

  310. <li><a href="package-tree.html">Tree</a></li>
    311. 

  311. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
    312. 

  312. <li><a href="../../../../../index-all.html">Index</a></li>
    313. 

  313. <li><a href="../../../../../help-doc.html">Help</a></li>
    314. 

  314. </ul>
    315. 

  315. </div>
    316. 

  316. <div class="subNav">
    317. 

  317. <ul class="navList">
    318. 

  318. <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>
    319. 

  319. <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>
    320. 

  320. </ul>
    321. 

  321. <ul class="navList">
    322. 

  322. <li><a href="../../../../../index.html?org/apache/poi/hssf/record/Record.html" target="_top">Frames</a></li>
    323. 

  323. <li><a href="Record.html" target="_top">No Frames</a></li>
    324. 

  324. </ul>
    325. 

  325. <ul class="navList" id="allclasses_navbar_bottom">
    326. 

  326. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
    327. 

  327. </ul>
    328. 

  328. <div>
    329. 

  329. <script type="text/javascript"><!--
    330. 

  330.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    331. 

  331.   if(window==top) {
    332. 

  332.     allClassesLink.style.display = "block";
    333. 

  333.   }
    334. 

  334.   else {
    335. 

  335.     allClassesLink.style.display = "none";
    336. 

  336.   }
    337. 

  337.   //-->
    338. 

  338. </script>
    339. 

  339. </div>
    340. 

  340. <div>
    341. 

  341. <ul class="subNavList">
    342. 

  342. <li>Summary:&nbsp;</li>
    343. 

  343. <li>Nested&nbsp;|&nbsp;</li>
    344. 

  344. <li>Field&nbsp;|&nbsp;</li>
    345. 

  345. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    346. 

  346. <li><a href="#method_summary">Method</a></li>
    347. 

  347. </ul>
    348. 

  348. <ul class="subNavList">
    349. 

  349. <li>Detail:&nbsp;</li>
    350. 

  350. <li>Field&nbsp;|&nbsp;</li>
    351. 

  351. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    352. 

  352. <li><a href="#method_detail">Method</a></li>
    353. 

  353. </ul>
    354. 

  354. </div>
    355. 

  355. <a name="skip-navbar_bottom">
    356. 

  356. <!--   -->
    357. 

  357. </a></div>
    358. 

  358. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    359. 

  359. <p class="legalCopy"><small>
    360. 

  360.                 <i>Copyright 2016 The Apache Software Foundation or
    361. 

  361.         its licensors, as applicable.</i>
    362. 

  362.             </small></p>
    363. 

  363. </body>
    364. 

  364. </html>
    365. 

  365.