Package org.apache.solr.schema

Class SimilarityFactory

java.lang.Object

org.apache.solr.schema.SimilarityFactory

Direct Known Subclasses:

BM25SimilarityFactory, BooleanSimilarityFactory, ClassicSimilarityFactory, DFISimilarityFactory, DFRSimilarityFactory, IBSimilarityFactory, LMDirichletSimilarityFactory, LMJelinekMercerSimilarityFactory, RawTFSimilarityFactory, SchemaSimilarityFactory

public abstract class SimilarityFactory
extends Object

A factory interface for configuring a Similarity in the Solr schema.xml.

Subclasses of SimilarityFactory which are SchemaAware must take responsibility for either consulting the similarities configured on individual field types, or generating appropriate error/warning messages if field type specific similarities exist but are being ignored. The IndexSchema will provide such error checking if a non- SchemaAware instance of SimilarityFactory is used.

See Also:

• FieldType.getSimilarity()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_NAME
protected org.apache.solr.common.params.SolrParams	params

Constructor Summary

Constructors

Constructor	Description
SimilarityFactory()

Method Summary

Modifier and Type	Method	Description
String	getClassArg()
org.apache.solr.common.util.SimpleOrderedMap<Object>	getNamedPropertyValues()	Returns a serializable description of this similarity(factory)
org.apache.solr.common.params.SolrParams	getParams()
abstract org.apache.lucene.search.similarities.Similarity	getSimilarity()
void	init(org.apache.solr.common.params.SolrParams params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLASS_NAME

public static final String CLASS_NAME

See Also:

• Constant Field Values

params

protected org.apache.solr.common.params.SolrParams params

Constructor Details

SimilarityFactory

public SimilarityFactory()

Method Details

init

public void init(org.apache.solr.common.params.SolrParams params)

getParams

public org.apache.solr.common.params.SolrParams getParams()

getSimilarity

public abstract org.apache.lucene.search.similarities.Similarity getSimilarity()

getNamedPropertyValues

public org.apache.solr.common.util.SimpleOrderedMap<Object> getNamedPropertyValues()

Returns a serializable description of this similarity(factory)

getClassArg

public String getClassArg()

Returns:

the string used to specify the concrete class name in a serialized representation: the class arg. If the concrete class name was not specified via a class arg, returns getClass().getName(), unless this class is the anonymous similarity wrapper produced in IndexSchema, in which case the getSimilarity().getClass().getName() is returned.