Index (Lucene 9.12.1 demo API)

A B C D E G I K M O P R S T
All Classes All Packages

A

AssociationsFacetsExample - Class in org.apache.lucene.demo.facet: Shows example usage of category associations.
AssociationsFacetsExample() - Constructor for class org.apache.lucene.demo.facet.AssociationsFacetsExample: Empty constructor

B

build(Path, Directory, String) - Static method in class org.apache.lucene.demo.knn.KnnVectorDict: Convert from a GloVe-formatted dictionary file to a KnnVectorDict file pair.

C

close() - Method in class org.apache.lucene.demo.facet.DistanceFacetsExample
close() - Method in class org.apache.lucene.demo.facet.RangeFacetsExample
close() - Method in class org.apache.lucene.demo.IndexFiles
close() - Method in class org.apache.lucene.demo.knn.KnnVectorDict
computeEmbedding(Reader) - Method in class org.apache.lucene.demo.knn.DemoEmbeddings: Tokenize and lower-case the input, look up the tokens in the dictionary, and sum the token vectors.
computeEmbedding(String) - Method in class org.apache.lucene.demo.knn.DemoEmbeddings: Tokenize and lower-case the input, look up the tokens in the dictionary, and sum the token vectors.
CustomFacetSetExample - Class in org.apache.lucene.demo.facet: Shows usage of indexing and searching FacetSetsField with a custom FacetSet implementation.
CustomFacetSetExample() - Constructor for class org.apache.lucene.demo.facet.CustomFacetSetExample: Empty constructor
CustomFacetSetExample.TemperatureOnlyFacetSetMatcher - Class in org.apache.lucene.demo.facet: A FacetSetMatcher which matches facet sets only by their temperature dimension, ignoring the date.
CustomFacetSetExample.TemperatureReadingFacetSet - Class in org.apache.lucene.demo.facet: A FacetSet which encodes a temperature reading in a date (long) and degrees (celsius; float).

D

decodeTemperatureReading(BytesRef, int, long[]) - Static method in class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureReadingFacetSet: An implementation of FacetSetDecoder.decode(BytesRef, int, long[]) for CustomFacetSetExample.TemperatureReadingFacetSet.
DemoEmbeddings - Class in org.apache.lucene.demo.knn: This class provides DemoEmbeddings.computeEmbedding(String) and DemoEmbeddings.computeEmbedding(Reader) for calculating "semantic" embedding vectors for textual input.
DemoEmbeddings(KnnVectorDict) - Constructor for class org.apache.lucene.demo.knn.DemoEmbeddings: Sole constructor
DistanceFacetsExample - Class in org.apache.lucene.demo.facet: Shows simple usage of dynamic range faceting, using the expressions module to calculate distance.
DistanceFacetsExample() - Constructor for class org.apache.lucene.demo.facet.DistanceFacetsExample: Empty constructor
doPagingSearch(BufferedReader, IndexSearcher, Query, int, boolean, boolean) - Static method in class org.apache.lucene.demo.SearchFiles: This demonstrates a typical paging search scenario, where the search engine presents pages of size n to the user.
drillDown(DoubleRange) - Method in class org.apache.lucene.demo.facet.DistanceFacetsExample: User drills down on the specified range.
drillDown(LongRange) - Method in class org.apache.lucene.demo.facet.RangeFacetsExample: User drills down on the specified range.
drillSideways(LongRange) - Method in class org.apache.lucene.demo.facet.RangeFacetsExample: User drills down on the specified range, and also computes drill sideways counts.
DynamicRangeFacetsExample - Class in org.apache.lucene.demo.facet: Demo dynamic range faceting.
DynamicRangeFacetsExample() - Constructor for class org.apache.lucene.demo.facet.DynamicRangeFacetsExample: Empty constructor

E

