Index (Lucene 10.5.0 join API)

# Index

A B C D E F G H I J M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values

## A

accept(BytesRef) - Method in class org.apache.lucene.search.join.SeekingTermSetTermsEnum
approximateSearch(LeafReaderContext, AcceptDocs, int, KnnCollectorManager) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
approximateSearch(LeafReaderContext, AcceptDocs, int, KnnCollectorManager) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
Avg - Enum constant in enum class org.apache.lucene.search.join.ScoreMode
  Parent hit's score is the average of all child scores.

## B

BitSetProducer - Interface in org.apache.lucene.search.join
  A producer of `BitSet`s per segment.
BlockJoinSelector - Class in org.apache.lucene.search.join
  Select a value from a block of documents.
BlockJoinSelector.Type - Enum Class in org.apache.lucene.search.join
  Type of selection to perform.

## C

check(IndexReader, BitSetProducer) - Static method in class org.apache.lucene.search.join.CheckJoinIndex
  Check that the given index is good to use for block joins.
CheckJoinIndex - Class in org.apache.lucene.search.join
  Utility class to check a block join index.
createJoinQuery(String, boolean, String, Class<? extends Number>, Query, IndexSearcher, ScoreMode) - Static method in class org.apache.lucene.search.join.JoinUtil
  Method for query time joining for numeric fields.
createJoinQuery(String, boolean, String, Query, IndexSearcher, ScoreMode) - Static method in class org.apache.lucene.search.join.JoinUtil
  Method for query time joining.
createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, OrdinalMap) - Static method in class org.apache.lucene.search.join.JoinUtil
  Delegates to `JoinUtil.createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, OrdinalMap, int, int)`, but disables the min and max filtering.
createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, OrdinalMap, int, int) - Static method in class org.apache.lucene.search.join.JoinUtil
  A query time join using global ordinals over a dedicated join field.
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery

## D

DEFAULT_CHILD_LIMIT_PER_PARENT - Static variable in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  The default maximum number of child documents to match per parent document.
DiversifyingChildrenByteKnnVectorQuery - Class in org.apache.lucene.search.join
  kNN byte vector query that joins matching children vector documents with their parent doc id.
DiversifyingChildrenByteKnnVectorQuery(String, byte[], Query, int, BitSetProducer) - Constructor for class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
  Create a ToParentBlockJoinByteVectorQuery.
DiversifyingChildrenByteKnnVectorQuery(String, byte[], Query, int, BitSetProducer, KnnSearchStrategy) - Constructor for class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
  Create a DiversifyingChildrenByteKnnVectorQuery.
DiversifyingChildrenFloatKnnVectorQuery - Class in org.apache.lucene.search.join
  kNN float vector query that joins matching children vector documents with their parent doc id.
DiversifyingChildrenFloatKnnVectorQuery(String, float[], Query, int, BitSetProducer) - Constructor for class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
  Create a DiversifyingChildrenFloatKnnVectorQuery.
DiversifyingChildrenFloatKnnVectorQuery(String, float[], Query, int, BitSetProducer, KnnSearchStrategy) - Constructor for class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
  Create a DiversifyingChildrenFloatKnnVectorQuery.
DiversifyingNearestChildrenKnnCollectorManager - Class in org.apache.lucene.search.join
  DiversifyingNearestChildrenKnnCollectorManager responsible for creating `DiversifyingNearestChildrenKnnCollector` instances.
DiversifyingNearestChildrenKnnCollectorManager(int, BitSetProducer, IndexSearcher) - Constructor for class org.apache.lucene.search.join.DiversifyingNearestChildrenKnnCollectorManager
  Constructor

## E

equals(Object) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
equals(Object) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
equals(Object) - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
equals(Object) - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
equals(Object) - Method in class org.apache.lucene.search.join.QueryBitSetProducer
equals(Object) - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
equals(Object) - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery
equals(Object) - Method in class org.apache.lucene.search.join.ToParentBlockJoinSortField
exactSearch(LeafReaderContext, DocIdSetIterator, QueryTimeout) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
exactSearch(LeafReaderContext, DocIdSetIterator, QueryTimeout) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery

## F

field - Variable in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
field - Variable in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
filter - Variable in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
filter - Variable in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery

## G

getBitSet(LeafReaderContext) - Method in interface org.apache.lucene.search.join.BitSetProducer
  Produce a `BitSet` matching the expected documents on the given segment.
getBitSet(LeafReaderContext) - Method in class org.apache.lucene.search.join.QueryBitSetProducer
getChildQuery() - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  Return the child query.
getChildQuery() - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery
  Return our child query.
