org.egothor.core
Class IListWasher

java.lang.Object
  org.egothor.core.IListShadow
      org.egothor.core.IListWasher

All Implemented Interfaces:

IListItem, IListReader

public abstract class IListWasher
extends IListShadow

A IListWasher excludes some tuples from underlaying inverted list.

Author:

Leo Galambos

Constructor Summary

IListWasher()
Constructor for the IListWasher object

IListWasher(IListReader ilr)
Constructor for the IListWasher object

Method Summary

boolean	next() Go to the next element in the inverted list.
boolean	skipTo(long uid) Go to item related to the specified document (or any with a greater uid).
abstract boolean	valid(IListItem item) Test whether the specified tuple is OK.

Methods inherited from class org.egothor.core.IListShadow

close, getPostings, getTerm, openProx, setSource, uid, weight

Methods inherited from class java.lang.Object

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

Constructor Detail

IListWasher

public IListWasher()

Constructor for the IListWasher object

IListWasher

public IListWasher(IListReader ilr)

Constructor for the IListWasher object

Parameters:

ilr - Description of the Parameter

Method Detail

skipTo

public boolean skipTo(long uid)

Go to item related to the specified document (or any with a greater uid).

Specified by:

skipTo in interface IListReader

Overrides:

skipTo in class IListShadow

Parameters:

uid - the document to skip to

Returns:

the element exists?

next

public boolean next()

Go to the next element in the inverted list. If the list does not exist the method returns without executing.

Specified by:

next in interface IListReader

Overrides:

next in class IListShadow

Returns:

the next element exists?

valid

public abstract boolean valid(IListItem item)

Test whether the specified tuple is OK.

Parameters:

item - the tuple

Returns:

true if document has been removed, false otherwise