EARTH_RADIUS_KM - Static variable in class org.apache.lucene.demo.facet.DistanceFacetsExample: Mean radius of the Earth in KM
end() - Method in class org.apache.lucene.demo.knn.KnnVectorDictFilter
ExpressionAggregationFacetsExample - Class in org.apache.lucene.demo.facet: Shows facets aggregation by an expression.
ExpressionAggregationFacetsExample() - Constructor for class org.apache.lucene.demo.facet.ExpressionAggregationFacetsExample: Empty constructor

G

get(BytesRef, byte[]) - Method in class org.apache.lucene.demo.knn.KnnVectorDict: Get the vector corresponding to the given token.
getBoundingBoxQuery(double, double, double) - Static method in class org.apache.lucene.demo.facet.DistanceFacetsExample: Given a latitude and longitude (in degrees) and the maximum great circle (surface of the earth) distance, returns a simple Filter bounding box to "fast match" candidates.
getComparableValues() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureReadingFacetSet
getDimension() - Method in class org.apache.lucene.demo.knn.KnnVectorDict: Get the dimension of the vectors returned by this.
getResult() - Method in class org.apache.lucene.demo.knn.KnnVectorDictFilter: Get the vector computed from the input

I

incrementToken() - Method in class org.apache.lucene.demo.knn.KnnVectorDictFilter
index() - Method in class org.apache.lucene.demo.facet.DistanceFacetsExample: Build the example index.
index() - Method in class org.apache.lucene.demo.facet.RangeFacetsExample: Build the example index.
IndexFiles - Class in org.apache.lucene.demo: Index all text files under a directory.

K

KnnVectorDict - Class in org.apache.lucene.demo.knn: Manages a map from token to numeric vector for use with KnnVector indexing and search.
KnnVectorDict(Directory, String) - Constructor for class org.apache.lucene.demo.knn.KnnVectorDict: Sole constructor
KnnVectorDictFilter - Class in org.apache.lucene.demo.knn: Looks up each tokens in a dictionary, and sums the token vectors.
KnnVectorDictFilter(TokenStream, KnnVectorDict) - Constructor for class org.apache.lucene.demo.knn.KnnVectorDictFilter: sole constructor

M

main(String[]) - Static method in class org.apache.lucene.demo.facet.AssociationsFacetsExample: Runs the sum int/float associations examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.CustomFacetSetExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.DistanceFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.DynamicRangeFacetsExample: Runs the search example and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.ExpressionAggregationFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.MultiCategoryListsFacetsExample: Runs the search example and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.RangeFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.SimpleFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.SimpleSortedSetFacetsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.facet.StringValueFacetCountsExample: Runs the search and drill-down examples and prints the results.
main(String[]) - Static method in class org.apache.lucene.demo.IndexFiles: Index all text files under a directory.
main(String[]) - Static method in class org.apache.lucene.demo.SearchFiles: Simple command-line based search demo.
matches(long[]) - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureOnlyFacetSetMatcher
MultiCategoryListsFacetsExample - Class in org.apache.lucene.demo.facet: Demonstrates indexing categories into different indexed fields.
MultiCategoryListsFacetsExample() - Constructor for class org.apache.lucene.demo.facet.MultiCategoryListsFacetsExample: Creates a new instance and populates the category list params mapping.

O

org.apache.lucene.demo - package org.apache.lucene.demo: Demo applications for indexing and searching.
org.apache.lucene.demo.facet - package org.apache.lucene.demo.facet: Facet Userguide and Demo.
org.apache.lucene.demo.knn - package org.apache.lucene.demo.knn: KnnVector example code.
ORIGIN_LATITUDE - Static variable in class org.apache.lucene.demo.facet.DistanceFacetsExample: The "home" latitude.
ORIGIN_LONGITUDE - Static variable in class org.apache.lucene.demo.facet.DistanceFacetsExample: The "home" longitude.

P

packValues(byte[], int) - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureReadingFacetSet

R

