mhs-xapian 1.0.18a

data/java/README

@@ -0,0 +1,76 @@
+How to build the bindings:
+==========================
+
+Running "make" and then "make install" will "install" a JNI glue shared library
+into a "built" subdirectory of the java build directory.  The jar file is built
+into the "built" subdirectory too.
+
+You can copy these two files into your java installation, or just use them
+in-place.
+
+How to compile the examples:
+============================
+
+  cd java
+  javac -classpath built/xapian_jni.jar:. org/xapian/examples/SimpleIndex.java
+  javac -classpath built/xapian_jni.jar:. org/xapian/examples/SimpleSearch.java
+
+How to run the examples:
+========================
+
+To run the examples, you need to give Java a special system-property named
+"java.library.path".  The value of this property is the path of the directory
+where the libxapian_jni.so (or whatever extension is used on your platform)
+JNI library is located.
+
+ java -Djava.library.path=built -classpath built/xapian_jni.jar:. \
+      org.xapian.examples.SimpleIndex ./test.db index words like java
+
+ java -Djava.library.path=built -classpath built/xapian_jni.jar:. \
+      org.xapian.examples.SimpleSearch ./test.db index words like java
+
+Alternatively, you can avoid needing the -Djava.library.path setting by
+setting the LD_LIBRARY_PATH environment variable, or by installing the JNI
+library in the appropriate directory so your JVM finds it automatically
+(for example, on Mac OS X you can copy it into /Library/Java/Extensions/).
+
+The java bindings have been tested with Debian packages of GCJ 3.4 and GIJ 3.4,
+with Sun java versions 1.4.1_01a and 1.5.0_06-b05, and with Eclipse Java
+Compiler 0.536 and GIJ 4.0.1.
+
+They should work with any java toolchain with suitable JNI support - please
+report success stories or any problems to the development mailing list:
+xapian-devel@lists.xapian.org
+
+Naming of wrapped methods:
+==========================
+
+Methods are renamed to match Java's naming conventions.  So get_mset becomes
+getMSet, etc.  Also get_description is wrapped as toString.
+
+TODO list:
+==========
+
+* OSF/1 on alpha needs "-pthread".  Other platforms may need something too...
+
+* Fix string passing to be zero-byte clean.
+
+The majority of the C++ API is wrapped, with a few exceptions still to be done:
+
+* Wrap optional parameter "parameter" for Query ctor.
+
+* Wrap new QueryParser API.
+
+* Wrap changes to Enquire sorting API.
+
+* Use Stem::operator() rather than Stem::stem_word().
+
+* Wrap new method ESet::back().
+
+* Wrap the new optional third parameter to Enquire::set_sorting().
+
+* Third (optional) argument to Document::add_posting() isn't wrapped.
+
+* Wrap Xapian::Weight and standard subclasses.
+
+* Allow user derived weight classes to be implemented in Java (less important).

data/java/SmokeTest.java

