org.egothor.query.runner

Class OrRunner

java.lang.Object

org.egothor.core.query.Runner

org.egothor.query.runner.OrRunner

Direct Known Subclasses:

OrRunner

public class OrRunner
extends Runner

This object represents a binary form of a OR b formula. This Runner is used when a user wishes to query for documents containing one word or another. For example, the user might wish to query for documents containing BASS or GUITAR. The form of this query would be given as:

BASS||GUITAR.

Author:

Leo Galambos

Field Summary

Fields

Modifier and Type	Field and Description
Runner	a Description of the Field
Runner	b Description of the Field

Constructor Summary

Constructors

Constructor and Description
OrRunner(Runner a, Runner b) Constructor for the OrRunner object

Method Summary

Modifier and Type	Method and Description
int	evaluate(long uid) Return the calculated similarity.
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

equals, 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

OrRunner

public OrRunner(Runner a,
                Runner b)

Constructor for the OrRunner object

Parameters:

a - the Runner for the first query

b - the Runner for the second query

Method Detail

invalidReason

public String invalidReason()

Return an explanation as to why this search is invalid.

Specified by:

invalidReason in class Runner

Returns:

a String containing an explanation

terms

public int terms()

Description of the Method

Specified by:

terms in class Runner

Returns:

Description of the Return Value

evaluate

public int evaluate(long uid)

Return the calculated similarity. Returns 0 iff both arguments of formula returns non-positive similarities.

Specified by:

evaluate in class Runner

Parameters:

uid - the unique ID of the document to check

Returns:

the similarity