org.apache.solr.analytics.value

Interface AnalyticsValue

All Superinterfaces:

AnalyticsValueStream

All Known Subinterfaces:

BooleanValue, BooleanValue.CastingBooleanValue, ComparableValue, DateValue, DateValue.CastingDateValue, DoubleValue, DoubleValue.CastingDoubleValue, FloatValue, FloatValue.CastingFloatValue, IntValue, IntValue.CastingIntValue, LongValue, LongValue.CastingLongValue, ReductionFunction, StringValue, StringValue.CastingStringValue

All Known Implementing Classes:

AnalyticsValue.AbstractAnalyticsValue, BooleanField, BooleanValue.AbstractBooleanValue, ConstantBooleanValue, ConstantDateValue, ConstantDoubleValue, ConstantFloatValue, ConstantIntValue, ConstantLongValue, ConstantStringValue, ConstantValue, CountFunction, DateField, DateValue.AbstractDateValue, DocCountFunction, DoubleField, DoubleValue.AbstractDoubleValue, FloatField, FloatValue.AbstractFloatValue, IntField, IntValue.AbstractIntValue, LongField, LongValue.AbstractLongValue, MeanFunction, MissingFunction, StringField, StringValue.AbstractStringValue, SumFunction, UniqueFunction

public interface AnalyticsValue
extends AnalyticsValueStream

A single-valued analytics value.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnalyticsValue.AbstractAnalyticsValue An abstract base for AnalyticsValue that automatically casts to castable types.

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

AnalyticsValueStream.AbstractAnalyticsValueStream, AnalyticsValueStream.ExpressionType

Method Summary

Modifier and Type	Method and Description
boolean	exists() Check whether the current value exists.
Object	getObject() Get the object representation of the current value.

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

convertToConstant, createExpressionString, determineMappingPhase, getExpressionStr, getExpressionType, getName, streamObjects

Method Detail

exists

boolean exists()

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

Returns:

whether the current value exists

getObject

Object getObject()

Get the object representation of the current value.

Returns:

the current value