Package | Description |
---|---|
org.apache.lucene.facet.range |
Provides range faceting capabilities.
|
org.apache.lucene.facet.taxonomy |
Taxonomy of Categories
|
org.apache.lucene.queries.function |
Queries that compute score based upon a function
|
org.apache.lucene.queries.function.docvalues |
FunctionValues for different data types.
|
org.apache.lucene.queries.function.valuesource |
A variety of functions to use with FunctionQuery.
|
org.apache.lucene.search.grouping |
This module enables search result grouping with Lucene, where hits
with the same value in the specified single-valued group field are
grouped together.
|
org.apache.lucene.search.grouping.function |
Support for grouping by
ValueSource . |
org.apache.lucene.search.suggest |
Support for Autocomplete/Autosuggest
|
Modifier and Type | Method and Description |
---|---|
Filter |
LongRange.getFilter(Filter fastMatchFilter,
ValueSource valueSource) |
abstract Filter |
Range.getFilter(Filter fastMatchFilter,
ValueSource valueSource)
Returns a new
Filter accepting only documents
in this range. |
Filter |
DoubleRange.getFilter(Filter fastMatchFilter,
ValueSource valueSource) |
Filter |
Range.getFilter(ValueSource valueSource)
Returns a new
Filter accepting only documents
in this range. |
Constructor and Description |
---|
DoubleRangeFacetCounts(String field,
ValueSource valueSource,
FacetsCollector hits,
DoubleRange... ranges)
Create
RangeFacetCounts , using the provided
ValueSource . |
DoubleRangeFacetCounts(String field,
ValueSource valueSource,
FacetsCollector hits,
Filter fastMatchFilter,
DoubleRange... ranges)
Create
RangeFacetCounts , using the provided
ValueSource , and using the provided Filter as
a fastmatch: only documents passing the filter are
checked for the matching ranges. |
LongRangeFacetCounts(String field,
ValueSource valueSource,
FacetsCollector hits,
Filter fastMatchFilter,
LongRange... ranges)
Create
RangeFacetCounts , using the provided
ValueSource , and using the provided Filter as
a fastmatch: only documents passing the filter are
checked for the matching ranges. |
LongRangeFacetCounts(String field,
ValueSource valueSource,
FacetsCollector hits,
LongRange... ranges)
Create
RangeFacetCounts , using the provided
ValueSource . |
Modifier and Type | Class and Description |
---|---|
static class |
TaxonomyFacetSumValueSource.ScoreValueSource
ValueSource that returns the score for each
hit; use this to aggregate the sum of all hit scores
for each facet label. |
Constructor and Description |
---|
TaxonomyFacetSumValueSource(OrdinalsReader ordinalsReader,
TaxonomyReader taxoReader,
FacetsConfig config,
FacetsCollector fc,
ValueSource valueSource)
Aggreggates float facet values from the provided
ValueSource , and pulls ordinals from the
provided OrdinalsReader . |
TaxonomyFacetSumValueSource(TaxonomyReader taxoReader,
FacetsConfig config,
FacetsCollector fc,
ValueSource valueSource)
Aggreggates float facet values from the provided
ValueSource , pulling ordinals using DocValuesOrdinalsReader against the default indexed
facet field FacetsConfig.DEFAULT_INDEX_FIELD_NAME . |
Modifier and Type | Method and Description |
---|---|
ValueSource |
BoostedQuery.getValueSource() |
ValueSource |
FunctionQuery.getValueSource() |
Constructor and Description |
---|
BoostedQuery(Query subQuery,
ValueSource boostVal) |
FunctionQuery(ValueSource func) |
Modifier and Type | Field and Description |
---|---|
protected ValueSource |
DocTermsIndexDocValues.vs |
protected ValueSource |
DoubleDocValues.vs |
protected ValueSource |
IntDocValues.vs |
protected ValueSource |
FloatDocValues.vs |
protected ValueSource |
StrDocValues.vs |
protected ValueSource |
LongDocValues.vs |
protected ValueSource |
BoolDocValues.vs |
Constructor and Description |
---|
BoolDocValues(ValueSource vs) |
DocTermsIndexDocValues(ValueSource vs,
AtomicReaderContext context,
String field) |
DoubleDocValues(ValueSource vs) |
FloatDocValues(ValueSource vs) |
IntDocValues(ValueSource vs) |
LongDocValues(ValueSource vs) |
StrDocValues(ValueSource vs) |
Modifier and Type | Class and Description |
---|---|
class |
BoolFunction
Abstract parent class for those
ValueSource implementations which
apply boolean logic to their values |
class |
ByteFieldSource
Deprecated.
|
class |
BytesRefFieldSource
An implementation for retrieving
FunctionValues instances for string based fields. |
class |
ConstNumberSource
ConstNumberSource is the base class for all constant numbers |
class |
ConstValueSource
ConstValueSource returns a constant for all documents |
class |
DefFunction
ValueSource implementation which only returns the values from the provided
ValueSources which are available for a particular docId. |
class |
DivFloatFunction
Function to divide "a" by "b"
|
class |
DocFreqValueSource
DocFreqValueSource returns the number of documents containing the term. |
class |
DoubleConstValueSource
Function that returns a constant double value for every document.
|
class |
DoubleFieldSource
Obtains double field values from
FieldCache.getDoubles(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and makes
those values available as other numeric types, casting as needed. |
class |
DualFloatFunction
Abstract
ValueSource implementation which wraps two ValueSources
and applies an extendible float function to their values. |
class |
EnumFieldSource
Obtains int field values from
FieldCache.getInts(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and makes
those values available as other numeric types, casting as needed. |
class |
FieldCacheSource
A base class for ValueSource implementations that retrieve values for
a single field from the
FieldCache . |
class |
FloatFieldSource
Obtains float field values from
FieldCache.getFloats(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and makes those
values available as other numeric types, casting as needed. |
class |
IDFValueSource
Function that returns
#idf(long, long)
for every document. |
class |
IfFunction
Depending on the boolean value of the
ifSource function,
returns the value of the trueSource or falseSource function. |
class |
IntFieldSource
Obtains int field values from
FieldCache.getInts(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and makes those
values available as other numeric types, casting as needed. |
class |
JoinDocFreqValueSource
Use a field value and find the Document Frequency within another field.
|
class |
LinearFloatFunction
LinearFloatFunction implements a linear function over
another ValueSource . |
class |
LiteralValueSource
Pass a the field value through as a String, no matter the type // Q: doesn't this mean it's a "string"?
|
class |
LongFieldSource
Obtains long field values from
FieldCache.getLongs(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and makes those
values available as other numeric types, casting as needed. |
class |
MaxDocValueSource
Returns the value of
IndexReader.maxDoc()
for every document. |
class |
MaxFloatFunction
MaxFloatFunction returns the max of it's components. |
class |
MinFloatFunction
MinFloatFunction returns the min of it's components. |
class |
MultiBoolFunction
Abstract
ValueSource implementation which wraps multiple ValueSources
and applies an extendible boolean function to their values. |
class |
MultiFloatFunction
Abstract
ValueSource implementation which wraps multiple ValueSources
and applies an extendible float function to their values. |
class |
MultiFunction
Abstract parent class for
ValueSource implementations that wrap multiple
ValueSources and apply their own logic. |
class |
MultiValueSource
A
ValueSource that abstractly represents ValueSource s for
poly fields, and other things. |
class |
NormValueSource
Function that returns
TFIDFSimilarity.decodeNormValue(long)
for every document. |
class |
NumDocsValueSource
Returns the value of
IndexReader.numDocs()
for every document. |
class |
OrdFieldSource
Obtains the ordinal of the field value from the default Lucene
FieldCache using getStringIndex(). |
class |
PowFloatFunction
Function to raise the base "a" to the power "b"
|
class |
ProductFloatFunction
ProductFloatFunction returns the product of it's components. |
class |
QueryValueSource
QueryValueSource returns the relevance score of the query |
class |
RangeMapFloatFunction
RangeMapFloatFunction implements a map function over
another ValueSource whose values fall within min and max inclusive to target. |
class |
ReciprocalFloatFunction
ReciprocalFloatFunction implements a reciprocal function f(x) = a/(mx+b), based on
the float value of a field or function as exported by ValueSource . |
class |
ReverseOrdFieldSource
Obtains the ordinal of the field value from the default Lucene
FieldCache using getTermsIndex()
and reverses the order. |
class |
ScaleFloatFunction
Scales values to be between min and max.
|
class |
ShortFieldSource
Deprecated.
|
class |
SimpleBoolFunction
BoolFunction implementation which applies an extendible boolean
function to the values of a single wrapped ValueSource . |
class |
SimpleFloatFunction
A simple float function with a single argument
|
class |
SingleFunction
A function with a single argument
|
class |
SumFloatFunction
SumFloatFunction returns the sum of it's components. |
class |
SumTotalTermFreqValueSource
SumTotalTermFreqValueSource returns the number of tokens. |
class |
TermFreqValueSource
Function that returns
DocsEnum.freq() for the
supplied term in every document. |
class |
TFValueSource
Function that returns
TFIDFSimilarity.tf(float)
for every document. |
class |
TotalTermFreqValueSource
TotalTermFreqValueSource returns the total term freq
(sum of term freqs across all documents). |
class |
VectorValueSource
Converts individual ValueSource instances to leverage the FunctionValues *Val functions that work with multiple values,
i.e.
|
Modifier and Type | Field and Description |
---|---|
protected ValueSource |
DualFloatFunction.a |
protected ValueSource |
DualFloatFunction.b |
protected ValueSource |
RangeMapFloatFunction.defaultVal |
protected ValueSource |
SingleFunction.source |
protected ValueSource |
SimpleBoolFunction.source |
protected ValueSource |
RangeMapFloatFunction.source |
protected ValueSource |
LinearFloatFunction.source |
protected ValueSource |
ReciprocalFloatFunction.source |
protected ValueSource |
ScaleFloatFunction.source |
protected ValueSource[] |
MultiFloatFunction.sources |
protected ValueSource |
RangeMapFloatFunction.target |
Modifier and Type | Field and Description |
---|---|
protected List<ValueSource> |
MultiBoolFunction.sources |
protected List<ValueSource> |
MultiFunction.sources |
protected List<ValueSource> |
VectorValueSource.sources |
Modifier and Type | Method and Description |
---|---|
List<ValueSource> |
VectorValueSource.getSources() |
Modifier and Type | Method and Description |
---|---|
static String |
MultiFunction.description(String name,
List<ValueSource> sources) |
static FunctionValues[] |
MultiFunction.valsArr(List<ValueSource> sources,
Map fcontext,
AtomicReaderContext readerContext) |
Constructor and Description |
---|
DefFunction(List<ValueSource> sources) |
MultiBoolFunction(List<ValueSource> sources) |
MultiFunction(List<ValueSource> sources) |
VectorValueSource(List<ValueSource> sources) |
Constructor and Description |
---|
GroupingSearch(ValueSource groupFunction,
Map<?,?> valueSourceContext)
Constructs a
GroupingSearch instance that groups documents by function using a ValueSource
instance. |
Constructor and Description |
---|
FunctionAllGroupHeadsCollector(ValueSource groupBy,
Map<?,?> vsContext,
Sort sortWithinGroup)
Constructs a
FunctionAllGroupHeadsCollector instance. |
FunctionAllGroupsCollector(ValueSource groupBy,
Map<?,?> vsContext)
Constructs a
FunctionAllGroupsCollector instance. |
FunctionDistinctValuesCollector(Map<?,?> vsContext,
ValueSource groupSource,
ValueSource countSource,
Collection<SearchGroup<MutableValue>> groups) |
FunctionFirstPassGroupingCollector(ValueSource groupByVS,
Map<?,?> vsContext,
Sort groupSort,
int topNGroups)
Creates a first pass collector.
|
FunctionSecondPassGroupingCollector(Collection<SearchGroup<MutableValue>> searchGroups,
Sort groupSort,
Sort withinGroupSort,
int maxDocsPerGroup,
boolean getScores,
boolean getMaxScores,
boolean fillSortFields,
ValueSource groupByVS,
Map<?,?> vsContext)
Constructs a
FunctionSecondPassGroupingCollector instance. |
Constructor and Description |
---|
DocumentValueSourceDictionary(IndexReader reader,
String field,
ValueSource weightsValueSource)
Creates a new dictionary with the contents of the fields named
field
for the terms and uses the weightsValueSource supplied to determine the
score. |
DocumentValueSourceDictionary(IndexReader reader,
String field,
ValueSource weightsValueSource,
String payload)
Creates a new dictionary with the contents of the fields named
field
for the terms, payloadField for the corresponding payloads
and uses the weightsValueSource supplied to determine the
score. |
DocumentValueSourceDictionary(IndexReader reader,
String field,
ValueSource weightsValueSource,
String payload,
String contexts)
Creates a new dictionary with the contents of the fields named
field
for the terms, payload for the corresponding payloads, contexts
for the associated contexts and uses the weightsValueSource supplied
to determine the score. |
Copyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.