org.egothor.query

Class QGroup

java.lang.Object

org.egothor.core.query.Query

org.egothor.query.QGroup

public class QGroup
extends Query

The QGroup object represents a group of clausulas.

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
QGroup() Constructor for the QGroup object.
QGroup(boolean required) Construct a QGroup with the given boolean value.

Method Summary

Modifier and Type	Method and Description
void	add(Query q) Add the given Query to the group.
void	addTerms(HashSet<Token> to) Adds all terms in this query into the given HashSet.
Query	applyCWI(CWI cwi) Apply the given CWI to this Query.
Runner	attach(Rider r) Return a binary form of this object for the given Rider.
Node	explain(Document doc) Description of the Method
String	getNodeName() Gets the nodeName attribute of the QGroup 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 QGroup 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

QGroup

public QGroup()

Constructor for the QGroup object.

QGroup

public QGroup(boolean required)

Construct a QGroup with the given boolean value. Setting required to true means that the query terms must be contained in any document returned as a hit.

Parameters:

required - Description of the Parameter

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

Overrides:

setModel in class Query

Parameters:

model - The new model value

getNodeName

public String getNodeName()

Gets the nodeName attribute of the QGroup 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

add

public void add(Query q)

Add the given Query to the group.

Parameters:

q - the query to add

toString

public String toString()

Return a String representation of this object.

Overrides:

toString in class Object

Returns:

a String

attach

public Runner attach(Rider r)

Return a binary form of this object for the given Rider.

Overrides:

attach in class Query

Parameters:

r - the Rider

Returns:

a Runner

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)

Apply the given CWI to this Query.

Overrides:

applyCWI in class Query

Parameters:

cwi - the desired CWI

Returns:

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