getComparator(int, Pruning) - Method in class org.apache.lucene.search.join.ToParentBlockJoinSortField
getField() - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
getField() - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
getFilter() - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
getFilter() - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
getK() - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
getK() - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
getKnnCollectorManager(int, IndexSearcher) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
getKnnCollectorManager(int, IndexSearcher) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
getParentQuery() - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  Return the parent query.
getParentQuery() - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
  Return our parent query.
getQuery() - Method in class org.apache.lucene.search.join.QueryBitSetProducer
  Gets the contained query.
getSearchStrategy() - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
getSearchStrategy() - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery

## H

hashCode() - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
hashCode() - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
hashCode() - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
hashCode() - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
hashCode() - Method in class org.apache.lucene.search.join.QueryBitSetProducer
hashCode() - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
hashCode() - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery
hashCode() - Method in class org.apache.lucene.search.join.ToParentBlockJoinSortField

## I

Index-time joins - Search tag in package org.apache.lucene.search.join
  Section
isOptimistic() - Method in class org.apache.lucene.search.join.DiversifyingNearestChildrenKnnCollectorManager

## J

JoinUtil - Class in org.apache.lucene.search.join
  Utility for query time joining.

## M

Max - Enum constant in enum class org.apache.lucene.search.join.ScoreMode
  Parent hit's score is the max of all child scores.
MAX - Enum constant in enum class org.apache.lucene.search.join.BlockJoinSelector.Type
  Only consider the maximum value from the block when sorting.
mergeLeafResults(TopDocs[]) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
mergeLeafResults(TopDocs[]) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
Min - Enum constant in enum class org.apache.lucene.search.join.ScoreMode
  Parent hit's score is the min of all child scores.
MIN - Enum constant in enum class org.apache.lucene.search.join.BlockJoinSelector.Type
  Only consider the minimum value from the block when sorting.

## N

newCollector(int, KnnSearchStrategy, LeafReaderContext) - Method in class org.apache.lucene.search.join.DiversifyingNearestChildrenKnnCollectorManager
  Return a new `DiversifyingNearestChildrenKnnCollector` instance.
newOptimisticCollector(int, KnnSearchStrategy, LeafReaderContext, int) - Method in class org.apache.lucene.search.join.DiversifyingNearestChildrenKnnCollectorManager
nextSeekTerm(BytesRef) - Method in class org.apache.lucene.search.join.SeekingTermSetTermsEnum
None - Enum constant in enum class org.apache.lucene.search.join.ScoreMode
  Do no scoring.

## O

org.apache.lucene.search.join - package org.apache.lucene.search.join
  Support for index-time and query-time joins.

## P

ParentChildrenBlockJoinQuery - Class in org.apache.lucene.search.join
  A query that returns all the matching child documents for a specific parent document indexed together in the same block.
ParentChildrenBlockJoinQuery(BitSetProducer, Query, int) - Constructor for class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
  Creates a `ParentChildrenBlockJoinQuery` instance
ParentsChildrenBlockJoinQuery - Class in org.apache.lucene.search.join
  A query that returns the matching child documents for matching parent documents indexed together in the same block.
ParentsChildrenBlockJoinQuery(BitSetProducer, Query, Query) - Constructor for class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  Create a ParentsChildrenBlockJoinQuery with DEFAULT_CHILD_LIMIT_PER_PARENT.
ParentsChildrenBlockJoinQuery(BitSetProducer, Query, Query, int) - Constructor for class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  Create a ParentsChildrenBlockJoinQuery.
ParentsChildrenBlockJoinQuery(BitSetProducer, Query, Query, int, BinaryOperator<Float>) - Constructor for class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
  Create a ParentsChildrenBlockJoinQuery with a custom score combiner.

## Q

QueryBitSetProducer - Class in org.apache.lucene.search.join
  A `BitSetProducer` that wraps a query and caches matching `BitSet`s per segment.
QueryBitSetProducer(Query) - Constructor for class org.apache.lucene.search.join.QueryBitSetProducer
  Wraps another query's result and caches it into bitsets.
Query-time joins - Search tag in package org.apache.lucene.search.join
  Section

## R

rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery

## S

ScoreMode - Enum Class in org.apache.lucene.search.join
  How to aggregate multiple child hit scores into a single parent score.
searchLeaf(LeafReaderContext, Weight, TimeLimitingKnnCollectorManager) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
searchLeaf(LeafReaderContext, Weight, TimeLimitingKnnCollectorManager) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
searchStrategy - Variable in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
searchStrategy - Variable in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
SeekingTermSetTermsEnum - Class in org.apache.lucene.search.join
  A filtered TermsEnum that uses a BytesRefHash as a filter
