aboutsummaryrefslogtreecommitdiff
path: root/doc/html/classorg_1_1openisis_1_1Field.html
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2010-08-20 15:39:56 -0300
committerSilvio <silvio@devlet.com.br>2010-08-20 15:39:56 -0300
commitb879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch)
tree5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/classorg_1_1openisis_1_1Field.html
parent298ac8892db90e518da71540c8fab72f885d66ff (diff)
downloadcinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz
cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2
Adding generated docs
Diffstat (limited to 'doc/html/classorg_1_1openisis_1_1Field.html')
-rw-r--r--doc/html/classorg_1_1openisis_1_1Field.html343
1 files changed, 343 insertions, 0 deletions
diff --git a/doc/html/classorg_1_1openisis_1_1Field.html b/doc/html/classorg_1_1openisis_1_1Field.html
new file mode 100644
index 0000000..384f14c
--- /dev/null
+++ b/doc/html/classorg_1_1openisis_1_1Field.html
@@ -0,0 +1,343 @@
+<!-- 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::Field 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_1Field.html">Field</a>
+ </div>
+</div>
+<div class="contents">
+<h1>org::openisis::Field Class Reference</h1><!-- doxytag: class="org::openisis::Field" -->
+<p><a href="classorg_1_1openisis_1_1Field-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="a2308868deb1c117e0356a293b735e5fb"></a><!-- doxytag: member="org::openisis::Field::Field" ref="a2308868deb1c117e0356a293b735e5fb" args="(int tag_, String val_)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>Field</b> (int tag_, String val_)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d4a00a677d18d20e0bdb6ebd5fd459e"></a><!-- doxytag: member="org::openisis::Field::equals" ref="a2d4a00a677d18d20e0bdb6ebd5fd459e" args="(Object that)" -->
+boolean&nbsp;</td><td class="memItemRight" valign="bottom"><b>equals</b> (Object that)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdeeb51ed856401883e89da4491b583b"></a><!-- doxytag: member="org::openisis::Field::toString" ref="acdeeb51ed856401883e89da4491b583b" args="()" -->
+String&nbsp;</td><td class="memItemRight" valign="bottom"><b>toString</b> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[]&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#ad77808ca386e4a9c7d63e16bf48e2950">split</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7654a9a4d5f78fffef396ca94cf8f5f3"></a><!-- doxytag: member="org::openisis::Field::getValue" ref="a7654a9a4d5f78fffef396ca94cf8f5f3" args="()" -->
+String&nbsp;</td><td class="memItemRight" valign="bottom"><b>getValue</b> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27acfcb21970f03b28ea04667531e962"></a><!-- doxytag: member="org::openisis::Field::getSubFields" ref="a27acfcb21970f03b28ea04667531e962" args="()" -->
+<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[]&nbsp;</td><td class="memItemRight" valign="bottom"><b>getSubFields</b> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#a51b5dc8495bf6554519fc2267974776b">v</a> (StringBuffer b, int mode)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#affd30e594a11dbd6d7b946b60e841622">v</a> (StringBuffer b, int mode, int len)</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_1Field.html#acc9b79aac50713c6d31c09f4bfaf556b">v</a> (int mode, int len)</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_1Field.html#a1d0dd9d7a014453cf64cfb5f0cfdc8ff">v</a> (int mode)</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_1Field.html#a4f74649439b45c20237018319e880325">html</a> ()</td></tr>
+<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v</a> (StringBuffer b, int mode, String plain, int len)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#acb2b38ba15c789d40fea9e7957514f94">html</a> (String plain)</td></tr>
+<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">final int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Field.html#a07884decd97e0f7ed5a7967682c15e7e">tag</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00bbf0e55f66ff41c62f7e185b00beda"></a><!-- doxytag: member="org::openisis::Field::val" ref="a00bbf0e55f66ff41c62f7e185b00beda" args="" -->
+final String&nbsp;</td><td class="memItemRight" valign="bottom"><b>val</b></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> implementation of openisis java binding. A <a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> is an immutable structure, binding a String value to a tag. It provides methods for formatted access to the value. </p>
+<dl class="rcs"><dt><b>Id</b></dt><dd>Field.java,v 1.5 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.5 </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="a4f74649439b45c20237018319e880325"></a><!-- doxytag: member="org::openisis::Field::html" ref="a4f74649439b45c20237018319e880325" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">String org::openisis::Field::html </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>format field in HTU-mode as new String. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="acb2b38ba15c789d40fea9e7957514f94"></a><!-- doxytag: member="org::openisis::Field::html" ref="acb2b38ba15c789d40fea9e7957514f94" args="(String plain)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">static String org::openisis::Field::html </td>
+ <td>(</td>
+ <td class="paramtype">String&nbsp;</td>
+ <td class="paramname"> <em>plain</em></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline, static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>format a String in HTU-mode. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ad77808ca386e4a9c7d63e16bf48e2950"></a><!-- doxytag: member="org::openisis::Field::split" ref="ad77808ca386e4a9c7d63e16bf48e2950" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> [] org::openisis::Field::split </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>split the <a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> into subfields. </p>
+
+</div>
+</div>
+<a class="anchor" id="a1d0dd9d7a014453cf64cfb5f0cfdc8ff"></a><!-- doxytag: member="org::openisis::Field::v" ref="a1d0dd9d7a014453cf64cfb5f0cfdc8ff" args="(int mode)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">String org::openisis::Field::v </td>
+ <td>(</td>
+ <td class="paramtype">int&nbsp;</td>
+ <td class="paramname"> <em>mode</em></td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>format field as new String. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="acc9b79aac50713c6d31c09f4bfaf556b"></a><!-- doxytag: member="org::openisis::Field::v" ref="acc9b79aac50713c6d31c09f4bfaf556b" args="(int mode, int len)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">String org::openisis::Field::v </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>len</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 field as new String. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="affd30e594a11dbd6d7b946b60e841622"></a><!-- doxytag: member="org::openisis::Field::v" ref="affd30e594a11dbd6d7b946b60e841622" args="(StringBuffer b, int mode, int len)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">boolean org::openisis::Field::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">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>len</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 field to a StringBuffer. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a51b5dc8495bf6554519fc2267974776b"></a><!-- doxytag: member="org::openisis::Field::v" ref="a51b5dc8495bf6554519fc2267974776b" args="(StringBuffer b, int mode)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">boolean org::openisis::Field::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">int&nbsp;</td>
+ <td class="paramname"> <em>mode</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 field to a StringBuffer. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classorg_1_1openisis_1_1Field.html#ac4432b96bf4b99dbfbb386f2c8103b91">v(StringBuffer,int,String,int)</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ac4432b96bf4b99dbfbb386f2c8103b91"></a><!-- doxytag: member="org::openisis::Field::v" ref="ac4432b96bf4b99dbfbb386f2c8103b91" args="(StringBuffer b, int mode, String plain, int len)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">static boolean org::openisis::Field::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">int&nbsp;</td>
+ <td class="paramname"> <em>mode</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">String&nbsp;</td>
+ <td class="paramname"> <em>plain</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int&nbsp;</td>
+ <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [inline, static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>what a single field can contribute to the V 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>a StringBuffer to append to </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>OR-combination of the field formatting flags defined in <a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> and an optional subfield character. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>plain</em>&nbsp;</td><td>a String to format </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>a 16bit length constraint | offset &lt;&lt; 16 </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>false iff a non-existing subfield was requested, else true </dd></dl>
+
+</div>
+</div>
+<hr/><h2>Member Data Documentation</h2>
+<a class="anchor" id="a07884decd97e0f7ed5a7967682c15e7e"></a><!-- doxytag: member="org::openisis::Field::tag" ref="a07884decd97e0f7ed5a7967682c15e7e" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Field.html#a07884decd97e0f7ed5a7967682c15e7e">org::openisis::Field::tag</a></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>the tag of this field. For primary fields, this is the field number. For subfields, this is actually a char. </p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>contrib/openisis/org/openisis/Field.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>