com.bigdata.search
Class Hiterator<A extends IHit>

java.lang.Object
  com.bigdata.search.Hiterator<A>

All Implemented Interfaces:

Iterator<A>

public class Hiterator<A extends IHit>
extends Object
implements Iterator<A>

Visits search results in order of decreasing relevance.

Version:

$Id: Hiterator.java 4706 2011-06-14 13:24:50Z thompsonbry $

Author:

Bryan Thompson

Constructor Summary

Hiterator(Collection<A> hits)

Method Summary

boolean	hasNext()
A	next()
int	rank() The rank of the last hit returned (origin ONE).
void	remove()
long	size() The #of hits (approximate).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Hiterator

public Hiterator(Collection<A> hits)

Parameters:

hits -

Method Detail

size

public long size()

The #of hits (approximate).

TODO:

differentiate between the #of hits and the #of hits that satisfy the minCosine and maxRank criteria, this and other search engine metadata (elapsed time) might go on a different object from which we can obtain the Hiterator.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<A extends IHit>

next

public A next()

Specified by:

next in interface Iterator<A extends IHit>

rank

public int rank()

The rank of the last hit returned (origin ONE).

Throws:

IllegalStateException - if nothing has been visited yet.

remove

public void remove()

Specified by:

remove in interface Iterator<A extends IHit>

Throws:

UnsupportedOperationException

toString

public String toString()

Overrides:

toString in class Object