diff options
| author | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
|---|---|---|
| committer | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
| commit | b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch) | |
| tree | 5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/classorg_1_1openisis_1_1Db.html | |
| parent | 298ac8892db90e518da71540c8fab72f885d66ff (diff) | |
| download | cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2 | |
Adding generated docs
Diffstat (limited to 'doc/html/classorg_1_1openisis_1_1Db.html')
| -rw-r--r-- | doc/html/classorg_1_1openisis_1_1Db.html | 712 |
1 files changed, 712 insertions, 0 deletions
diff --git a/doc/html/classorg_1_1openisis_1_1Db.html b/doc/html/classorg_1_1openisis_1_1Db.html new file mode 100644 index 0000000..a22339d --- /dev/null +++ b/doc/html/classorg_1_1openisis_1_1Db.html @@ -0,0 +1,712 @@ +<!-- 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::Db 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 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 List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><b>org</b>::<b>openisis</b>::<a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> + </div> +</div> +<div class="contents"> +<h1>org::openisis::Db Class Reference</h1><!-- doxytag: class="org::openisis::Db" --><div class="dynheader"> +Inheritance diagram for org::openisis::Db:</div> +<div class="dynsection"> + <div class="center"> + <img src="classorg_1_1openisis_1_1Db.gif" usemap="#org::openisis::Db_map" alt=""/> + <map id="org::openisis::Db_map" name="org::openisis::Db_map"> +<area href="classorg_1_1openisis_1_1NativeDb.html" alt="org::openisis::NativeDb" shape="rect" coords="0,56,141,80"/> +<area href="classorg_1_1openisis_1_1PureDb.html" alt="org::openisis::PureDb" shape="rect" coords="151,56,292,80"/> +</map> + </div> +</div> + +<p><a href="classorg_1_1openisis_1_1Db-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">abstract <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#abdd740b99c2d95684c60e9c2fb8161ff">readRow</a> (int rowid)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">abstract short </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a110256d1b1653e2fd357994b143ec319">writeRow</a> (<a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> rec)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">abstract short </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ad6c68514dbc977086bcbb3f0eeabc2f4">writeXRow</a> (<a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> rec, <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> idx)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a9b638a4636a69a26a983ae26b02b6ff4">scanRow</a> (int rowid, int tag, String txt)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">abstract int[] </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ad7cf844dbb25d56dc861661ea40693a5">search</a> (String key, int mode)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8d0028cbc8d1a54ba82475486c1fdfd"></a><!-- doxytag: member="org::openisis::Db::terms" ref="ab8d0028cbc8d1a54ba82475486c1fdfd" args="(String prefix)" --> +abstract Iterator </td><td class="memItemRight" valign="bottom"><b>terms</b> (String prefix)</td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static synchronized <a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a248003ad2b4423ee8bf6a899e55d5611">open</a> (String dbname, String[] args) throws IOException </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a051fb17854dfc257748234eb797a1e31"></a><!-- doxytag: member="org::openisis::Db::AND" ref="a051fb17854dfc257748234eb797a1e31" args="(int[] set, int[] nset)" --> +static int[] </td><td class="memItemRight" valign="bottom"><b>AND</b> (int[] set, int[] nset)</td></tr> +<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">final String </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#aa00c89548ce8eaf12b50eb016fd7f02b">encoding</a></td></tr> +<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final String </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a8c097faae617c7999b4cc4876ce61882">DEFAULT_ENCODING</a> = "ISO-8859-1"</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1b04764a2a3de4dbf6cb545be05f0fa"></a><!-- doxytag: member="org::openisis::Db::EMPTY" ref="ab1b04764a2a3de4dbf6cb545be05f0fa" args="" --> +static final String </td><td class="memItemRight" valign="bottom"><b>EMPTY</b> = ""</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a28387a27a78a4cea23a94ae4f503a48d">QRY_KEYEQ</a> = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a3685c877ff126bf569c7e9c2dcec9260">QRY_KEYPF</a> = 1</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e1d16d22926719ab7a6fcbdda9e25d4"></a><!-- doxytag: member="org::openisis::Db::PREFIX" ref="a9e1d16d22926719ab7a6fcbdda9e25d4" args="" --> +static final int </td><td class="memItemRight" valign="bottom"><b>PREFIX</b> = <a class="el" href="classorg_1_1openisis_1_1Db.html#a3685c877ff126bf569c7e9c2dcec9260">QRY_KEYPF</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#acd651c525d35bf371bb881bc90341e88">QRY_KEYAT</a> = 2</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ac1ce62e3abf332816eaca6118633ff70">QRY_SCANE</a> = 64</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ae3cc8b21c13aa359422be55a68aafb1a">QRY_SCANC</a> = 65</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a8313370cadd3bbcded4e4d6bc936daa1">QRY_SIMPLE</a> = 128</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a15af23acb045b20f896a7bb7ec805e69">QRY_PROPER</a> = 129</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ab328af437ee1e2fd3f9338e45878cbbf">MHL</a> = 0x10000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a7dd08684cf470c19fe4e52c8ecda3a1b">MD</a> = 0x20000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a48fc4614a8a881114bac9fb448ff3828">MDL</a> = 0x30000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#aee5f5ded7d4cc23878188cded87ac0a6">MXU</a> = 0x40000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a3fb86175f13e337065323d4ffad9a997">MHU</a> = 0x50000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a824d7baa60c7223f1cdd0cdba009605b">MDU</a> = 0x70000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a645579fb38e45541529b2ad6e05de88a">MI</a> = 0x80000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a2131696f0e6c8a23f9877975da8c02b7">HTU</a> = 0x100000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ac9419c241a9944e84cff8ba5d8e97d8e">HTI</a> = 0x300000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ad1dad33907186cea27d419f6e5077e11">HTA</a> = 0x700000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a504095681c11486d5b116e2c666eebe9">PP</a> = 0x2000000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#afb5accf41593f226630cdf1fd2e2b763">PS</a> = 0x1000000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a292a4b500926d4ddea918f6f3c40b2b9">DS</a> = 0x4000000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#ab42f22193f72d14f56ca30569deadc60">NS</a> = 0x8000000</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1Db.html#a8fd27b8bb0c59b17f2e5edf37b1615a8">LOCC</a> = 0xffff << 16</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="a8d3c17bf01dfcac2555347e4f3053a01"></a><!-- doxytag: member="org::openisis::Db::Db" ref="a8d3c17bf01dfcac2555347e4f3053a01" args="(String enc)" --> + </td><td class="memItemRight" valign="bottom"><b>Db</b> (String enc)</td></tr> +<tr><td colspan="2"><h2>Static Package Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ef17c8ef4c94eba1d49b3177746d6a8"></a><!-- doxytag: member="org::openisis::Db::_dbs" ref="a1ef17c8ef4c94eba1d49b3177746d6a8" args="" --> +static final Map </td><td class="memItemRight" valign="bottom"><b>_dbs</b> = new HashMap()</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>This class represents an isis db. The actual implementation is done in derived classes. </p> +<dl class="rcs"><dt><b>Id</b></dt><dd>Db.java,v 1.6 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.6 </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="a248003ad2b4423ee8bf6a899e55d5611"></a><!-- doxytag: member="org::openisis::Db::open" ref="a248003ad2b4423ee8bf6a899e55d5611" args="(String dbname, String[] args)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static synchronized <a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> org::openisis::Db::open </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>dbname</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String[] </td> + <td class="paramname"> <em>args</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> throws IOException <code> [inline, static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>open an isis database. The following options are supported as text-style parameters: </p> +<ul> +<li> +-db <name><br/> + basename of database. same as param dbname. </li> +<li> +-dbpath <path><br/> + path to database. usefull when opening secondary indexes or other files whose names are not based on the db basename. </li> +<li> +-v <level><br/> + set verbosity level </li> +<li> +-encoding <enc><br/> + select encoding used in db bytes. default is DEFAULT_ENCODING. </li> +<li> +-puredb<br/> + select pure java implementation. by default the <a class="el" href="classorg_1_1openisis_1_1NativeDb.html">NativeDb</a> is used. </li> +</ul> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>dbname</em> </td><td>basename of database. the dbhome arg, if given, will be prepended, and the ISIS file extensions appended to build the actual filename. Therefore, depending on the value of dbhome and location of files, this may need to include a path. db may be <code>null</code>, if argv includes a dbname arg. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>array of names and values. May be <code>null</code>. argv contains parameter names, which may be prefixed by a dash '-'. Depending on the actual parameter, the next string may or must contain a corresponding parameter value. An optional parameter value may be omitted, if at end of argv or the next name is prefixed with a dash. To avoid ambiguity, values never start with a dash. See above for a list of supported parameter names. Unrecognized parameter names are ignored. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>a new <a class="el" href="classorg_1_1openisis_1_1Db.html">Db</a> (unless some RuntimeException is thrown) </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>IoException</em> </td><td>especially FileNotFoundExceptiond and UnsupportedEncodingException </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="abdd740b99c2d95684c60e9c2fb8161ff"></a><!-- doxytag: member="org::openisis::Db::readRow" ref="abdd740b99c2d95684c60e9c2fb8161ff" args="(int rowid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">abstract <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> org::openisis::Db::readRow </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>rowid</em></td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>read a cooked row. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>rowid</em> </td><td>the mfn </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> or null, if row not available. </dd></dl> + +<p>Implemented in <a class="el" href="classorg_1_1openisis_1_1NativeDb.html#a024b1d75577871b9944e0debbfea8eaf">org::openisis::NativeDb</a>, and <a class="el" href="classorg_1_1openisis_1_1PureDb.html#a296f17c10ef258cd6b21cb9536658cb9">org::openisis::PureDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a9b638a4636a69a26a983ae26b02b6ff4"></a><!-- doxytag: member="org::openisis::Db::scanRow" ref="a9b638a4636a69a26a983ae26b02b6ff4" args="(int rowid, int tag, String txt)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">abstract <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> org::openisis::Db::scanRow </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>rowid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"> <em>txt</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>read the first row with rowid >= given rowid and containing txt in subfield tag (any, if 0). </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>rowid</em> </td><td>the mfn </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> or null, if row not available. </dd></dl> + +<p>Implemented in <a class="el" href="classorg_1_1openisis_1_1NativeDb.html#aa57ee68b6d4f1a2c1ec1a8994c15e46b">org::openisis::NativeDb</a>, and <a class="el" href="classorg_1_1openisis_1_1PureDb.html#a5481e768ae8819f046f0374212294b8e">org::openisis::PureDb</a>.</p> + +</div> +</div> +<a class="anchor" id="ad7cf844dbb25d56dc861661ea40693a5"></a><!-- doxytag: member="org::openisis::Db::search" ref="ad7cf844dbb25d56dc861661ea40693a5" args="(String key, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">abstract int [] org::openisis::Db::search </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>read the array of rowids matching key. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to look for </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>one of the QRY_ constants above. may be ored with a tag<<16 to limit search to that field </td></tr> + </table> + </dd> +</dl> + +<p>Implemented in <a class="el" href="classorg_1_1openisis_1_1NativeDb.html#a4792480dd3c30c4725064d443096802f">org::openisis::NativeDb</a>, and <a class="el" href="classorg_1_1openisis_1_1PureDb.html#a633bceb9628a59684745ec893ca5c604">org::openisis::PureDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a110256d1b1653e2fd357994b143ec319"></a><!-- doxytag: member="org::openisis::Db::writeRow" ref="a110256d1b1653e2fd357994b143ec319" args="(Rec rec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">abstract short org::openisis::Db::writeRow </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> </td> + <td class="paramname"> <em>rec</em></td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>write a cooked row. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>row</em> </td><td>the <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> to be written </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>0 if write succeeded, else a negative error code </dd></dl> + +<p>Implemented in <a class="el" href="classorg_1_1openisis_1_1NativeDb.html#a5f27b1c1f94237221bb0f4b0e0474c15">org::openisis::NativeDb</a>, and <a class="el" href="classorg_1_1openisis_1_1PureDb.html#a8b6f92317636de915fa98b0929b375f1">org::openisis::PureDb</a>.</p> + +</div> +</div> +<a class="anchor" id="ad6c68514dbc977086bcbb3f0eeabc2f4"></a><!-- doxytag: member="org::openisis::Db::writeXRow" ref="ad6c68514dbc977086bcbb3f0eeabc2f4" args="(Rec rec, Rec idx)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">abstract short org::openisis::Db::writeXRow </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> </td> + <td class="paramname"> <em>rec</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> </td> + <td class="paramname"> <em>idx</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>write a cooked row together with index information. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>row</em> </td><td>the <a class="el" href="classorg_1_1openisis_1_1Rec.html">Rec</a> to be written </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success else a negative error code </dd></dl> + +<p>Implemented in <a class="el" href="classorg_1_1openisis_1_1NativeDb.html#ad125fcc8939934b9958fbb81360e675c">org::openisis::NativeDb</a>, and <a class="el" href="classorg_1_1openisis_1_1PureDb.html#a636f667c6746d991827937a9b322ae28">org::openisis::PureDb</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a8c097faae617c7999b4cc4876ce61882"></a><!-- doxytag: member="org::openisis::Db::DEFAULT_ENCODING" ref="a8c097faae617c7999b4cc4876ce61882" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final String <a class="el" href="classorg_1_1openisis_1_1Db.html#a8c097faae617c7999b4cc4876ce61882">org::openisis::Db::DEFAULT_ENCODING</a> = "ISO-8859-1"<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>the default encoding. the constant String value is "ISO-8859-1". </p> + +</div> +</div> +<a class="anchor" id="a292a4b500926d4ddea918f6f3c40b2b9"></a><!-- doxytag: member="org::openisis::Db::DS" ref="a292a4b500926d4ddea918f6f3c40b2b9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a292a4b500926d4ddea918f6f3c40b2b9">org::openisis::Db::DS</a> = 0x4000000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>rec v: dummy presence selector Dn </p> + +</div> +</div> +<a class="anchor" id="aa00c89548ce8eaf12b50eb016fd7f02b"></a><!-- doxytag: member="org::openisis::Db::encoding" ref="aa00c89548ce8eaf12b50eb016fd7f02b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final String <a class="el" href="classorg_1_1openisis_1_1Db.html#aa00c89548ce8eaf12b50eb016fd7f02b">org::openisis::Db::encoding</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>encoding used for records in this db. NOTE that String args are not converted according to this encoding, but rather are passed as Java UTF-8, so you better stick to 7 bits. </p> + +</div> +</div> +<a class="anchor" id="ad1dad33907186cea27d419f6e5077e11"></a><!-- doxytag: member="org::openisis::Db::HTA" ref="ad1dad33907186cea27d419f6e5077e11" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ad1dad33907186cea27d419f6e5077e11">org::openisis::Db::HTA</a> = 0x700000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: 7bit ASCII HTML. HTML-entities and all chars greater than 127 are escaped. </p> + +</div> +</div> +<a class="anchor" id="ac9419c241a9944e84cff8ba5d8e97d8e"></a><!-- doxytag: member="org::openisis::Db::HTI" ref="ac9419c241a9944e84cff8ba5d8e97d8e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ac9419c241a9944e84cff8ba5d8e97d8e">org::openisis::Db::HTI</a> = 0x300000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: 8bit ISO-8859-1 HTML. HTML-entities and all chars greater than 255 are escaped. </p> + +</div> +</div> +<a class="anchor" id="a2131696f0e6c8a23f9877975da8c02b7"></a><!-- doxytag: member="org::openisis::Db::HTU" ref="a2131696f0e6c8a23f9877975da8c02b7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a2131696f0e6c8a23f9877975da8c02b7">org::openisis::Db::HTU</a> = 0x100000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: 16bit UNICODE HTML. HTML-entities are escaped. </p> + +</div> +</div> +<a class="anchor" id="a8fd27b8bb0c59b17f2e5edf37b1615a8"></a><!-- doxytag: member="org::openisis::Db::LOCC" ref="a8fd27b8bb0c59b17f2e5edf37b1615a8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a8fd27b8bb0c59b17f2e5edf37b1615a8">org::openisis::Db::LOCC</a> = 0xffff << 16<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>rec v: occurence range up to last occ </p> + +</div> +</div> +<a class="anchor" id="a7dd08684cf470c19fe4e52c8ecda3a1b"></a><!-- doxytag: member="org::openisis::Db::MD" ref="a7dd08684cf470c19fe4e52c8ecda3a1b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a7dd08684cf470c19fe4e52c8ecda3a1b">org::openisis::Db::MD</a> = 0x20000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: data flag (no effect w/o heading) </p> + +</div> +</div> +<a class="anchor" id="a48fc4614a8a881114bac9fb448ff3828"></a><!-- doxytag: member="org::openisis::Db::MDL" ref="a48fc4614a8a881114bac9fb448ff3828" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a48fc4614a8a881114bac9fb448ff3828">org::openisis::Db::MDL</a> = 0x30000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: data mode (includes heading flag) </p> + +</div> +</div> +<a class="anchor" id="a824d7baa60c7223f1cdd0cdba009605b"></a><!-- doxytag: member="org::openisis::Db::MDU" ref="a824d7baa60c7223f1cdd0cdba009605b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a824d7baa60c7223f1cdd0cdba009605b">org::openisis::Db::MDU</a> = 0x70000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: uppercase data mode </p> + +</div> +</div> +<a class="anchor" id="ab328af437ee1e2fd3f9338e45878cbbf"></a><!-- doxytag: member="org::openisis::Db::MHL" ref="ab328af437ee1e2fd3f9338e45878cbbf" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ab328af437ee1e2fd3f9338e45878cbbf">org::openisis::Db::MHL</a> = 0x10000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: heading mode </p> + +</div> +</div> +<a class="anchor" id="a3fb86175f13e337065323d4ffad9a997"></a><!-- doxytag: member="org::openisis::Db::MHU" ref="a3fb86175f13e337065323d4ffad9a997" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a3fb86175f13e337065323d4ffad9a997">org::openisis::Db::MHU</a> = 0x50000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: uppercase heading mode </p> + +</div> +</div> +<a class="anchor" id="a645579fb38e45541529b2ad6e05de88a"></a><!-- doxytag: member="org::openisis::Db::MI" ref="a645579fb38e45541529b2ad6e05de88a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a645579fb38e45541529b2ad6e05de88a">org::openisis::Db::MI</a> = 0x80000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: index formatting flag </p> + +</div> +</div> +<a class="anchor" id="aee5f5ded7d4cc23878188cded87ac0a6"></a><!-- doxytag: member="org::openisis::Db::MXU" ref="aee5f5ded7d4cc23878188cded87ac0a6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#aee5f5ded7d4cc23878188cded87ac0a6">org::openisis::Db::MXU</a> = 0x40000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>field v: uppercase mode flag </p> + +</div> +</div> +<a class="anchor" id="ab42f22193f72d14f56ca30569deadc60"></a><!-- doxytag: member="org::openisis::Db::NS" ref="ab42f22193f72d14f56ca30569deadc60" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ab42f22193f72d14f56ca30569deadc60">org::openisis::Db::NS</a> = 0x8000000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>rec v: dummy absence selector Nn </p> + +</div> +</div> +<a class="anchor" id="a504095681c11486d5b116e2c666eebe9"></a><!-- doxytag: member="org::openisis::Db::PP" ref="a504095681c11486d5b116e2c666eebe9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a504095681c11486d5b116e2c666eebe9">org::openisis::Db::PP</a> = 0x2000000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>rec v: repeated prefix plus operator (not on 1st occ) </p> + +</div> +</div> +<a class="anchor" id="afb5accf41593f226630cdf1fd2e2b763"></a><!-- doxytag: member="org::openisis::Db::PS" ref="afb5accf41593f226630cdf1fd2e2b763" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#afb5accf41593f226630cdf1fd2e2b763">org::openisis::Db::PS</a> = 0x1000000<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>rec v: repeated suffix plus operator (not on last occ) </p> + +</div> +</div> +<a class="anchor" id="acd651c525d35bf371bb881bc90341e88"></a><!-- doxytag: member="org::openisis::Db::QRY_KEYAT" ref="acd651c525d35bf371bb881bc90341e88" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#acd651c525d35bf371bb881bc90341e88">org::openisis::Db::QRY_KEYAT</a> = 2<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>index scan key auto (checks for '$') </p> + +</div> +</div> +<a class="anchor" id="a28387a27a78a4cea23a94ae4f503a48d"></a><!-- doxytag: member="org::openisis::Db::QRY_KEYEQ" ref="a28387a27a78a4cea23a94ae4f503a48d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a28387a27a78a4cea23a94ae4f503a48d">org::openisis::Db::QRY_KEYEQ</a> = 0<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>index scan key equal </p> + +</div> +</div> +<a class="anchor" id="a3685c877ff126bf569c7e9c2dcec9260"></a><!-- doxytag: member="org::openisis::Db::QRY_KEYPF" ref="a3685c877ff126bf569c7e9c2dcec9260" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a3685c877ff126bf569c7e9c2dcec9260">org::openisis::Db::QRY_KEYPF</a> = 1<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>index scan key prefix </p> + +</div> +</div> +<a class="anchor" id="a15af23acb045b20f896a7bb7ec805e69"></a><!-- doxytag: member="org::openisis::Db::QRY_PROPER" ref="a15af23acb045b20f896a7bb7ec805e69" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a15af23acb045b20f896a7bb7ec805e69">org::openisis::Db::QRY_PROPER</a> = 129<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>query expression with proper binding using precedence, () </p> + +</div> +</div> +<a class="anchor" id="ae3cc8b21c13aa359422be55a68aafb1a"></a><!-- doxytag: member="org::openisis::Db::QRY_SCANC" ref="ae3cc8b21c13aa359422be55a68aafb1a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ae3cc8b21c13aa359422be55a68aafb1a">org::openisis::Db::QRY_SCANC</a> = 65<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>fulltext scan for contains </p> + +</div> +</div> +<a class="anchor" id="ac1ce62e3abf332816eaca6118633ff70"></a><!-- doxytag: member="org::openisis::Db::QRY_SCANE" ref="ac1ce62e3abf332816eaca6118633ff70" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#ac1ce62e3abf332816eaca6118633ff70">org::openisis::Db::QRY_SCANE</a> = 64<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>fulltext scan for equal </p> + +</div> +</div> +<a class="anchor" id="a8313370cadd3bbcded4e4d6bc936daa1"></a><!-- doxytag: member="org::openisis::Db::QRY_SIMPLE" ref="a8313370cadd3bbcded4e4d6bc936daa1" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">final int <a class="el" href="classorg_1_1openisis_1_1Db.html#a8313370cadd3bbcded4e4d6bc936daa1">org::openisis::Db::QRY_SIMPLE</a> = 128<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>query expression with simple left-to-right binding </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>contrib/openisis/org/openisis/Db.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </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 +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |