Package org.apache.solr.analytics.value

Interface StringValue

All Superinterfaces:

AnalyticsValue, AnalyticsValueStream, StringValueStream

All Known Subinterfaces:

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

All Known Implementing Classes:

BooleanField, BooleanValue.AbstractBooleanValue, ConstantBooleanValue, ConstantDateValue, ConstantDoubleValue, ConstantFloatValue, ConstantIntValue, ConstantLongValue, ConstantStringValue, 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 StringValue
extends StringValueStream, AnalyticsValue

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

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

Nested Class Summary

Nested Classes

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

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

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

StringValueStream.AbstractStringValueStream, StringValueStream.CastingStringValueStream

Method Summary

Modifier and Type	Method	Description
String	getString()	Get the String representation of the current value.

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

exists, getObject

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

convertToConstant, getExpressionStr, getExpressionType, getName, streamObjects

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

streamStrings

Method Detail

getString

String getString()

Get the String representation of the current value.

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

Returns:

the current value