org.apache.solr.analytics.function.mapping

Class ComparisonFunction

java.lang.Object

org.apache.solr.analytics.function.mapping.ComparisonFunction

public class ComparisonFunction
extends Object

Contains all comparable functions. Comparable functions accept two comparable (numeric and date) parameters and return a BooleanValueStream. The two parameters must be able to be cast to the same type.

Uses:

• If a two comparable AnalyticsValues are passed in, a BooleanValue representing the comparison of the two values for each document is returned.
• If a comparable AnalyticsValue and a comparable AnalyticsValueStream are passed in, a BooleanValueStream representing the comparison of the Value and each of the values of the ValueStream for the document is returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComparisonFunction.CompResultFunction
static class	ComparisonFunction.GTEFunction A comparison function that tests whether the first parameter is greater than or equal to the second parameter
static class	ComparisonFunction.GTFunction A comparison function that tests whether the first parameter is greater than the second parameter
static class	ComparisonFunction.LTEFunction A comparison function that tests whether the first parameter is less than or equal to the second parameter
static class	ComparisonFunction.LTFunction A comparison function that tests whether the first parameter is less than the second parameter

Constructor Summary

Constructors

Constructor and Description
ComparisonFunction()

Method Summary

Modifier and Type	Method and Description
static BooleanValueStream	createComparisonFunction(String name, ComparisonFunction.CompResultFunction comp, AnalyticsValueStream... params) Create a comparison mapping function, comparing two analytics value (streams) of the same type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparisonFunction

public ComparisonFunction()

Method Detail

createComparisonFunction

public static BooleanValueStream createComparisonFunction(String name,
                                                          ComparisonFunction.CompResultFunction comp,
                                                          AnalyticsValueStream... params)

Create a comparison mapping function, comparing two analytics value (streams) of the same type.

Parameters:

name - name of the function

comp - function to find the result of a comparison

params - the parameters to compare

Returns:

an instance of the requested comparison function using the given parameters