Package org.opensearch.search.profile.query

Class InternalProfileCollector

java.lang.Object

org.opensearch.search.profile.query.InternalProfileCollector

All Implemented Interfaces:

org.apache.lucene.search.Collector, InternalProfileComponent

public class InternalProfileCollector
extends Object
implements org.apache.lucene.search.Collector, InternalProfileComponent

This class wraps a Lucene Collector and times the execution of: - setScorer() - collect() - doSetNextReader() - needsScores() InternalProfiler facilitates the linking of the Collector graph

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
InternalProfileCollector(org.apache.lucene.search.Collector collector, String reason, List<? extends InternalProfileComponent> children)

Method Summary

Modifier and Type	Method	Description
Collection<? extends InternalProfileComponent>	children()
org.apache.lucene.search.Collector	getCollector()
CollectorResult	getCollectorTree()
org.apache.lucene.search.LeafCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext context)
String	getName()
String	getReason()
long	getTime()
org.apache.lucene.search.ScoreMode	scoreMode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Constructor Details

InternalProfileCollector

public InternalProfileCollector(org.apache.lucene.search.Collector collector,
 String reason,
 List<? extends InternalProfileComponent> children)

Method Details

getTime

public long getTime()

Specified by:

getTime in interface InternalProfileComponent

Returns:

the profiled time for this collector (inclusive of children)

getReason

public String getReason()

Specified by:

getReason in interface InternalProfileComponent

Returns:

a human readable "hint" about what this collector was used for

getName

public String getName()

Specified by:

getName in interface InternalProfileComponent

Returns:

the lucene class name of the collector

getCollector

public org.apache.lucene.search.Collector getCollector()

Returns:

the underlying collector instance being profiled

getLeafCollector

public org.apache.lucene.search.LeafCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext context)
                                                        throws IOException

Specified by:

getLeafCollector in interface org.apache.lucene.search.Collector

Throws:

IOException

scoreMode

public org.apache.lucene.search.ScoreMode scoreMode()

Specified by:

scoreMode in interface org.apache.lucene.search.Collector

children

public Collection<? extends InternalProfileComponent> children()

Specified by:

children in interface InternalProfileComponent

Returns:

the children of this profile component (if any)

getCollectorTree

public CollectorResult getCollectorTree()

Specified by:

getCollectorTree in interface InternalProfileComponent

Returns:

the profiling results for this profile component