IntervalsSource
Static constructor functions for various different sources can be found in the Intervals
class
Scores for this query are computed as a function of the sloppy frequency of intervals appearing in a particular document. Sloppy frequency is calculated from the number of matching intervals, and their width, with wider intervals contributing lower values. The scores can be adjusted with two optional parameters:
- pivot - the sloppy frequency value at which the overall score of the document will equal 0.5. The default value is 1
- exp - higher values of this parameter make the function grow more slowly below the pivot and faster higher than the pivot. The default value is 1
Scores are bounded to between 0 and 1. For higher contributions, wrap the query in a BoostQuery
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final IntervalsSource
private final IntervalScoreFunction
-
Constructor Summary
ConstructorsModifierConstructorDescriptionIntervalQuery
(String field, IntervalsSource intervalsSource) Create a new IntervalQueryIntervalQuery
(String field, IntervalsSource intervalsSource, float pivot) Create a new IntervalQuery with a scoring pivotIntervalQuery
(String field, IntervalsSource intervalsSource, float pivot, float exp) Create a new IntervalQuery with a scoring pivot and exponentprivate
IntervalQuery
(String field, IntervalsSource intervalsSource, IntervalScoreFunction scoreFunction) -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.getField()
The field to queryint
hashCode()
Override and implement query hash code properly in a subclass.Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit
(QueryVisitor visitor) Recurse through the query tree, visiting any child queries.
-
Field Details
-
field
-
intervalsSource
-
scoreFunction
-
-
Constructor Details
-
IntervalQuery
Create a new IntervalQuery- Parameters:
field
- the field to queryintervalsSource
- anIntervalsSource
to retrieve intervals from
-
IntervalQuery
Create a new IntervalQuery with a scoring pivot- Parameters:
field
- the field to queryintervalsSource
- anIntervalsSource
to retrieve intervals frompivot
- the sloppy frequency value at which the score will be 0.5, must be within (0, +Infinity)
-
IntervalQuery
Create a new IntervalQuery with a scoring pivot and exponent- Parameters:
field
- the field to queryintervalsSource
- anIntervalsSource
to retrieve intervals frompivot
- the sloppy frequency value at which the score will be 0.5, must be within (0, +Infinity)exp
- exponent, higher values make the function grow slower before 'pivot' and faster after 'pivot', must be in (0, +Infinity)
-
IntervalQuery
private IntervalQuery(String field, IntervalsSource intervalsSource, IntervalScoreFunction scoreFunction)
-
-
Method Details
-
getField
The field to query -
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
- Parameters:
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries. -
equals
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.
-
hashCode
public int hashCode()Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.
-