com.transaxtions.search.rankingalgorithm
Class RankingQuery

java.lang.Object
  com.transaxtions.search.rankingalgorithm.RankingQuery

Deprecated.

public class RankingQuery
extends java.lang.Object

The RankingAlgorithm implementation. Uses Lucene to get documents from the index but scores and ranks using the RankingAlgorithm. RankingAlgorithm can be used in two modes, Document mode (default) and Product mode. The scoring changes with the mode. In Document mode, documents are matched for relevancy while in Product mode, documents are matched for term occurence. Document mode is useful for matching text, html, rich text pdf/word, books, faq, forums discussions, etc. Product mode useful for small text as in Retail Product matches, etc. Product mode also has scan speed to fast/medium/full scan. Full scan is the most accurate but also a little slow. Needs the Lucene indexPath or IndexSearcher or IndexReader at instantiation or at search time. Uses the IndexReader to read the documents from the Index.

 Example:
 		RankingQuery rq = new RankingQuery(); 
 		IndexSearcher is = new IndexSearcher(index);
 		StandardAnalyzer analyzer = new StandardAnalyzer();
		QueryParser parser = new QueryParser(field, analyzer);
		Query query = parser.parse(searchterms);
 		RankingHits rh = rq.search(query, is); //is = Lucene IndexSearcher object
		System.out.println("num hits=" + rh.getNumHits() + "--no docs=" + is.maxDoc()); 
		for (int i=0; i<rh.getNumHits() && i<10; i++) {
			System.out.println("i=" + i + "--" + rh.score(i) + "--docid=" + rh.docid(i) + "--doc=" + rh.doc(i).get(title) );
		}
  
 

Author:

Nagendra Nagarajayya

See Also:

RankingQuery, RankingHits, RankingScore

Field Summary

static int	ALGORITHM_COMPLEX Deprecated.
static int	ALGORITHM_SIMPLE Deprecated.
static int	AND Deprecated.
static int	AND_OR Deprecated.
static int	DOCUMENT_MODE Deprecated.
static int	FOLD_FACTOR Deprecated.
static int	NUM_THREADS Deprecated.
static int	OR Deprecated.
static int	PRODUCT_MODE Deprecated.
static int	SCAN_FAST Deprecated.
static int	SCAN_FULL Deprecated.
static int	SCAN_MEDIUM Deprecated.

Constructor Summary

RankingQuery()
Deprecated.

RankingQuery(org.apache.lucene.index.IndexReader reader)
Deprecated. Constructor to create a RankingQuery object.

RankingQuery(org.apache.lucene.search.IndexSearcher is)
Deprecated. Constructor to create a RankingQuery object.

RankingQuery(java.lang.String indexPath)
Deprecated. Constructor to create a RankingQuery object.

Method Summary

void	addToLowerBoostSet(java.lang.String keywords) Deprecated. Experimental, can change
void	close() Deprecated. Closes the IndexReader objects opened.
org.apache.lucene.document.Document	doc(int docid) Deprecated. Similar to IndexSearcher doc(id), returns a Lucene Document object
int	getAndOr() Deprecated.
int	getMode() Deprecated.
int	getScan() Deprecated.
RankingHits	search(org.apache.lucene.search.Query query) Deprecated. Similar to Lucene search.
RankingHits	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.index.IndexReader ir, org.apache.lucene.search.Collector collector) Deprecated. Similar to Lucene search.
RankingHits	search(org.apache.lucene.search.Query query, org.apache.lucene.index.IndexReader r) Deprecated. Similar to Lucene search.
RankingHits	search(org.apache.lucene.search.Query query, org.apache.lucene.search.IndexSearcher is) Deprecated. Similar to Lucene search.
RankingHits	search(java.lang.String field, java.lang.String searchTerms) Deprecated. Similar to Lucene search.
int	search(org.apache.lucene.search.Weight weight, org.apache.lucene.search.Filter filter, org.apache.lucene.index.IndexReader[] ir, org.apache.lucene.search.Collector collector, int[] docstart) Deprecated.
RankingHits	search(org.apache.lucene.search.Weight weight, org.apache.lucene.search.Filter filter, org.apache.lucene.index.IndexReader ir, org.apache.lucene.search.Collector collector) Deprecated.
void	setAndOr(int type) Deprecated. Set And Or or AndOr combinations to get at the results.
void	setMode(int type) Deprecated. Set mode, Document or Product mode.
void	setScan(boolean fast) Deprecated. Used in Product mode.
void	setScan(int full) Deprecated. Used in Product mode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALGORITHM_COMPLEX

public static final int ALGORITHM_COMPLEX

Deprecated.

See Also:

Constant Field Values

ALGORITHM_SIMPLE

