From b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a Mon Sep 17 00:00:00 2001 From: Silvio Date: Fri, 20 Aug 2010 15:39:56 -0300 Subject: Adding generated docs --- doc/html/classorg_1_1openisis_1_1NativeDb.html | 311 +++++++++++++++++++++++++ 1 file changed, 311 insertions(+) create mode 100644 doc/html/classorg_1_1openisis_1_1NativeDb.html (limited to 'doc/html/classorg_1_1openisis_1_1NativeDb.html') diff --git a/doc/html/classorg_1_1openisis_1_1NativeDb.html b/doc/html/classorg_1_1openisis_1_1NativeDb.html new file mode 100644 index 0000000..c67de95 --- /dev/null +++ b/doc/html/classorg_1_1openisis_1_1NativeDb.html @@ -0,0 +1,311 @@ + + + + + +IsisReader: org::openisis::NativeDb Class Reference + + + + + + + + + +
+

org::openisis::NativeDb Class Reference

+Inheritance diagram for org::openisis::NativeDb:
+
+
+ + +org::openisis::Db + +
+
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + +

Classes

class  TermIterator

Public Member Functions

+byte[] cvt (String txt)
+String cvt (byte[] b)
+ NativeDb (String enc, String dbname, String[] args) throws IOException
Rec readRow (int rowid)
short writeRow (Rec rec)
short writeXRow (Rec rec, Rec idx)
Rec scanRow (int rowid, int tag, String txt)
int[] search (String key, int mode)
+Iterator terms (String prefix)

Public Attributes

final short db

Package Functions

+Rec mkRow (Object[] buf)
+Object[] mkBuf (Rec rec)

Static Package Functions

+ [static initializer]
+

Detailed Description

+

This class is the native implementation of class Db.

+

Installation

+

The shared library "openjsis" must be loadable. On a UNIX System, make sure that the file libopenjsis.so resides in a directory listed by the environment variable LD_LIBRARY_PATH or in /etc/ld.so.conf. If you just drop it in /usr/lib or similar dir, you may have to run a command like ldconfig.

+

On Windows, put openjsis.dll somewhere in the PATH.

+
Id
NativeDb.java,v 1.5 2003/04/08 00:20:53 kripke Exp
+
Version:
+
Revision
1.5
+
Author:
+
Author
kripke
+

Member Function Documentation

+ +
+
+ + + + + + + + + +
Rec org::openisis::NativeDb::readRow (int  rowid )  [inline, virtual]
+
+
+

read a cooked row.

+
Parameters:
+ + +
rowid the mfn
+
+
+
Returns:
a Rec or null, if row not available.
+ +

Implements org::openisis::Db.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Rec org::openisis::NativeDb::scanRow (int  rowid,
int  tag,
String  txt 
) [inline, virtual]
+
+
+

read the first row with rowid >= given rowid and containing txt in subfield tag (any, if 0).

+
Parameters:
+ + +
rowid the mfn
+
+
+
Returns:
a Rec or null, if row not available.
+ +

Implements org::openisis::Db.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int [] org::openisis::NativeDb::search (String  key,
int  mode 
) [inline, virtual]
+
+
+

read the array of rowids matching key.

+
Parameters:
+ + + +
key key to look for
mode one of the QRY_ constants above. may be ored with a tag<<16 to limit search to that field
+
+
+ +

Implements org::openisis::Db.

+ +
+
+ +
+
+ + + + + + + + + +
short org::openisis::NativeDb::writeRow (Rec  rec )  [inline, virtual]
+
+
+

write a cooked row.

+
Parameters:
+ + +
row the Rec to be written
+
+
+
Returns:
0 if write succeeded, else a negative error code
+ +

Implements org::openisis::Db.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
short org::openisis::NativeDb::writeXRow (Rec  rec,
Rec  idx 
) [inline, virtual]
+
+
+

write a cooked row together with index information.

+
Parameters:
+ + +
row the Rec to be written
+
+
+
Returns:
0 on success else a negative error code
+ +

Implements org::openisis::Db.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
final short org::openisis::NativeDb::db
+
+
+

Number of this db.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+ All Classes Namespaces Functions Variables
+ + +
+ +
+ +
Generated on Tue Mar 30 14:47:17 2010 for IsisReader by  + +doxygen 1.6.1
+ + -- cgit v1.2.3