org.apache.solr.analytics.value

Interface BooleanValue

All Superinterfaces:

AnalyticsValue, AnalyticsValueStream, BooleanValueStream

All Known Subinterfaces:

BooleanValue.CastingBooleanValue

All Known Implementing Classes:

BooleanField, BooleanValue.AbstractBooleanValue, ConstantBooleanValue

public interface BooleanValue
extends BooleanValueStream, AnalyticsValue

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

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

Nested Class Summary

Nested Classes

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

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

BooleanValueStream.AbstractBooleanValueStream, BooleanValueStream.CastingBooleanValueStream

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

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean() Get the boolean representation of the current value.

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

streamBooleans

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

exists, getObject

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

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

Method Detail

getBoolean

boolean getBoolean()

Get the boolean representation of the current value.

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

Returns:

the current value