org.egothor.query

Class QAnd

java.lang.Object

org.egothor.core.query.Query

org.egothor.query.QAnd

public class QAnd
extends Query

The QAnd object represents an AND operator in a query. The user has made a query for documents containing termA AND 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
QAnd(Query a, Query b) Constructor for the QAnd object.
QAnd(Query a, Query b, boolean req, boolean proh) Constructor for the QAnd 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 QAnd object with the given CWI applied to both sides of the query.
Runner	attach(Rider r) Return an AndRunner which is the binary representation of this clausula.
Node	explain(Document doc) Description of the Method
String	getNodeName() Gets the nodeName attribute of the QAnd 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 QAnd 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, setProhibited, setRequired, setUnknown

Methods inherited from class java.lang.Object

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

Constructor Detail

QAnd

public QAnd(Query a,
            Query b)

Constructor for the QAnd object. This object represents a && b clausula in a query.

Parameters:

a - the first query

b - the second query

QAnd

public QAnd(Query a,
            Query b,
            boolean req,
            boolean proh)

Constructor for the QAnd object.

Parameters:

a - the first query

b - the second query

req - set to true if the entire query (both items) are required for a hit

proh - set to true if the entire query (both items) should not be in a hit

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 QAnd object

Overrides:

setModel in class Query

Parameters:

model - The new model value

getNodeName

public String getNodeName()

Gets the nodeName attribute of the QAnd object

Specified by:

getNodeName in class Query

Returns:

The nodeName value

explain

public Node explain(Document doc)
             throws DOMException

Description of the Method

Overrides:

explain in class Query

Parameters:

doc - Description of the Parameter

Returns:

Description of the Return Value

Throws:

DOMException - Description of the Exception

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Returns:

queryA AND queryB

attach

public Runner attach(Rider r)

Return an AndRunner 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 QAnd 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.