org.apache.solr.analytics.function.reduction

Class DocCountFunction

java.lang.Object

org.apache.solr.analytics.value.LongValue.AbstractLongValue

org.apache.solr.analytics.function.reduction.DocCountFunction

All Implemented Interfaces:

ReductionFunction, AnalyticsValue, AnalyticsValueStream, ComparableValue, DoubleValue, DoubleValueStream, LongValue, LongValue.CastingLongValue, LongValueStream, StringValue, StringValueStream

public class DocCountFunction
extends LongValue.AbstractLongValue
implements ReductionFunction

A reduction function which either counts the number of Solr Documents for which the parameter expression exists, or the number of documents returned if no parameter is given.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.AnalyticsValue

AnalyticsValue.AbstractAnalyticsValue

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.AnalyticsValueStream

AnalyticsValueStream.ExpressionType

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.LongValue

LongValue.AbstractLongValue, LongValue.CastingLongValue

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.LongValueStream

LongValueStream.AbstractLongValueStream, LongValueStream.CastingLongValueStream

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.DoubleValue

DoubleValue.AbstractDoubleValue, DoubleValue.CastingDoubleValue

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.DoubleValueStream

DoubleValueStream.AbstractDoubleValueStream, DoubleValueStream.CastingDoubleValueStream

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.StringValue

StringValue.AbstractStringValue, StringValue.CastingStringValue

Nested classes/interfaces inherited from interface org.apache.solr.analytics.value.StringValueStream

StringValueStream.AbstractStringValueStream, StringValueStream.CastingStringValueStream

Field Summary

Fields

Modifier and Type	Field and Description
static ExpressionFactory.CreatorFunction	creatorFunction
static String	name

Constructor Summary

Constructors

Constructor and Description
DocCountFunction()
DocCountFunction(AnalyticsValueStream param)

Method Summary

Modifier and Type	Method and Description
boolean	exists() Check whether the current value exists.
String	getExpressionStr() Get the expression string of the analytics value stream.
AnalyticsValueStream.ExpressionType	getExpressionType() Get the type of the expression that this class represents.
long	getLong() Get the long representation of the current value.
String	getName() Get the name of function or value.
void	synchronizeDataCollectors(UnaryOperator<ReductionDataCollector<?>> sync) Syncs the data collectors with shared versions across the entire Analytics Request so that as little data as possible is sent across shards.

Methods inherited from class org.apache.solr.analytics.value.LongValue.AbstractLongValue

getDouble, getObject, getObjectComparator, getString, streamDoubles, streamLongs, streamObjects, streamStrings

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.analytics.value.AnalyticsValue

getObject

Methods inherited from interface org.apache.solr.analytics.value.AnalyticsValueStream

createExpressionString, determineMappingPhase, streamObjects

Field Detail

name

public static final String name

See Also:

Constant Field Values

creatorFunction

public static final ExpressionFactory.CreatorFunction creatorFunction

Constructor Detail

DocCountFunction

public DocCountFunction()

DocCountFunction

public DocCountFunction(AnalyticsValueStream param)

Method Detail

getLong

public long getLong()

Description copied from interface: LongValue

Get the long representation of the current value.

NOTE: The value returned is not valid unless calling AnalyticsValue.exists() afterwards returns TRUE.

Specified by:

getLong in interface LongValue

Returns:

the current value

exists

public boolean exists()

Description copied from interface: AnalyticsValue

Check whether the current value exists.
NOTE: The result of this method is only guaranteed after any get<Type>() method is called.

Specified by:

exists in interface AnalyticsValue

Returns:

whether the current value exists

synchronizeDataCollectors

public void synchronizeDataCollectors(UnaryOperator<ReductionDataCollector<?>> sync)

Description copied from interface: ReductionFunction

Syncs the data collectors with shared versions across the entire Analytics Request so that as little data as possible is sent across shards.

Specified by:

synchronizeDataCollectors in interface ReductionFunction

Parameters:

sync - a function that takes in a ReductionDataCollector and returns a shared version

getExpressionStr

public String getExpressionStr()

Description copied from interface: AnalyticsValueStream

Get the expression string of the analytics value stream. Must be unique to the expression. If passed to ExpressionFactory.createExpression(String), the exact same expression should be created.

Specified by:

getExpressionStr in interface AnalyticsValueStream

Returns:

the name of function/value

getName

public String getName()

Description copied from interface: AnalyticsValueStream

Get the name of function or value.

Specified by:

getName in interface AnalyticsValueStream

Returns:

the name of function/value

getExpressionType

public AnalyticsValueStream.ExpressionType getExpressionType()

Description copied from interface: AnalyticsValueStream

Get the type of the expression that this class represents.

Specified by:

getExpressionType in interface AnalyticsValueStream

Returns:

the expression type