Class QueryTermExtractor
- java.lang.Object
-
- org.apache.lucene.search.highlight.QueryTermExtractor
-
public final class QueryTermExtractor extends java.lang.Object
Utility class used to extract the terms used in a query, plus any weights. This class will not find terms for MultiTermQuery, TermRangeQuery and PrefixQuery classes so the caller must pass a rewritten query (see Query.rewrite) to obtain a list of expanded terms.
-
-
Constructor Summary
Constructors Constructor Description QueryTermExtractor()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static WeightedTerm[]
getIdfWeightedTerms(Query query, IndexReader reader, java.lang.String fieldName)
Extracts all terms texts of a given Query into an array of WeightedTermsstatic WeightedTerm[]
getTerms(Query query)
Extracts all terms texts of a given Query into an array of WeightedTermsstatic WeightedTerm[]
getTerms(Query query, boolean prohibited)
Extracts all terms texts of a given Query into an array of WeightedTermsstatic WeightedTerm[]
getTerms(Query query, boolean prohibited, java.lang.String fieldName)
Extracts all terms texts of a given Query into an array of WeightedTerms
-
-
-
Method Detail
-
getTerms
public static final WeightedTerm[] getTerms(Query query)
Extracts all terms texts of a given Query into an array of WeightedTerms- Parameters:
query
- Query to extract term texts from- Returns:
- an array of the terms used in a query, plus their weights.
-
getIdfWeightedTerms
public static final WeightedTerm[] getIdfWeightedTerms(Query query, IndexReader reader, java.lang.String fieldName)
Extracts all terms texts of a given Query into an array of WeightedTerms- Parameters:
query
- Query to extract term texts fromreader
- used to compute IDF which can be used to a) score selected fragments better b) use graded highlights eg changing intensity of font colorfieldName
- the field on which Inverse Document Frequency (IDF) calculations are based- Returns:
- an array of the terms used in a query, plus their weights.
-
getTerms
public static final WeightedTerm[] getTerms(Query query, boolean prohibited, java.lang.String fieldName)
Extracts all terms texts of a given Query into an array of WeightedTerms- Parameters:
query
- Query to extract term texts fromprohibited
-true
to extract "prohibited" terms, toofieldName
- The fieldName used to filter query terms- Returns:
- an array of the terms used in a query, plus their weights.
-
getTerms
public static final WeightedTerm[] getTerms(Query query, boolean prohibited)
Extracts all terms texts of a given Query into an array of WeightedTerms- Parameters:
query
- Query to extract term texts fromprohibited
-true
to extract "prohibited" terms, too- Returns:
- an array of the terms used in a query, plus their weights.
-
-