Index (Lucene 10.5.1 expressions API)

# Index

A B C D E G H I J M O P S T V
All Classes and Interfaces|All Packages

## A

add(String, Expression) - Method in class org.apache.lucene.expressions.SimpleBindings
  Adds an Expression to the bindings.
add(String, DoubleValuesSource) - Method in class org.apache.lucene.expressions.SimpleBindings
  Bind a `DoubleValuesSource` directly to the given name.

## B

Bindings - Class in org.apache.lucene.expressions
  Binds variable names in expressions to actual data.
Bindings() - Constructor for class org.apache.lucene.expressions.Bindings
  Sole constructor.

## C

compile(String) - Static method in class org.apache.lucene.expressions.js.JavascriptCompiler
  Compiles the given expression using default compiler settings.
compile(String, Map<String, MethodHandle>) - Static method in class org.apache.lucene.expressions.js.JavascriptCompiler
  Compiles the given expression with the supplied custom functions using default compiler settings.
convertLegacyFunctions(Map<String, Method>) - Static method in class org.apache.lucene.expressions.js.JavascriptCompiler
  Deprecated.
  Only use this to convert Lucene 9.x or earlier legacy code. For new code use `MethodHandle`.

## D

DEFAULT_FUNCTIONS - Static variable in class org.apache.lucene.expressions.js.JavascriptCompiler
  The default set of functions available to expressions.

## E

evaluate(DoubleValues[]) - Method in class org.apache.lucene.expressions.Expression
  Evaluates the expression for the current document.
Expression - Class in org.apache.lucene.expressions
  Base class that computes the value of an expression for a document.
Expression(String, String[]) - Constructor for class org.apache.lucene.expressions.Expression
  Creates a new `Expression`.
ExpressionMath - Class in org.apache.lucene.expressions.js
  Helper class holding static methods for js math functions

## G

getDoubleValuesSource(String) - Method in class org.apache.lucene.expressions.Bindings
  Returns a DoubleValuesSource bound to the variable name
getDoubleValuesSource(String) - Method in class org.apache.lucene.expressions.SimpleBindings
getDoubleValuesSource(Bindings) - Method in class org.apache.lucene.expressions.Expression
  Get a DoubleValuesSource which can compute the value of this expression in the context of the given bindings.
getRescorer(Bindings) - Method in class org.apache.lucene.expressions.Expression
  Get a `Rescorer`, to rescore first-pass hits using this expression.
getSortField(Bindings, boolean) - Method in class org.apache.lucene.expressions.Expression
  Get a sort field which can be used to rank documents by this expression.

## H

haversinKilometers(double, double, double, double) - Static method in class org.apache.lucene.expressions.js.ExpressionMath
  Returns the Haversine distance in kilometers between two points specified in decimal degrees (latitude/longitude).

## I

INT_INDEX - Enum constant in enum class org.apache.lucene.expressions.js.VariableContext.Type
  Brackets containing an integer index (ie an array).
integer - Variable in class org.apache.lucene.expressions.js.VariableContext
  The integer value for this piece of the variable.

## J

JavascriptCompiler - Class in org.apache.lucene.expressions.js
  An expression compiler for javascript expressions.

## M

MEMBER - Enum constant in enum class org.apache.lucene.expressions.js.VariableContext.Type
  A member of the previous context (ie "dot" access).
METHOD - Enum constant in enum class org.apache.lucene.expressions.js.VariableContext.Type
  Parenthesis represent a member method to be called.

## O

org.apache.lucene.expressions - package org.apache.lucene.expressions
  Expressions.
org.apache.lucene.expressions.js - package org.apache.lucene.expressions.js
  Javascript expressions.

## P

parse(String) - Static method in class org.apache.lucene.expressions.js.VariableContext
  Parses a normalized javascript variable.

## S

SimpleBindings - Class in org.apache.lucene.expressions
  Simple class that binds expression variable names to `DoubleValuesSource`s or other `Expression`s.
SimpleBindings() - Constructor for class org.apache.lucene.expressions.SimpleBindings
  Creates a new empty Bindings
sourceText - Variable in class org.apache.lucene.expressions.Expression
  The original source text
STR_INDEX - Enum constant in enum class org.apache.lucene.expressions.js.VariableContext.Type
  Brackets containing a string as the "index".

## T

text - Variable in class org.apache.lucene.expressions.js.VariableContext
  The text of this piece of the variable.
The Expressions Module for Apache Lucene - Search tag in Overview
  Section
type - Variable in class org.apache.lucene.expressions.js.VariableContext
  The type of this piece of a variable.

## V

validate() - Method in class org.apache.lucene.expressions.SimpleBindings
  Traverses the graph of bindings, checking there are no cycles or missing references
valueOf(String) - Static method in enum class org.apache.lucene.expressions.js.VariableContext.Type
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.lucene.expressions.js.VariableContext.Type
  Returns an array containing the constants of this enum class, in the order they are declared.
VariableContext - Class in org.apache.lucene.expressions.js
  A helper to parse the context of a variable name, which is the base variable, followed by the sequence of array (integer or string indexed) and member accesses.
VariableContext.Type - Enum Class in org.apache.lucene.expressions.js
  Represents what a piece of a variable does.
variables - Variable in class org.apache.lucene.expressions.Expression
  Named variables referred to by this expression

A B C D E G H I J M O P S T V
All Classes and Interfaces|All Packages