aboutsummaryrefslogtreecommitdiff
path: root/doc/html/classorg_1_1openisis_1_1Rec.html
blob: 946fdbcf31a254174f053c3811934b19fda91ff7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>IsisReader: org::openisis::Rec Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>org</b>::<b>openisis</b>::<a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a>
  </div>
</div>
<div class="contents">
<h1>org::openisis::Rec Class Reference</h1><!-- doxytag: class="org::openisis::Rec" -->
<p><a href="classorg_1_1openisis_1_1Rec-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6342ea4678aa8dfc43d7140f629774a"></a><!-- doxytag: member="org::openisis::Rec::Rec" ref="ab6342ea4678aa8dfc43d7140f629774a" args="(int rowid, Field[] fields)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Rec</b> (int rowid, <a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[] fields)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ae1d0f6b30ed9cf544cbf18ae1704bf"></a><!-- doxytag: member="org::openisis::Rec::Rec" ref="a2ae1d0f6b30ed9cf544cbf18ae1704bf" args="(int rowid)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Rec</b> (int rowid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2fcf934bbeb2d51947a075ac6446c50"></a><!-- doxytag: member="org::openisis::Rec::getRowId" ref="af2fcf934bbeb2d51947a075ac6446c50" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>getRowId</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bc50e7a4a03e8cb706ffac2124ee8d0"></a><!-- doxytag: member="org::openisis::Rec::getLen" ref="a9bc50e7a4a03e8cb706ffac2124ee8d0" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>getLen</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a878b0668dbc478cc514828474a1c011d"></a><!-- doxytag: member="org::openisis::Rec::getField" ref="a878b0668dbc478cc514828474a1c011d" args="(int i)" -->
<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>getField</b> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77f73f229e14ab283b212cd4b6894140"></a><!-- doxytag: member="org::openisis::Rec::getFields" ref="a77f73f229e14ab283b212cd4b6894140" args="()" -->
<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[]&nbsp;</td><td class="memItemRight" valign="bottom"><b>getFields</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af371e8895cc06b27194afa73a6797838"></a><!-- doxytag: member="org::openisis::Rec::getFields" ref="af371e8895cc06b27194afa73a6797838" args="(int offset, int len)" -->
<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[]&nbsp;</td><td class="memItemRight" valign="bottom"><b>getFields</b> (int offset, int len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2470900bb0e9c706750bb967e1411f01"></a><!-- doxytag: member="org::openisis::Rec::append" ref="a2470900bb0e9c706750bb967e1411f01" args="(int tag, String value)" -->
boolean&nbsp;</td><td class="memItemRight" valign="bottom"><b>append</b> (int tag, String value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46163ac18990864b3713f39a9976d4cf"></a><!-- doxytag: member="org::openisis::Rec::append" ref="a46163ac18990864b3713f39a9976d4cf" args="(Field field)" -->
boolean&nbsp;</td><td class="memItemRight" valign="bottom"><b>append</b> (<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b28cac4ef68fcda2113fe2fa28bb96b"></a><!-- doxytag: member="org::openisis::Rec::append" ref="a3b28cac4ef68fcda2113fe2fa28bb96b" args="(Field[] fields)" -->
boolean&nbsp;</td><td class="memItemRight" valign="bottom"><b>append</b> (<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[] fields)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28346a15905a424a39e5c0d913bbf4bd"></a><!-- doxytag: member="org::openisis::Rec::wrap" ref="a28346a15905a424a39e5c0d913bbf4bd" args="(Rec record, int tag)" -->
boolean&nbsp;</td><td class="memItemRight" valign="bottom"><b>wrap</b> (<a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> record, int tag)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef26b04ad1fbf57e19350a9e3262020f"></a><!-- doxytag: member="org::openisis::Rec::unwrap" ref="aef26b04ad1fbf57e19350a9e3262020f" args="(int tag)" -->
<a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>unwrap</b> (int tag)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Rec.html#ad7ca8a477597c4b29becbdfa84ca41b3">v</a> (StringBuffer b, String cpre, String rpre, int tag, int mode, int occ, int len, String rsuf, String csuf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Rec.html#a8013e469b5090749c3785c42ff09c25f">v</a> (String cpre, String rpre, int tag, int mode, int occ, int len, String rsuf, String csuf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Rec.html#a86b30cfe61941c5fc832b4db0c7f8730">v</a> (String rpre, int tag, int mode, int occ, int len, String rsuf)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad696093842a29996b535eeadc921db08"></a><!-- doxytag: member="org::openisis::Rec::set" ref="ad696093842a29996b535eeadc921db08" args="(int pos, Field f)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set</b> (int pos, <a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00e95f4be022f47234436de80f535743"></a><!-- doxytag: member="org::openisis::Rec::get" ref="a00e95f4be022f47234436de80f535743" args="(int pos)" -->
<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>get</b> (int pos)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Record implementation of openisis java binding. </p>
<dl class="rcs"><dt><b>Id</b></dt><dd>Rec.java,v 1.4 2003/04/08 00:20:53 kripke <a class="el" href="unionExp.html">Exp</a> </dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd></dd></dl>
<dl class="rcs"><dt><b>Revision</b></dt><dd>1.4 </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd></dd></dl>
<dl class="rcs"><dt><b>Author</b></dt><dd>kripke </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a86b30cfe61941c5fc832b4db0c7f8730"></a><!-- doxytag: member="org::openisis::Rec::v" ref="a86b30cfe61941c5fc832b4db0c7f8730" args="(String rpre, int tag, int mode, int occ, int len, String rsuf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String org::openisis::Rec::v </td>
          <td>(</td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rpre</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>occ</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rsuf</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>format fields to a new StringBuffer, return it's content as String. the conditional pre and suf are null here. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a new String or the String Db.EMPTY, iff no fields where done. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Rec.html#ad7ca8a477597c4b29becbdfa84ca41b3">v(StringBuffer,String,String,int,int,int,int,String,String)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a8013e469b5090749c3785c42ff09c25f"></a><!-- doxytag: member="org::openisis::Rec::v" ref="a8013e469b5090749c3785c42ff09c25f" args="(String cpre, String rpre, int tag, int mode, int occ, int len, String rsuf, String csuf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String org::openisis::Rec::v </td>
          <td>(</td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>cpre</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rpre</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>occ</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rsuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>csuf</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>format fields to a new StringBuffer, return it's content as String. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a new String or the String Db.EMPTY, iff no fields where done. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Rec.html#ad7ca8a477597c4b29becbdfa84ca41b3">v(StringBuffer,String,String,int,int,int,int,String,String)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ad7ca8a477597c4b29becbdfa84ca41b3"></a><!-- doxytag: member="org::openisis::Rec::v" ref="ad7ca8a477597c4b29becbdfa84ca41b3" args="(StringBuffer b, String cpre, String rpre, int tag, int mode, int occ, int len, String rsuf, String csuf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int org::openisis::Rec::v </td>
          <td>(</td>
          <td class="paramtype">StringBuffer&nbsp;</td>
          <td class="paramname"> <em>b</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>cpre</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rpre</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>occ</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>rsuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&nbsp;</td>
          <td class="paramname"> <em>csuf</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>the field selector. format one or more occurences of a field to a StringBuffer, mimicking the ISIS Vn-operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>the StringBuffer to fill </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cpre</em>&nbsp;</td><td>conditional prefix: printed first, if anything is printed </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rpre</em>&nbsp;</td><td>repeated prefix: printed before every occ (but not the first, if mode include PP) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>the field number (0 = all) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>several mode bits as defined in <a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> + optional subfield char </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>occ</em>&nbsp;</td><td>a 16bit occ | end &lt;&lt; 16. if occ is 0, all occurences are printed. if the end (higher bytes) are 0, only this occ is printed, else all up to incl. end (use <a class="el" href="classorg_1_1openisis_1_1Db.html#a8fd27b8bb0c59b17f2e5edf37b1615a8">Db.LOCC</a> for all). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>a 16bit length constraint | offset &lt;&lt; 16 this is passed to <a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">Field.v</a> and applied for each occ. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rsuf</em>&nbsp;</td><td>repeated suffix: printed after every occ (but not the last, if mode include PS) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>csuf</em>&nbsp;</td><td>conditional suffix: printed last, if anything was printed </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of formatted occurences </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">Field::v(StringBuffer,int,String,int)</a> </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/openisis/org/openisis/Rec.java</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 30 14:47:17 2010 for IsisReader by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>