Module org.apache.lucene.sandbox

Package org.apache.lucene.sandbox.search

Class ProfilerCollectorResult

java.lang.Object

org.apache.lucene.sandbox.search.ProfilerCollectorResult

public class ProfilerCollectorResult
extends Object

Public class for profiled timings of the Collectors used in the search. Children CollectorResult's may be embedded inside of a parent CollectorResult

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ProfilerCollectorResult>	children	A list of children collectors "embedded" inside this collector
private final String	collectorName	A more friendly representation of the Collector's class name
private final String	reason	A "hint" to help provide some context about this Collector
private final long	time	The total elapsed time for this Collector

Constructor Summary

Constructors

Constructor	Description
ProfilerCollectorResult(String collectorName, String reason, Long time, List<ProfilerCollectorResult> children)

Method Summary

Modifier and Type	Method	Description
String	getName()
List<ProfilerCollectorResult>	getProfiledChildren()
String	getReason()
long	getTime()

Methods inherited from class java.lang.Object

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

Field Details

collectorName

private final String collectorName

A more friendly representation of the Collector's class name

reason

private final String reason

A "hint" to help provide some context about this Collector

time

private final long time

The total elapsed time for this Collector

children

private final List<ProfilerCollectorResult> children

A list of children collectors "embedded" inside this collector

Constructor Details

ProfilerCollectorResult

public ProfilerCollectorResult(String collectorName,
 String reason,
 Long time,
 List<ProfilerCollectorResult> children)

Method Details

getTime

public long getTime()

Returns:

the profiled time for this collector (inclusive of children)

getReason

public String getReason()

Returns:

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

getName

public String getName()

Returns:

the lucene class name of the collector

getProfiledChildren

public List<ProfilerCollectorResult> getProfiledChildren()

Returns:

a list of children collectors