org.elasticsearch.search.facet
Class AbstractFacetCollector

java.lang.Object
  org.apache.lucene.search.Collector
      org.elasticsearch.search.facet.FacetCollector
          org.elasticsearch.search.facet.AbstractFacetCollector

Direct Known Subclasses:

BoundedCountHistogramFacetCollector, BoundedValueHistogramFacetCollector, BoundedValueScriptHistogramFacetCollector, CountDateHistogramFacetCollector, CountHistogramFacetCollector, FieldsTermsStringFacetCollector, FilterFacetCollector, FullHistogramFacetCollector, GeoDistanceFacetCollector, IndexNameFacetCollector, KeyValueRangeFacetCollector, QueryFacetCollector, RangeFacetCollector, ScriptHistogramFacetCollector, ScriptRangeFacetCollector, ScriptStatisticalFacetCollector, ScriptTermsStringFieldFacetCollector, StatisticalFacetCollector, StatisticalFieldsFacetCollector, TermsByteFacetCollector, TermsByteOrdinalsFacetCollector, TermsDoubleFacetCollector, TermsDoubleOrdinalsFacetCollector, TermsFloatFacetCollector, TermsFloatOrdinalsFacetCollector, TermsIntFacetCollector, TermsIntOrdinalsFacetCollector, TermsIpFacetCollector, TermsIpOrdinalsFacetCollector, TermsLongFacetCollector, TermsLongOrdinalsFacetCollector, TermsShortFacetCollector, TermsShortOrdinalsFacetCollector, TermsStatsDoubleFacetCollector, TermsStatsLongFacetCollector, TermsStatsStringFacetCollector, TermsStringFacetCollector, TermsStringOrdinalsFacetCollector, ValueDateHistogramFacetCollector, ValueHistogramFacetCollector, ValueScriptDateHistogramFacetCollector, ValueScriptHistogramFacetCollector

public abstract class AbstractFacetCollector
extends FacetCollector

Field Summary

protected String	facetName
protected org.apache.lucene.search.Filter	filter

Constructor Summary

AbstractFacetCollector(String facetName)

Method Summary

boolean	acceptsDocsOutOfOrder()
void	collect(int doc)
protected abstract void	doCollect(int doc)
protected abstract void	doSetNextReader(org.apache.lucene.index.IndexReader reader, int docBase)
org.apache.lucene.search.Filter	getAndClearFilter()
org.apache.lucene.search.Filter	getFilter()
void	setFilter(org.apache.lucene.search.Filter filter)
void	setNextReader(org.apache.lucene.index.IndexReader reader, int docBase)
void	setScorer(org.apache.lucene.search.Scorer scorer)

Methods inherited from class org.elasticsearch.search.facet.FacetCollector

facet

Methods inherited from class java.lang.Object

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

Field Detail

facetName

protected final String facetName

filter

protected org.apache.lucene.search.Filter filter

Constructor Detail

AbstractFacetCollector

public AbstractFacetCollector(String facetName)

Method Detail

getFilter

public org.apache.lucene.search.Filter getFilter()

getAndClearFilter

public org.apache.lucene.search.Filter getAndClearFilter()

setFilter

public void setFilter(org.apache.lucene.search.Filter filter)

Specified by:

setFilter in class FacetCollector

setScorer

public void setScorer(org.apache.lucene.search.Scorer scorer)
               throws IOException

Specified by:

setScorer in class org.apache.lucene.search.Collector

Throws:

IOException

acceptsDocsOutOfOrder

public boolean acceptsDocsOutOfOrder()

Specified by:

acceptsDocsOutOfOrder in class org.apache.lucene.search.Collector

setNextReader

public void setNextReader(org.apache.lucene.index.IndexReader reader,
                          int docBase)
                   throws IOException

Specified by:

setNextReader in class org.apache.lucene.search.Collector

Throws:

IOException

doSetNextReader

protected abstract void doSetNextReader(org.apache.lucene.index.IndexReader reader,
                                        int docBase)
                                 throws IOException

Throws:

IOException

collect

public void collect(int doc)
             throws IOException

Specified by:

collect in class org.apache.lucene.search.Collector

Throws:

IOException

doCollect

protected abstract void doCollect(int doc)
                           throws IOException

Throws:

IOException