org.apache.solr.analytics.value.constant

Class ConstantStringValue

java.lang.Object

org.apache.solr.analytics.value.constant.ConstantValue

org.apache.solr.analytics.value.constant.ConstantStringValue

All Implemented Interfaces:

AnalyticsValue, AnalyticsValueStream, ComparableValue, StringValue, StringValue.CastingStringValue, StringValueStream

public class ConstantStringValue
extends ConstantValue
implements StringValue.CastingStringValue

A constant StringValue. Every call to getString() and other methods will return the same constant value.

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	name

Fields inherited from class org.apache.solr.analytics.value.constant.ConstantValue

creatorFunction

Constructor Summary

Constructors

Constructor and Description
ConstantStringValue(String value)

Method Summary

Modifier and Type	Method and Description
boolean	exists() Check whether the current value exists.
String	getExpressionStr() Get the expression string of the analytics value stream.
AnalyticsValueStream.ExpressionType	getExpressionType() Get the type of the expression that this class represents.
String	getName() Get the name of function or value.
Object	getObject() Get the object representation of the current value.
ConstantComparator	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	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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createExpressionString, determineMappingPhase

Field Detail

name

public static final String name

See Also:

Constant Field Values

Constructor Detail

ConstantStringValue

public ConstantStringValue(String value)

Method Detail

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

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 ConstantComparator 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

getName

public String getName()

Description copied from interface: AnalyticsValueStream

Get the name of function or value.

Specified by:

getName in interface AnalyticsValueStream

Returns:

the name of function/value

getExpressionStr

public String getExpressionStr()

Description copied from interface: AnalyticsValueStream

Get the expression string of the analytics value stream. Must be unique to the expression. If passed to ExpressionFactory.createExpression(String), the exact same expression should be created.

Specified by:

getExpressionStr in interface AnalyticsValueStream

Returns:

the name of function/value

getExpressionType

public AnalyticsValueStream.ExpressionType getExpressionType()

Description copied from interface: AnalyticsValueStream

Get the type of the expression that this class represents.

Specified by:

getExpressionType in interface AnalyticsValueStream

Returns:

the expression type