public static final int ALGORITHM_SIMPLE

Deprecated.

See Also:

Constant Field Values

PRODUCT_MODE

public static final int PRODUCT_MODE

Deprecated.

See Also:

Constant Field Values

DOCUMENT_MODE

public static final int DOCUMENT_MODE

Deprecated.

See Also:

Constant Field Values

SCAN_FAST

public static final int SCAN_FAST

Deprecated.

See Also:

Constant Field Values

SCAN_MEDIUM

public static final int SCAN_MEDIUM

Deprecated.

See Also:

Constant Field Values

SCAN_FULL

public static final int SCAN_FULL

Deprecated.

See Also:

Constant Field Values

AND_OR

public static final int AND_OR

Deprecated.

See Also:

Constant Field Values

AND

public static final int AND

Deprecated.

See Also:

Constant Field Values

OR

public static final int OR

Deprecated.

See Also:

Constant Field Values

NUM_THREADS

public static final int NUM_THREADS

Deprecated.

See Also:

Constant Field Values

FOLD_FACTOR

public static final int FOLD_FACTOR

Deprecated.

See Also:

Constant Field Values

Constructor Detail

RankingQuery

public RankingQuery(org.apache.lucene.index.IndexReader reader)

Deprecated.

Constructor to create a RankingQuery object.

Parameters:

reader - Lucene InndexReader object.

RankingQuery

public RankingQuery(org.apache.lucene.search.IndexSearcher is)

Deprecated.

Constructor to create a RankingQuery object.

Parameters:

is - Lucene IndexSearcher object.

RankingQuery

public RankingQuery(java.lang.String indexPath)
             throws java.lang.Throwable

Deprecated.

Constructor to create a RankingQuery object. An Lucene IndexReader object is created to read the index in the indexPath.

Parameters:

indexPath - to a Lucene index.

Throws:

java.lang.Throwable

RankingQuery

public RankingQuery()

Deprecated.

Method Detail

setScan

public void setScan(boolean fast)

Deprecated.

Used in Product mode. Set scan speed, FAST/FULL.

Parameters:

fast - true for FAST.

setScan

public void setScan(int full)

Deprecated.

Used in Product mode. Set scan speed, FAST/MEDIUM/FULL. Default is FAST.

Parameters:

full - Valid values are RankingQuery.FAST, RankingQuery.MEDIUM, RankingQuery.FULL

getScan

public int getScan()

Deprecated.

setMode

public void setMode(int type)

Deprecated.

Set mode, Document or Product mode. Default is Document mode.

Parameters:

type - Valid values are RankingQuery.DOCUMENT_MODE or RankingQuery.PRODUCT_MODE

getMode

public int getMode()

Deprecated.

setAndOr

public void setAndOr(int type)

Deprecated.

Set And Or or AndOr combinations to get at the results. AND is 100%, OR is 0%, AND_OR is 50% relevancy. Similar to mm parameter in Solr. Default is AndOr

Parameters:

type - Valid values are RankingQuery.AND or RankingQuery.AND_OR or RankingQuery.OR. One can also set this to any value between 0 and 100 as needed.

getAndOr

public int getAndOr()

Deprecated.

close

public void close()
           throws java.lang.Throwable

Deprecated.

Closes the IndexReader objects opened. Note: 1. IndexReader object is closed only if the constructor RankingQuery(indexpath) is used. If the IndexSearcher or IndexReader is passed explicitly as in RankingQuery(IndexSearcher is) or RankingQuery(IndexReader ir) it is not closed. 2. Make sure close is called the last since RankingHits has a reference to an IndexReader that will also get closed in IndexReader is closed. See SimpleExample.java for usage.

Throws:

java.lang.Throwable

See Also:

RankingQuery(String), SimpleExample

doc

public org.apache.lucene.document.Document doc(int docid)
                                        throws java.lang.Throwable

Deprecated.

Similar to IndexSearcher doc(id), returns a Lucene Document object

Parameters:

docid - Lucene document id

Returns:

Document object

Throws:

java.lang.Throwable

search

public RankingHits search(org.apache.lucene.search.Query query)
                   throws java.lang.Throwable

Deprecated.

Similar to Lucene search. RankingQuery needs to have been instantiated with Lucene IndexReader or IndexSearcher objects. Uses the IndexReader object to access the Lucene index.

Parameters:

query - A Lucene query object

Returns:

A list of hits matching the search terms

Throws:

java.lang.Throwable

See Also:

RankingHits

search

public RankingHits search(java.lang.String field,
                          java.lang.String searchTerms)
                   throws java.lang.Throwable

Deprecated.