SeekingTermSetTermsEnum(TermsEnum, BytesRefHash, int[]) - Constructor for class org.apache.lucene.search.join.SeekingTermSetTermsEnum
  Constructor

## T

ToChildBlockJoinQuery - Class in org.apache.lucene.search.join
  Just like `ToParentBlockJoinQuery`, except this query joins in reverse: you provide a Query matching parent documents and it joins down to child documents.
ToChildBlockJoinQuery(Query, BitSetProducer) - Constructor for class org.apache.lucene.search.join.ToChildBlockJoinQuery
  Create a ToChildBlockJoinQuery.
toIter(BitSet) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  creates an iterator for the given bitset
ToParentBlockJoinQuery - Class in org.apache.lucene.search.join
  This query requires that you index children and parent docs as a single block, using the `IndexWriter.addDocuments()` or `IndexWriter.updateDocuments()` API.
ToParentBlockJoinQuery(Query, BitSetProducer, ScoreMode) - Constructor for class org.apache.lucene.search.join.ToParentBlockJoinQuery
  Create a ToParentBlockJoinQuery.
ToParentBlockJoinSortField - Class in org.apache.lucene.search.join
  A special sort field that allows sorting parent docs based on nested / child level fields.
ToParentBlockJoinSortField(String, SortField.Type, boolean, boolean, Object, Object, BitSetProducer, BitSetProducer) - Constructor for class org.apache.lucene.search.join.ToParentBlockJoinSortField
  Create ToParentBlockJoinSortField.
ToParentBlockJoinSortField(String, SortField.Type, boolean, boolean, BitSetProducer, BitSetProducer) - Constructor for class org.apache.lucene.search.join.ToParentBlockJoinSortField
  Create ToParentBlockJoinSortField.
ToParentBlockJoinSortField(String, SortField.Type, boolean, Object, Object, BitSetProducer, BitSetProducer) - Constructor for class org.apache.lucene.search.join.ToParentBlockJoinSortField
  Create ToParentBlockJoinSortField.
ToParentBlockJoinSortField(String, SortField.Type, boolean, BitSetProducer, BitSetProducer) - Constructor for class org.apache.lucene.search.join.ToParentBlockJoinSortField
  Create ToParentBlockJoinSortField.
toString() - Method in class org.apache.lucene.search.join.QueryBitSetProducer
toString(String) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
toString(String) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
toString(String) - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
toString(String) - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
toString(String) - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
toString(String) - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery
Total - Enum constant in enum class org.apache.lucene.search.join.ScoreMode
  Parent hit's score is the sum of all child scores.

## V

valueOf(String) - Static method in enum class org.apache.lucene.search.join.BlockJoinSelector.Type
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.join.ScoreMode
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.lucene.search.join.BlockJoinSelector.Type
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.join.ScoreMode
  Returns an array containing the constants of this enum class, in the order they are declared.
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.DiversifyingChildrenFloatKnnVectorQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.ParentsChildrenBlockJoinQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.ToChildBlockJoinQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.join.ToParentBlockJoinQuery

## W

wrap(NumericDocValues, BlockJoinSelector.Type, BitSet, DocIdSetIterator) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Wraps the provided `NumericDocValues`, iterating over only child documents, in order to only select one value per parent among its `children` using the configured `selection` type.
wrap(NumericDocValues, BlockJoinSelector.Type, BitSet, DocIdSetIterator, Long) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Wraps the provided `NumericDocValues`, iterating over only child documents, in order to only select one value per parent among its `children` using the configured `selection` type.
wrap(SortedDocValues, BlockJoinSelector.Type, BitSet, DocIdSetIterator, boolean) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Wraps the provided `SortedDocValues` in order to only select one value per parent among its `children` using the configured `selection` type.
wrap(SortedNumericDocValues, BlockJoinSelector.Type, BitSet, DocIdSetIterator, Long) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Wraps the provided `SortedNumericDocValues` in order to only select one value per parent among its `children` using the configured `selection` type.
wrap(SortedSetDocValues, BlockJoinSelector.Type, BitSet, DocIdSetIterator, boolean) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Wraps the provided `SortedSetDocValues` in order to only select one value per parent among its `children` using the configured `selection` type.
wrap(Bits, BitSet, BitSet) - Static method in class org.apache.lucene.search.join.BlockJoinSelector
  Return a `Bits` instance that returns true if, and only if, any of the children of the given parent document has a value.

A B C D E F G H I J M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values