Package ca.cgjennings.algo

Class TextIndex.Atom

java.lang.Object

ca.cgjennings.algo.TextIndex.Query

ca.cgjennings.algo.TextIndex.Atom

Enclosing class:

TextIndex

public static class TextIndex.Atom
extends TextIndex.Query

An atom is a query that matches all documents that contain a specified one-word search term.

Constructor Summary

Constructors

Constructor	Description
Atom(java.lang.String term)	Creates an atom that matches term.

Method Summary

Modifier and Type	Method	Description
TextIndex.Result	execute(TextIndex ti)	Returns the Result of performing this query against a specific text index.
TextIndex.Result	executeInverse(TextIndex ti)	Returns the inverse of the set of documents containing the search term.
java.lang.String	toString()

Methods inherited from class ca.cgjennings.algo.TextIndex.Query

evaluate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Atom

public Atom(java.lang.String term)

Creates an atom that matches term.

Parameters:

term - the word to match against the document set

Method Detail

execute

public TextIndex.Result execute(TextIndex ti)

Description copied from class: TextIndex.Query

Returns the Result of performing this query against a specific text index.

Specified by:

execute in class TextIndex.Query

Parameters:

ti - the text index to query

Returns:

a result that captures the set of matching documents

See Also:

TextIndex.Query.evaluate(ca.cgjennings.algo.TextIndex)

executeInverse

public TextIndex.Result executeInverse(TextIndex ti)

Returns the inverse of the set of documents containing the search term. This is equivalent to new Not( this ).execute( ti ).

Parameters:

ti - the text index to match against

Returns:

a result representing the documents that do not contain the search term

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object