org.egothor.query

Class QProx

java.lang.Object

org.egothor.core.query.Query

org.egothor.query.QProx

public class QProx
extends Query

The QProx object represents an digit operator in a query. The user has made a query for documents containing termA within x words of termB.

Author:

Leo Galambos

Field Summary

Fields inherited from class org.egothor.core.query.Query

MODEL_BOOLEAN, MODEL_FUZZY_M, MODEL_VECTOR

Constructor Summary

Constructors

Constructor and Description
QProx(QTerm a, QTerm b) Constructor for the QProx object.
QProx(QTerm a, QTerm b, String num) Constructor for the QProx object.

Method Summary

Modifier and Type	Method and Description
void	addTerms(HashSet<Token> to) Adds all terms in this query into the given HashSet.
Query	applyCWI(CWI cwi) Return a QProx object with the given CWI applied to both sides of the query.
Runner	attach(Rider r) Return an ProxRunner which is the binary representation of this clausula.
Node	explain(Document doc) Description of the Method
String	getNodeName() Gets the nodeName attribute of the QProx object
boolean	isContradictory() By default, queries are contradictory, if they are excluded but required at the same time.
void	setModel(int model) Sets the model attribute of the QProx object
void	setProhibited() Sets the prohibited attribute of the QProx object
void	setRequired() Sets the required attribute of the QProx object
String	toString() Return a string representation of this object.

Methods inherited from class org.egothor.core.query.Query

getExcluded, getModel, getProhibited, getRequired, getUnknown, isRequiredOrProhibited, setExcluded, setUnknown

Methods inherited from class java.lang.Object

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

Constructor Detail

QProx

public QProx(QTerm a,
             QTerm b,
             String num)

Constructor for the QProx object.

Parameters:

a - the first query

b - the second query

num - the allowable distance between a and b

QProx

public QProx(QTerm a,
             QTerm b)

Constructor for the QProx object.

Parameters:

a - the first query

b - the second query

Method Detail

isContradictory

public boolean isContradictory()

Description copied from class: Query

By default, queries are contradictory, if they are excluded but required at the same time.

Overrides:

isContradictory in class Query

Returns:

the query would not generate a hit at all

setModel

public void setModel(int model)

Sets the model attribute of the QProx object

Overrides:

setModel in class Query

Parameters:

model - The new model value

setProhibited

public void setProhibited()

Sets the prohibited attribute of the QProx object

Overrides:

setProhibited in class Query

setRequired

public void setRequired()

Sets the required attribute of the QProx object

Overrides:

setRequired in class Query

getNodeName

public String getNodeName()

Gets the nodeName attribute of the QProx object

Specified by:

getNodeName in class Query

Returns:

The nodeName value

explain

public Node explain(Document doc)

Description of the Method

Overrides:

explain in class Query

Parameters:

doc - Description of the Parameter

Returns:

Description of the Return Value

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Returns:

queryA ~the desired distance~ queryB

attach

public Runner attach(Rider r)

Return an ProxRunner which is the binary representation of this clausula.

Overrides:

attach in class Query

Parameters:

r - the Rider

Returns:

an AndRunner

addTerms

public void addTerms(HashSet<Token> to)

Description copied from class: Query

Adds all terms in this query into the given HashSet.

Overrides:

addTerms in class Query

Parameters:

to - the HashSet collector of terms

applyCWI

public Query applyCWI(CWI cwi)

Return a QProx object with the given CWI applied to both sides of the query.

Overrides:

applyCWI in class Query

Parameters:

cwi - the CWI

Returns:

a Query. When the CWI is null, it simply returns this object.