ramBytesUsed() - Method in class org.apache.lucene.demo.knn.KnnVectorDict: Return the size of the dictionary in bytes
RangeFacetsExample - Class in org.apache.lucene.demo.facet: Shows simple usage of dynamic range faceting.
RangeFacetsExample() - Constructor for class org.apache.lucene.demo.facet.RangeFacetsExample: Empty constructor
reset() - Method in class org.apache.lucene.demo.knn.KnnVectorDictFilter
runCustomRangeMatching() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample: Runs the custom range matching example.
runDrillDown() - Method in class org.apache.lucene.demo.facet.AssociationsFacetsExample: Runs the drill-down example.
runDrillDown() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the drill-down example.
runDrillDown() - Method in class org.apache.lucene.demo.facet.SimpleFacetsExample: Runs the drill-down example.
runDrillDown() - Method in class org.apache.lucene.demo.facet.SimpleSortedSetFacetsExample: Runs the drill-down example.
runDrillSideways() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the drill-sideways example.
runDrillSideways() - Method in class org.apache.lucene.demo.facet.SimpleFacetsExample: Runs the drill-sideways example.
runExactMatching() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample: Runs the exact matching example.
runExactMatchingWithFastMatchQuery() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample: Runs the exact matching with fast match query example.
runFacetOnly() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the search example.
runFacetOnly() - Method in class org.apache.lucene.demo.facet.SimpleFacetsExample: Runs the search example.
runNonOverlappingRangesAggregationFacets() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the example of collecting long aggregations for non overlapping range facets.
runNonOverlappingRangesCountFacetsOnly() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the example of non overlapping range facets
runOverlappingRangesCountFacetsOnly() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the example of overlapping range facets
runRangeMatching() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample: Runs the range matching example.
runSearch() - Method in class org.apache.lucene.demo.facet.DynamicRangeFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.ExpressionAggregationFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.MultiCategoryListsFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.SandboxFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.SimpleFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.SimpleSortedSetFacetsExample: Runs the search example.
runSearch() - Method in class org.apache.lucene.demo.facet.StringValueFacetCountsExample: Runs the search example.
runSumAssociations() - Method in class org.apache.lucene.demo.facet.AssociationsFacetsExample: Runs summing association example.

S

SandboxFacetsExample - Class in org.apache.lucene.demo.facet: Demo for sandbox faceting.
search() - Method in class org.apache.lucene.demo.facet.DistanceFacetsExample: User runs a query and counts facets.
search() - Method in class org.apache.lucene.demo.facet.RangeFacetsExample: User runs a query and counts facets.
SearchFiles - Class in org.apache.lucene.demo: Simple command-line based search demo.
SimpleFacetsExample - Class in org.apache.lucene.demo.facet: Shows simple usage of faceted indexing and search.
SimpleFacetsExample() - Constructor for class org.apache.lucene.demo.facet.SimpleFacetsExample: Empty constructor
SimpleSortedSetFacetsExample - Class in org.apache.lucene.demo.facet: Shows simple usage of faceted indexing and search, using SortedSetDocValuesFacetField and SortedSetDocValuesFacetCounts.
SimpleSortedSetFacetsExample() - Constructor for class org.apache.lucene.demo.facet.SimpleSortedSetFacetsExample: Empty constructor
sizePackedBytes() - Method in class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureReadingFacetSet
StringValueFacetCountsExample - Class in org.apache.lucene.demo.facet: Demonstrate the use of StringValueFacetCounts over SortedDocValuesField and KeywordField.
StringValueFacetCountsExample() - Constructor for class org.apache.lucene.demo.facet.StringValueFacetCountsExample: Empty constructor

T

TemperatureOnlyFacetSetMatcher(String, DimRange) - Constructor for class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureOnlyFacetSetMatcher: Constructor
TemperatureReadingFacetSet(long, float) - Constructor for class org.apache.lucene.demo.facet.CustomFacetSetExample.TemperatureReadingFacetSet: Constructor

A B C D E G I K M O P R S T
All Classes All Packages