@@ -0,0 +1,148 @@
+// Simple test that we can use xapian from java
+//
+// Copyright (C) 2005,2006 Olly Betts
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 2 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
+// USA
+
+import org.xapian.*;
+import org.xapian.errors.*;
+
+class MyMatchDecider implements MatchDecider {
+    public boolean accept(Document d) {
+	// NB It's not normally appropriate to call getData() in a MatchDecider
+	// but we do it here to make sure we don't get an empty document.
+	try {
+	    return d.getData() == "";
+	} catch (XapianError e) {
+	    return true;
+	}
+    }
+}
+
+class MyExpandDecider implements ExpandDecider {
+    public boolean accept(String s) { return s.substring(0, 1) != "a"; }
+}
+
+public class SmokeTest {
+    public static void main(String[] args) throws Exception {
+	try {
+	    Stem stem = new Stem("english");
+	    if (!stem.toString().equals("Xapian::Stem(english)")) {
+		System.err.println("Unexpected stem.toString()");
+		System.exit(1);
+	    }
+	    Document doc = new Document();
+	    doc.setData("is there anybody out there?");
+	    doc.addTerm("XYzzy");
+	    doc.addPosting(stem.stemWord("is"), 1);
+	    doc.addPosting(stem.stemWord("there"), 2);
+	    doc.addPosting(stem.stemWord("anybody"), 3);
+	    doc.addPosting(stem.stemWord("out"), 4);
+	    doc.addPosting(stem.stemWord("there"), 5);
+	    WritableDatabase db = Xapian.InMemory.open();
+	    db.addDocument(doc);
+	    if (db.getDocCount() != 1) {
+		System.err.println("Unexpected db.getDocCount()");
+		System.exit(1);
+	    }
+
+	    String[] terms = { "smoke", "test", "terms" };
+	    Query query = new Query(Query.OP_OR, terms);
+	    if (!query.toString().equals("Xapian::Query((smoke OR test OR terms))")) {
+		System.err.println("Unexpected query.toString()");
+		System.exit(1);
+	    }
+	    Query[] queries = { new Query("smoke"), query, new Query("string") };
+	    Query query2 = new Query(Query.OP_XOR, queries);
+	    if (!query2.toString().equals("Xapian::Query((smoke XOR (smoke OR test OR terms) XOR string))")) {
+		System.err.println("Unexpected query2.toString()");
+		System.exit(1);
+	    }
+	    String[] subqs = { "a", "b" };
+	    Query query3 = new Query(Query.OP_OR, subqs);
+	    if (!query3.toString().equals("Xapian::Query((a OR b))")) {
+		System.err.println("Unexpected query3.toString()");
+		System.exit(1);
+	    }
+	    Enquire enq = new Enquire(db);
+	    enq.setQuery(new Query(Query.OP_OR, "there", "is"));
+	    MSet mset = enq.getMSet(0, 10);
+	    if (mset.size() != 1) {
+		System.err.println("Unexpected mset.size()");
+		System.exit(1);
+	    }
+	    String term_str = "";
+	    TermIterator itor = enq.getMatchingTerms(mset.getElement(0));
+	    while (itor.hasNext()) {
+		term_str += itor.next();
+		if (itor.hasNext()) term_str += ' ';
+	    }
+	    if (!term_str.equals("is there")) {
+		System.err.println("Unexpected term_str");
+		System.exit(1);
+	    }
+	    boolean ok = false;
+	    try {
+		Database db_fail = new Database("NOsuChdaTabASe");
+		// Ignore the return value.
+		db_fail.getDocCount();
+	    } catch (DatabaseOpeningError e) {
+		ok = true;
+	    }
+	    if (!ok) {
+		System.err.println("Managed to open non-existent database");
+		System.exit(1);
+	    }
+
+	    if (Query.OP_ELITE_SET != 10) {
+		System.err.println("OP_ELITE_SET is " + Query.OP_ELITE_SET + " not 10");
+		System.exit(1);
+	    }
+
+	    RSet rset = new RSet();
+	    rset.addDocument(1);
+	    ESet eset = enq.getESet(10, rset, new MyExpandDecider());
+	    ESetIterator eit = eset.iterator();
+	    int count = 0;
+	    while (eit.hasNext()) {
+		if (eit.getTerm().substring(0, 1) == "a") {
+		    System.err.println("MyExpandDecider wasn't used");
+		    System.exit(1);
+		}
+		++count;
+		eit.next();
+	    }
+	    if (count != eset.size()) {
+		System.err.println("ESet.size() mismatched number of terms returned by ESetIterator");
+		System.exit(1);
+	    }
+
+	    MSet mset2 = enq.getMSet(0, 10, null, new MyMatchDecider());
+	    if (mset2.size() > 0) {
+		System.err.println("MyMatchDecider wasn't used");
+		System.exit(1);
+	    }
+
+	    if (!enq.getQuery().toString().equals("Xapian::Query((there OR is))")) {
+		System.err.println("Enquire::getQuery() returned the wrong query: " + enq.getQuery().toString());
+		System.exit(1);
+	    }
+	} catch (Exception e) {
+	    System.err.println("Caught unexpected exception " + e.toString());
+	    System.exit(1);
+	}
+    }
+}

