org.hibernate.search.backend.lucene.LuceneBackend Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-backend-lucene Show documentation

Hibernate Search Backend relying on embedded instances of Lucene

The newest version!

/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.backend.lucene;

import java.util.Optional;

import org.hibernate.search.engine.backend.Backend;
import org.hibernate.search.engine.backend.metamodel.IndexValueFieldTypeDescriptor;

import org.apache.lucene.analysis.Analyzer;

public interface LuceneBackend extends Backend {

	/**
	 * @param name An analyzer name, e.g. a name returned by {@link IndexValueFieldTypeDescriptor#analyzerName()}
	 * or {@link IndexValueFieldTypeDescriptor#searchAnalyzerName()}.
	 * @return The corresponding analyzer, or {@link Optional#empty()} if it doesn't exist.
	 */
	Optional analyzer(String name);

	/**
	 * @param name A normalizer name, e.g. a name returned by {@link IndexValueFieldTypeDescriptor#normalizerName()}.
	 * @return The corresponding normalizer, or {@link Optional#empty()} if it doesn't exist.
	 */
	Optional normalizer(String name);

}