Similar to Lucene search. RankingQuery needs to have been instantiated with a path to a Lucene index. *

 Example:
 		RankingQuery rq = new RankingQuery("/lucene/index/perl"); 
 		RankingHits rh = rq.search("search terms", "text"); 
		System.out.println("num hits=" + rh.getNumHits() + "--no docs=" + is.maxDoc()); 
		for (int i=0; i<rh.getNumHits() && i<10; i++) {
			System.out.println("i=" + i + "--" + rh.score(i) + "--docid=" + rh.docid(i) + "--doc=" + rh.doc(i).get(title) );
		}
  
 

Parameters:

field - to search

searchTerms - search terms

Returns:

RankingHits object, a list of documents matching the search terms

Throws:

java.lang.Throwable

See Also:

RankingHits

search

public RankingHits search(org.apache.lucene.search.Query query,
                          org.apache.lucene.search.IndexSearcher is)
                   throws java.lang.Throwable

Deprecated.

Similar to Lucene search. Uses the Lucene Query object to get at the terms of the search. Uses the IndexSearcher to access to the IndexReader object to access the Lucene index.

 Example:
 		RankingQuery rq = new RankingQuery(); 
 		RankingHits rh = rq.search(query, is); //is = Lucene IndexSearcher object
		System.out.println("num hits=" + rh.getNumHits() + "--no docs=" + is.maxDoc()); 
		for (int i=0; i<rh.getNumHits() && i<10; i++) {
			System.out.println("i=" + i + "--" + rh.score(i) + "--docid=" + rh.docid(i) + "--doc=" + rh.doc(i).get(title) );
		}
  
 

Parameters:

query - Lucene query object

is - Lucene IndexSearcher object

Returns:

RankingHits object, a list of documents matching the search terms

Throws:

java.lang.Throwable

See Also:

RankingHits

search

public RankingHits search(org.apache.lucene.search.Query query,
                          org.apache.lucene.index.IndexReader r)
                   throws java.lang.Throwable

Deprecated.

Similar to Lucene search. Uses the Lucene Query object to get at the terms of the search. Uses the IndexReader to access the Lucene index.

 Example:
 		RankingQuery rq = new RankingQuery(); 
 		RankingHits rh = rq.search(query, is); //is = Lucene IndexSearcher object
		System.out.println("num hits=" + rh.getNumHits() + "--no docs=" + is.maxDoc()); 
		for (int i=0; i<rh.getNumHits() && i<10; i++) {
			System.out.println("i=" + i + "--" + rh.score(i) + "--docid=" + rh.docid(i) + "--doc=" + rh.doc(i).get(title) );
		}
  
 

Parameters:

query - Lucene query object

r - Lucene IndexSearcher object

Returns:

RankingHits object, a list of documents matching the search terms

Throws:

java.lang.Throwable

See Also:

RankingHits

search

public RankingHits search(org.apache.lucene.search.Query query,
                          org.apache.lucene.search.Filter filter,
                          org.apache.lucene.index.IndexReader ir,
                          org.apache.lucene.search.Collector collector)
                   throws java.lang.Throwable

Deprecated.

Similar to Lucene search. Uses the Lucene Query object to get at the terms of the search. Uses the IndexReader to access the Lucene index. IndexReader needs to be passed for NRT searches.

 Example:
 		RankingQuery rq = new RankingQuery(); 
 		RankingHits rh = rq.search(query, filter, ir, collector); //is = Lucene IndexSearcher object
		System.out.println("num hits=" + rh.getNumHits() + "--no docs=" + is.maxDoc()); 
		for (int i=0; i<rh.getNumHits() && i<10; i++) {
			System.out.println("i=" + i + "--" + rh.score(i) + "--docid=" + rh.docid(i) + "--doc=" + rh.doc(i).get(title) );
		}
  
 

Parameters:

query - Lucene query object

filter - Lucene Filter object

ir - Lucene IndexReader object

collector - Lucene collector object

Returns:

RankingHits object, a list of documents matching the search terms

Throws:

java.lang.Throwable

See Also:

RankingHits

search

public int search(org.apache.lucene.search.Weight weight,
                  org.apache.lucene.search.Filter filter,
                  org.apache.lucene.index.IndexReader[] ir,
                  org.apache.lucene.search.Collector collector,
                  int[] docstart)
           throws java.lang.Throwable

Deprecated.

Throws:

java.lang.Throwable

search

public RankingHits search(org.apache.lucene.search.Weight weight,
                          org.apache.lucene.search.Filter filter,
                          org.apache.lucene.index.IndexReader ir,
                          org.apache.lucene.search.Collector collector)
                   throws java.lang.Throwable

Deprecated.

Throws:

java.lang.Throwable

addToLowerBoostSet

public void addToLowerBoostSet(java.lang.String keywords)

Deprecated.

Experimental, can change