org.apache.solr.analytics.function.mapping

Class RemoveFunction

java.lang.Object

org.apache.solr.analytics.function.mapping.RemoveFunction

public class RemoveFunction
extends Object

A mapping function to remove an AnalyticsValue from an AnalyticsValue or an AnalyticsValueStream. For each document, the value exists if it doesn't equal the value of the second parameter.

The first parameter can be any type of analytics expression. If the parameter is multi-valued, then the return will be multi-valued. (Required)
The second parameter, which is the value to remove from the first parameter, must be an AnalyticsValue, aka single-valued. (Required)

The resulting Value or ValueStream will be typed with the closest super-type of the two parameters. (e.g. "remove"(int,float) will return a float)

Field Summary

Fields

Modifier and Type	Field and Description
static ExpressionFactory.CreatorFunction	creatorFunction
static String	name

Constructor Summary

Constructors

Constructor and Description
RemoveFunction()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

public static final String name

See Also:

Constant Field Values

creatorFunction

public static final ExpressionFactory.CreatorFunction creatorFunction

Constructor Detail

RemoveFunction

public RemoveFunction()