org.apache.solr.analytics.value

Interface FloatValue

All Superinterfaces:

AnalyticsValue, AnalyticsValueStream, FloatValueStream

All Known Subinterfaces:

FloatValue.CastingFloatValue, IntValue.CastingIntValue

All Known Implementing Classes:

ConstantFloatValue, ConstantIntValue, FloatField, FloatValue.AbstractFloatValue, IntField, IntValue.AbstractIntValue

public interface FloatValue
extends FloatValueStream, AnalyticsValue

A single-valued analytics value that can be represented as a float.

The back-end production of the value can change inbetween calls to getFloat() and AnalyticsValue.exists(), resulting in different values on each call.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FloatValue.AbstractFloatValue An abstract base for FloatValue.CastingFloatValue that automatically casts to all types if getFloat() and AnalyticsValue.exists() are implemented.
static interface	FloatValue.CastingFloatValue An interface that represents all of the types a FloatValue should be able to cast to.

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

AnalyticsValue.AbstractAnalyticsValue

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

AnalyticsValueStream.ExpressionType

Method Summary

Modifier and Type	Method and Description
float	getFloat() Get the float representation of the current value.

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

streamFloats

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

exists, getObject

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

createExpressionString, determineMappingPhase, getExpressionStr, getExpressionType, getName, streamObjects

Method Detail

getFloat

float getFloat()

Get the float representation of the current value.

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

Returns:

the current value