Constructor Detail

• WeightedSpanTermExtractor

  public WeightedSpanTermExtractor()

• WeightedSpanTermExtractor

  public WeightedSpanTermExtractor(java.lang.String defaultField)

Method Detail

• getWeightedSpanTerms

  public java.util.Map getWeightedSpanTerms(Query query,
                                            TokenStream tokenStream)
                                     throws java.io.IOException

  Creates a Map of WeightedSpanTerms from the given Query and TokenStream.

  Parameters:

  query - that caused hit

  tokenStream - of text to be highlighted

  Returns:

  Map containing WeightedSpanTerms

  Throws:

  java.io.IOException

• getWeightedSpanTerms

  public java.util.Map getWeightedSpanTerms(Query query,
                                            TokenStream tokenStream,
                                            java.lang.String fieldName)
                                     throws java.io.IOException

  Creates a Map of WeightedSpanTerms from the given Query and TokenStream.

  Parameters:

  query - that caused hit

  tokenStream - of text to be highlighted

  fieldName - restricts Term's used based on field name

  Returns:

  Map containing WeightedSpanTerms

  Throws:

  java.io.IOException

• getWeightedSpanTermsWithScores

  public java.util.Map getWeightedSpanTermsWithScores(Query query,
                                                      TokenStream tokenStream,
                                                      java.lang.String fieldName,
                                                      IndexReader reader)
                                               throws java.io.IOException

  Creates a Map of WeightedSpanTerms from the given Query and TokenStream. Uses a supplied IndexReader to properly weight terms (for gradient highlighting).

  Parameters:

  query - that caused hit

  tokenStream - of text to be highlighted

  fieldName - restricts Term's used based on field name

  reader - to use for scoring

  Returns:

  Map of WeightedSpanTerms with quasi tf/idf scores

  Throws:

  java.io.IOException

• getExpandMultiTermQuery

  public boolean getExpandMultiTermQuery()

• setExpandMultiTermQuery

  public void setExpandMultiTermQuery(boolean expandMultiTermQuery)

• isCachedTokenStream

  public boolean isCachedTokenStream()

• getTokenStream

  public TokenStream getTokenStream()

• setWrapIfNotCachingTokenFilter

  public void setWrapIfNotCachingTokenFilter(boolean wrap)

  By default, TokenStreams that are not of the type CachingTokenFilter are wrapped in a CachingTokenFilter to ensure an efficient reset - if you are already using a different caching TokenStream impl and you don't want it to be wrapped, set this to false.

  Parameters:

  wrap -