org.apache.solr.analytics.function.field

Class FloatField

java.lang.Object

org.apache.solr.analytics.function.field.AnalyticsField

org.apache.solr.analytics.function.field.FloatField

All Implemented Interfaces:

AnalyticsValue, AnalyticsValueStream, ComparableValue, DoubleValue, DoubleValueStream, FloatValue, FloatValue.CastingFloatValue, FloatValueStream, StringValue, StringValueStream

public class FloatField
extends AnalyticsField
implements FloatValue.CastingFloatValue

An analytics wrapper for a single-valued TrieFloatField or FloatPointField with DocValues enabled.

Nested Class Summary

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

FloatValue.AbstractFloatValue, FloatValue.CastingFloatValue

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

FloatValueStream.AbstractFloatValueStream, FloatValueStream.CastingFloatValueStream

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

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.AbstractAnalyticsValueStream, AnalyticsValueStream.ExpressionType

Field Summary

Fields inherited from class org.apache.solr.analytics.function.field.AnalyticsField

fieldName, initialArrayLength

Constructor Summary

Constructors

Constructor and Description
FloatField(String fieldName)

Method Summary

Modifier and Type	Method and Description
void	collect(int doc) Collect the value(s) of the wrapped field for the given document, and store the value.
void	doSetNextReader(LeafReaderContext context) Set the segment reader context
boolean	exists() Check whether the current value exists.
double	getDouble() Get the double representation of the current value.
float	getFloat() Get the float representation of the current value.
Object	getObject() Get the object representation of the current value.
ExpressionComparator<Float>	getObjectComparator(String expression) Create an entry comparator used to sort the facet-value buckets of a facet.
String	getString() Get the String representation of the current value.
void	streamDoubles(DoubleConsumer cons) Stream the double representations of all current values, if any exist.
void	streamFloats(FloatConsumer cons) Stream the float representations of all current values, if any exist.
void	streamObjects(Consumer<Object> cons) Stream the object representations of all current values, if any exist.
void	streamStrings(Consumer<String> cons) Stream the String representations of all current values, if any exist.

Methods inherited from class org.apache.solr.analytics.function.field.AnalyticsField

convertToConstant, getExpressionStr, getExpressionType, getName

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.AnalyticsValueStream

convertToConstant, createExpressionString, determineMappingPhase, getExpressionStr, getExpressionType, getName

Constructor Detail

FloatField

public FloatField(String fieldName)

Method Detail

doSetNextReader

public void doSetNextReader(LeafReaderContext context)
                     throws IOException

Description copied from class: AnalyticsField

Set the segment reader context

Specified by:

doSetNextReader in class AnalyticsField

Parameters:

context - segment context

Throws:

IOException - if an error occurs while loading the leaf reader

collect

public void collect(int doc)
             throws IOException

Description copied from class: AnalyticsField

Collect the value(s) of the wrapped field for the given document, and store the value.

Specified by:

collect in class AnalyticsField

Parameters:

doc - ID of the document to collect

Throws:

IOException - if an error occurs while reading the document.

getFloat

public float getFloat()

Description copied from interface: FloatValue

Get the float representation of the current value.

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

Specified by:

getFloat in interface FloatValue

Returns:

the current value

getDouble

public double getDouble()

Description copied from interface: DoubleValue

Get the double representation of the current value.

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

Specified by:

getDouble in interface DoubleValue

Returns:

the current value

getString

public String getString()

Description copied from interface: StringValue

Get the String representation of the current value.

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

Specified by:

getString in interface StringValue

Returns:

the current value

getObject

public Object getObject()

Description copied from interface: AnalyticsValue

Get the object representation of the current value.

Specified by:

getObject in interface AnalyticsValue

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

streamFloats

public void streamFloats(FloatConsumer cons)

Description copied from interface: FloatValueStream

Stream the float representations of all current values, if any exist.

Specified by:

streamFloats in interface FloatValueStream

Parameters:

cons - The consumer to accept the values

streamDoubles

public void streamDoubles(DoubleConsumer cons)

Description copied from interface: DoubleValueStream

Stream the double representations of all current values, if any exist.

Specified by:

streamDoubles in interface DoubleValueStream

Parameters:

cons - The consumer to accept the values

streamStrings

public void streamStrings(Consumer<String> cons)

Description copied from interface: StringValueStream

Stream the String representations of all current values, if any exist.

Specified by:

streamStrings in interface StringValueStream

Parameters:

cons - The consumer to accept the values

streamObjects

public void streamObjects(Consumer<Object> cons)

Description copied from interface: AnalyticsValueStream

Stream the object representations of all current values, if any exist.

Specified by:

streamObjects in interface AnalyticsValueStream

Parameters:

cons - The consumer to accept the values

getObjectComparator

public ExpressionComparator<Float> getObjectComparator(String expression)

Description copied from interface: ComparableValue

Create an entry comparator used to sort the facet-value buckets of a facet.

Specified by:

getObjectComparator in interface ComparableValue

Parameters:

expression - the name of the expression in the results array

Returns:

a comparator to sort the buckets with