org.apache.solr.search.facet

Class SlotAcc

java.lang.Object

org.apache.solr.search.facet.SlotAcc

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DocValuesAcc, UnInvertedFieldAcc, UniqueBlockAgg.UniqueBlockSlotAcc

public abstract class SlotAcc
extends Object
implements Closeable

Accumulates statistics separated by a slot number. There is a separate statistic per slot. The slot is usually an ordinal into a set of values, e.g. tracking a count frequency per term. Sometimes there doesn't need to be a slot distinction, in which case there is just one nominal slot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlotAcc.Resizer
static class	SlotAcc.SlotContext Incapsulates information about the current slot, for Accumulators that may want additional info during collection.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentDocBase
protected LeafReaderContext	currentReaderContext
protected org.apache.solr.search.facet.FacetContext	fcontext

Constructor Summary

Constructors

Constructor and Description
SlotAcc(org.apache.solr.search.facet.FacetContext fcontext)

Method Summary

Modifier and Type	Method and Description
void	close()
int	collect(DocSet docs, int slot, IntFunction<SlotAcc.SlotContext> slotContext) Bulk collection of all documents in a slot.
abstract void	collect(int doc, int slot, IntFunction<SlotAcc.SlotContext> slotContext) All subclasses must override this method to collect documents.
abstract int	compare(int slotA, int slotB)
abstract Object	getValue(int slotNum)
abstract void	reset() Called to reset the acc to a fresh state, ready for reuse
protected void	resetIterators() Typically called from setNextReader to reset docValue iterators
abstract void	resize(SlotAcc.Resizer resizer)
void	setNextReader(LeafReaderContext readerContext) NOTE: this currently detects when it is being reused and calls resetIterators by comparing reader ords with previous calls to setNextReader.
void	setValues(SimpleOrderedMap<Object> bucket, int slotNum)

Methods inherited from class java.lang.Object

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

Field Detail

fcontext

protected final org.apache.solr.search.facet.FacetContext fcontext

currentReaderContext

protected LeafReaderContext currentReaderContext

currentDocBase

protected int currentDocBase

Constructor Detail

SlotAcc

public SlotAcc(org.apache.solr.search.facet.FacetContext fcontext)

Method Detail

setNextReader

public void setNextReader(LeafReaderContext readerContext)
                   throws IOException

NOTE: this currently detects when it is being reused and calls resetIterators by comparing reader ords with previous calls to setNextReader. For this reason, current users must call setNextReader in segment order. Failure to do so will cause worse performance.

Throws:

IOException

collect

public abstract void collect(int doc,
                             int slot,
                             IntFunction<SlotAcc.SlotContext> slotContext)
                      throws IOException

All subclasses must override this method to collect documents. This method is called by the default impl of collect(DocSet,int,IntFunction) but it's also neccessary if this accumulator is used for sorting.

Parameters:

doc - Single Segment docId (relative to the current LeafReaderContext to collect

slot - The slot number to collect this document in

slotContext - A callback that can be used for Accumulators that would like additional info about the current slot -- the IntFunction is only garunteed to be valid for the current slot, and the SlotAcc.SlotContext returned is only valid for the duration of the collect() call.

Throws:

IOException

collect

public int collect(DocSet docs,
                   int slot,
                   IntFunction<SlotAcc.SlotContext> slotContext)
            throws IOException

Bulk collection of all documents in a slot. The default implementation calls collect(int,int,IntFunction)

Parameters:

docs - (global) Documents to collect

slot - The slot number to collect these documents in

slotContext - A callback that can be used for Accumulators that would like additional info about the current slot -- the IntFunction is only garunteed to be valid for the current slot, and the SlotAcc.SlotContext returned is only valid for the duration of the collect() call.

Throws:

IOException

compare

public abstract int compare(int slotA,
                            int slotB)

getValue

public abstract Object getValue(int slotNum)
                         throws IOException

Throws:

IOException

setValues

public void setValues(SimpleOrderedMap<Object> bucket,
                      int slotNum)
               throws IOException

Throws:

IOException

reset

public abstract void reset()
                    throws IOException

Called to reset the acc to a fresh state, ready for reuse

Throws:

IOException

resetIterators

protected void resetIterators()
                       throws IOException

Typically called from setNextReader to reset docValue iterators

Throws:

IOException

resize

public abstract void resize(SlotAcc.Resizer resizer)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException