org.apache.solr.spelling
Class SpellingOptions

java.lang.Object
  extended by org.apache.solr.spelling.SpellingOptions

public class SpellingOptions
extends Object


Field Summary
 float accuracy
          Optionally restrict the results to have a minimum accuracy level.
 int count
          The number of suggestions to return, if there are any.
 SolrParams customParams
          Any other custom params can be passed through.
 boolean extendedResults
          Provide additional, per implementation, information about the results
 boolean onlyMorePopular
          Return only those results that are more popular, as defined by the implementation
 org.apache.lucene.index.IndexReader reader
          An optional IndexReader
 Collection<org.apache.lucene.analysis.Token> tokens
          The tokens to spell check
 
Constructor Summary
SpellingOptions()
           
SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens, org.apache.lucene.index.IndexReader reader)
           
SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens, org.apache.lucene.index.IndexReader reader, int count)
           
SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens, org.apache.lucene.index.IndexReader reader, int count, boolean onlyMorePopular, boolean extendedResults, float accuracy, SolrParams customParams)
           
SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens, int count)
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tokens

public Collection<org.apache.lucene.analysis.Token> tokens
The tokens to spell check


reader

public org.apache.lucene.index.IndexReader reader
An optional IndexReader


count

public int count
The number of suggestions to return, if there are any. Defaults to 1.


onlyMorePopular

public boolean onlyMorePopular
Return only those results that are more popular, as defined by the implementation


extendedResults

public boolean extendedResults
Provide additional, per implementation, information about the results


accuracy

public float accuracy
Optionally restrict the results to have a minimum accuracy level. Per Implementation. By default set to Float.MIN_VALUE.


customParams

public SolrParams customParams
Any other custom params can be passed through. May be null and is null by default.

Constructor Detail

SpellingOptions

public SpellingOptions()

SpellingOptions

public SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens,
                       int count)

SpellingOptions

public SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens,
                       org.apache.lucene.index.IndexReader reader)

SpellingOptions

public SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens,
                       org.apache.lucene.index.IndexReader reader,
                       int count)

SpellingOptions

public SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens,
                       org.apache.lucene.index.IndexReader reader,
                       int count,
                       boolean onlyMorePopular,
                       boolean extendedResults,
                       float accuracy,
                       SolrParams customParams)


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.