com.browseengine.bobo.api
Class FacetIterator

java.lang.Object
  com.browseengine.bobo.api.FacetIterator

All Implemented Interfaces:

Iterator<Comparable>

Direct Known Subclasses:

CombinedFacetIterator, DefaultFacetIterator, DoubleFacetIterator, FloatFacetIterator, IntFacetIterator, LongFacetIterator, PathFacetIterator, ShortFacetIterator

public abstract class FacetIterator
extends Object
implements Iterator<Comparable>

Author:

nnarkhed

Field Summary

int	count
Comparable	facet

Constructor Summary

FacetIterator()

Method Summary

abstract String	format(Object val)
abstract Comparable	next() Moves the iteration to the next facet
abstract Comparable	next(int minHits) Moves the iteration to the next facet whose hitcount >= minHits. returns null if there is no facet whose hitcount >= minHits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

hasNext, remove

Field Detail

count

public int count

facet

public Comparable facet

Constructor Detail

FacetIterator

public FacetIterator()

Method Detail

next

public abstract Comparable next()

Moves the iteration to the next facet

Specified by:

next in interface Iterator<Comparable>

Returns:

the next facet value

next

public abstract Comparable next(int minHits)

Moves the iteration to the next facet whose hitcount >= minHits. returns null if there is no facet whose hitcount >= minHits. Hence while using this method, it is useless to use hasNext() with it. After the next() method returns null, calling it repeatedly would result in undefined behavior

Returns:

The next facet value. It returns null if there is no facet whose hitcount >= minHits.

format

public abstract String format(Object val)