org.egothor.query.runner
Class AndRunner

java.lang.Object
  extended by org.egothor.core.query.Runner
      extended by org.egothor.query.runner.AndRunner
Direct Known Subclasses:
AndRunner

public class AndRunner
extends Runner

The AndRunner object represents a binary form of the boolean AND formula. For example, the user may wish to view documents containing the words BASS and GUITAR. The form of this query would be given as:

BASS&&GUITAR.

Author:
Leo Galambos

Field Summary
 Runner a
          Description of the Field
 Runner b
          Description of the Field
 
Constructor Summary
AndRunner(Runner a, Runner b)
          Constructor for the AndRunner object.
 
Method Summary
 int evaluate(long uid)
          Return the calculated similarity between this query and the document with the given unique ID.
 java.lang.String invalidReason()
          Return an explanation as to why this search is invalid.
 int terms()
          Description of the Method
 
Methods inherited from class org.egothor.core.query.Runner
run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

a

public Runner a
Description of the Field


b

public Runner b
Description of the Field

Constructor Detail

AndRunner

public AndRunner(Runner a,
                 Runner b)
Constructor for the AndRunner object.

Parameters:
a - the Runner for the first query
b - the Runner for the second query
Method Detail

terms

public int terms()
Description of the Method

Specified by:
terms in class Runner
Returns:
Description of the Return Value

invalidReason

public java.lang.String invalidReason()
Return an explanation as to why this search is invalid.

Specified by:
invalidReason in class Runner
Returns:
a String containing an explanation

evaluate

public int evaluate(long uid)
Return the calculated similarity between this query and the document with the given unique ID. When any of the formula variables returns a non-positive value, then the evaluation is 0.

Specified by:
evaluate in class Runner
Parameters:
uid - the unique id of the document
Returns:
0 if a variable is less than 0, or an integer resulting from the formula described in the code