org.apache.solr.schema.SimilarityFactory Maven / Gradle / Ivy
Show all versions of solr-core Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.schema;
import org.apache.lucene.search.similarities.Similarity;
import org.apache.solr.common.util.SimpleOrderedMap;
import org.apache.solr.common.params.SolrParams;
import java.util.Iterator;
/**
* A factory interface for configuring a {@link Similarity} in the Solr
* schema.xml.
*
*
* Subclasses of SimilarityFactory
which are {@link 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 FieldType#getSimilarity
*/
public abstract class SimilarityFactory {
public static final String CLASS_NAME = "class";
protected SolrParams params;
public void init(SolrParams params) { this.params = params; }
public SolrParams getParams() { return params; }
public abstract Similarity getSimilarity();
/** Returns a serializable description of this similarity(factory) */
public SimpleOrderedMap