data/java/native/.deps/Database.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/Document.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/ESet.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/ESetIterator.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/Enquire.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/MSet.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/MSetIterator.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/PositionIterator.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/Query.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/RSet.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/Stem.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/TermIterator.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/WritableDatabase.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/org_xapian_XapianJNI.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/.deps/utils.Plo

@@ -0,0 +1 @@
+# dummy

data/java/native/Database.cc

@@ -0,0 +1,222 @@
+/**
+ Copyright (c) 2003, Technology Concepts & Design, Inc.
+ Copyright (c) 2008, Olly Betts
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modification, are permitted
+ provided that the following conditions are met:
+
+ - Redistributions of source code must retain the above copyright notice, this list of conditions
+ and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+ and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+ - Neither the name of Technology Concepts & Design, Inc. nor the names of its contributors may be used to
+ endorse or promote products derived from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ THE POSSIBILITY OF SUCH DAMAGE.
+ **/
+ 
+#include "xapian_jni.h"
+
+using namespace std;
+using namespace Xapian;
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1new__ (JNIEnv *env, jclass clazz) {
+    TRY
+        Database *db = new Database();
+        return _database->put(db);
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1new__Ljava_lang_String_2 (JNIEnv *env, jclass clazz, jstring path) {
+    TRY
+        const char *c_path = env->GetStringUTFChars(path, 0);
+	string cpp_path(c_path, env->GetStringUTFLength(path));
+        Database *db = new Database(cpp_path);
+        env->ReleaseStringUTFChars(path, c_path);
+        return _database->put(db);
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1new__J (JNIEnv *env, jclass clazz, jlong dbid) {
+   TRY
+        Database *db = (Database *) _database->get(dbid);
+        Database *new_db = new Database(*db);
+        return _database->put(new_db);
+    CATCH(-1)
+}
+
+JNIEXPORT void JNICALL Java_org_xapian_XapianJNI_database_1add_1database (JNIEnv *env, jclass clazz, jlong dbid, jlong dbid_other) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        Database *other_db = (Database *) _database->get(dbid_other);
+        db->add_database(*other_db);
+    CATCH(;)
+}
+
+JNIEXPORT void JNICALL Java_org_xapian_XapianJNI_database_1reopen (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        db->reopen();
+    CATCH(;)
+}
+
+JNIEXPORT jstring JNICALL Java_org_xapian_XapianJNI_database_1get_1description (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        return env->NewStringUTF(db->get_description().c_str());
+    CATCH(NULL)
+}
+
+//
+// TODO:  These have not been implemented yet!
+//
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1postlist_1begin (JNIEnv *env, jclass clazz, jlong dbid, jstring) {
+    TRY
+        throw "Database::postlist_begin() not (yet) supported by XapianJNI";
+    CATCH(-1)
+}
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1postlist_1end (JNIEnv *env, jclass clazz, jlong dbid, jstring) {
+    TRY
+        throw "Database::postlist_end() not (yet) supported by XapianJNI";
+    CATCH(-1)
+}
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1termlist_1begin (JNIEnv *env, jclass clazz, jlong dbid, jlong) {
+    TRY
+        throw "Database::termlist_begin() not (yet) supported by XapianJNI";
+    CATCH(-1)
+}
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1termlist_1end (JNIEnv *env, jclass clazz, jlong dbid, jlong) {
+    TRY
+        throw "Database::termlist_end() not (yet) supported by XapianJNI";
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1positionlist_1begin (JNIEnv *env, jclass clazz, jlong dbid, jlong dbdocid, jstring term) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        const char *c_term = env->GetStringUTFChars(term, 0);
+	string cpp_term(c_term, env->GetStringUTFLength(term));
+        PositionIterator *itr;
+        itr = new PositionIterator(db->positionlist_begin(dbdocid, cpp_term));
+        env->ReleaseStringUTFChars(term, c_term);
+        return _positioniterator->put(itr);
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1positionlist_1end (JNIEnv *env, jclass clazz, jlong dbid, jlong dbdocid, jstring term) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        const char *c_term = env->GetStringUTFChars(term, 0);
+	string cpp_term(c_term, env->GetStringUTFLength(term));
+        PositionIterator *itr = new PositionIterator (db->positionlist_end(dbdocid, cpp_term));
+        env->ReleaseStringUTFChars(term, c_term);
+        return _positioniterator->put(itr);
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1allterms_1begin (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        TermIterator *itr = new TermIterator(db->allterms_begin());
+        return _termiterator->put(itr);
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1allterms_1end (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        TermIterator *itr = new TermIterator(db->allterms_end());
+        return _termiterator->put(itr);
+    CATCH(-1)
+}
+
+JNIEXPORT jint JNICALL Java_org_xapian_XapianJNI_database_1get_1doccount (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        return db->get_doccount();
+    CATCH(-1)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1get_1lastdocid (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        return db->get_lastdocid();
+    CATCH(-1)
+}
+
+JNIEXPORT jdouble JNICALL Java_org_xapian_XapianJNI_database_1get_1avlength (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        return db->get_avlength();
+    CATCH(-1)
+}
+
+JNIEXPORT jint JNICALL Java_org_xapian_XapianJNI_database_1get_1termfreq (JNIEnv *env, jclass clazz, jlong dbid, jstring term) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        const char *c_term = env->GetStringUTFChars(term, 0);
+	string cpp_term(c_term, env->GetStringUTFLength(term));
+        int freq = db->get_termfreq(cpp_term);
+        env->ReleaseStringUTFChars(term, c_term);
+        return freq;
+    CATCH(-1)
+}
+
+JNIEXPORT jboolean JNICALL Java_org_xapian_XapianJNI_database_1term_1exists (JNIEnv *env, jclass clazz, jlong dbid, jstring term) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        const char *c_term = env->GetStringUTFChars(term, 0);
+	string cpp_term(c_term, env->GetStringUTFLength(term));
+        bool exists = db->term_exists(cpp_term);
+        env->ReleaseStringUTFChars(term, c_term);
+        return exists;
+    CATCH(0)
+}
+
+JNIEXPORT jint JNICALL Java_org_xapian_XapianJNI_database_1get_1collection_1freq (JNIEnv *env, jclass clazz, jlong dbid, jstring term) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        const char *c_term = env->GetStringUTFChars(term, 0);
+	string cpp_term(c_term, env->GetStringUTFLength(term));
+        int freq = db->get_collection_freq(cpp_term);
+        env->ReleaseStringUTFChars(term, c_term);
+        return freq;
+    CATCH(-1)
+}
+
+JNIEXPORT jdouble JNICALL Java_org_xapian_XapianJNI_database_1get_1doclength (JNIEnv *env, jclass clazz, jlong dbid, jlong docid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        return db->get_doclength(docid);
+    CATCH(-1)
+}
+
+JNIEXPORT void JNICALL Java_org_xapian_XapianJNI_database_1keep_1alive (JNIEnv *env, jclass clazz, jlong dbid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        db->keep_alive();
+    CATCH(;)
+}
+
+JNIEXPORT jlong JNICALL Java_org_xapian_XapianJNI_database_1get_1document (JNIEnv *env, jclass clazz, jlong dbid, jlong docid) {
+    TRY
+        Database *db = (Database *) _database->get(dbid);
+        Document *doc = new Document(db->get_document(docid));
+        return _document->put(doc);
+    CATCH(-1)
+}
+
+JNIEXPORT void JNICALL Java_org_xapian_XapianJNI_database_1finalize (JNIEnv *env, jclass clazz, jlong dbid) {
+    Database *db = (Database *) _database->remove(dbid);
+    if (db) delete db;
+}