Skip to content

Commit

Permalink
HSEARCH-2219 Make analyzer strategy an interface implemented by index…
Browse files Browse the repository at this point in the history
…ing services

This will allow to use implementation-specific analyzer types in
Elasticsearch, giving us more space for handling analyzer definitions.
  • Loading branch information
yrodiere authored and Sanne committed Dec 19, 2016
1 parent 3b0344d commit f1abd39
Show file tree
Hide file tree
Showing 42 changed files with 582 additions and 375 deletions.
@@ -0,0 +1,73 @@
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.elasticsearch.analyzer.impl;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.hibernate.search.analyzer.impl.LazyRemoteAnalyzer;
import org.hibernate.search.analyzer.impl.RemoteAnalyzer;
import org.hibernate.search.analyzer.impl.RemoteAnalyzerReference;
import org.hibernate.search.analyzer.spi.AnalyzerStrategy;
import org.hibernate.search.annotations.AnalyzerDef;


/**
* @author Yoann Rodiere
*/
public class ElasticsearchAnalyzerStrategy implements AnalyzerStrategy<RemoteAnalyzerReference> {

@Override
public RemoteAnalyzerReference createDefaultAnalyzerReference() {
return new RemoteAnalyzerReference( new RemoteAnalyzer( "default" ) );
}

@Override
public RemoteAnalyzerReference createPassThroughAnalyzerReference() {
return new RemoteAnalyzerReference( new RemoteAnalyzer( "keyword" ) );
}

@Override
public RemoteAnalyzerReference createAnalyzerReference(String name) {
return new RemoteAnalyzerReference( new LazyRemoteAnalyzer( name ) );
}

@Override
public RemoteAnalyzerReference createAnalyzerReference(Class<?> analyzerClass) {
return null;
}

@Override
public void initializeNamedAnalyzerReferences(Collection<RemoteAnalyzerReference> references, Map<String, AnalyzerDef> analyzerDefinitions) {
Map<String, RemoteAnalyzer> initializedAnalyzers = new HashMap<>();
for ( RemoteAnalyzerReference reference : references ) {
initializeReference( initializedAnalyzers, reference, analyzerDefinitions );
}
}


private void initializeReference(Map<String, RemoteAnalyzer> initializedAnalyzers, RemoteAnalyzerReference analyzerReference,
Map<String, AnalyzerDef> analyzerDefinitions) {
LazyRemoteAnalyzer lazyAnalyzer = (LazyRemoteAnalyzer) analyzerReference.getAnalyzer();

String name = lazyAnalyzer.getName();
RemoteAnalyzer delegate = initializedAnalyzers.get( name );

if ( delegate == null ) {
// TODO HSEARCH-2219 Actually use the definition
delegate = buildAnalyzer( name );
initializedAnalyzers.put( name, delegate );
}

lazyAnalyzer.setDelegate( delegate );
}

private RemoteAnalyzer buildAnalyzer(String name) {
return new RemoteAnalyzer( name );
}
}
Expand Up @@ -12,7 +12,7 @@
import org.apache.lucene.search.Filter;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.SortField;
import org.hibernate.search.analyzer.impl.AnalyzerReference;
import org.hibernate.search.analyzer.spi.AnalyzerReference;
import org.hibernate.search.elasticsearch.client.impl.BackendRequest;
import org.hibernate.search.elasticsearch.client.impl.BulkRequestFailedException;
import org.hibernate.search.elasticsearch.schema.impl.ElasticsearchSchemaValidationException;
Expand Down
Expand Up @@ -13,7 +13,7 @@
import java.util.Set;

import org.apache.lucene.document.Field;
import org.hibernate.search.analyzer.impl.AnalyzerReference;
import org.hibernate.search.analyzer.spi.AnalyzerReference;
import org.hibernate.search.annotations.Store;
import org.hibernate.search.bridge.spi.NullMarker;
import org.hibernate.search.elasticsearch.bridge.builtin.impl.ElasticsearchBridgeDefinedField;
Expand Down
Expand Up @@ -8,8 +8,8 @@

import java.util.Map;

import org.hibernate.search.analyzer.impl.AnalyzerReference;
import org.hibernate.search.analyzer.impl.RemoteAnalyzerReference;
import org.hibernate.search.analyzer.spi.AnalyzerReference;
import org.hibernate.search.elasticsearch.logging.impl.Log;
import org.hibernate.search.elasticsearch.schema.impl.model.DataType;
import org.hibernate.search.elasticsearch.schema.impl.model.PropertyMapping;
Expand Down
Expand Up @@ -6,14 +6,15 @@
*/
package org.hibernate.search.elasticsearch.spi;

import org.hibernate.search.analyzer.impl.RemoteAnalyzer;
import org.hibernate.search.analyzer.impl.RemoteAnalyzerProvider;
import org.hibernate.search.analyzer.spi.AnalyzerStrategy;
import org.hibernate.search.cfg.spi.SearchConfiguration;
import org.hibernate.search.elasticsearch.analyzer.impl.ElasticsearchAnalyzerStrategy;
import org.hibernate.search.elasticsearch.nulls.impl.ElasticsearchMissingValueStrategy;
import org.hibernate.search.engine.nulls.impl.MissingValueStrategy;
import org.hibernate.search.indexes.spi.AnalyzerExecutionStrategy;
import org.hibernate.search.engine.service.spi.ServiceManager;
import org.hibernate.search.indexes.spi.IndexManagerType;

public final class ElasticsearchIndexManagerType implements IndexManagerType, RemoteAnalyzerProvider {
public final class ElasticsearchIndexManagerType implements IndexManagerType {

public static final ElasticsearchIndexManagerType INSTANCE = new ElasticsearchIndexManagerType();

Expand All @@ -22,17 +23,12 @@ private ElasticsearchIndexManagerType() {
}

@Override
public AnalyzerExecutionStrategy getAnalyzerExecutionStrategy() {
return AnalyzerExecutionStrategy.REMOTE;
public AnalyzerStrategy<?> createAnalyzerStrategy(ServiceManager serviceManager, SearchConfiguration cfg) {
return new ElasticsearchAnalyzerStrategy();
}

@Override
public MissingValueStrategy getMissingValueStrategy() {
return ElasticsearchMissingValueStrategy.INSTANCE;
}

@Override
public RemoteAnalyzer getRemoteAnalyzer(String name) {
return new RemoteAnalyzer( name );
}
}
Expand Up @@ -4,7 +4,7 @@
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.engine.impl;
package org.hibernate.search.analyzer.impl;

import java.io.IOException;
import java.util.HashMap;
Expand All @@ -22,6 +22,7 @@
import org.hibernate.search.annotations.Parameter;
import org.hibernate.search.annotations.TokenFilterDef;
import org.hibernate.search.annotations.TokenizerDef;
import org.hibernate.search.engine.impl.TokenizerChain;
import org.hibernate.search.engine.service.spi.ServiceManager;
import org.hibernate.search.util.impl.HibernateSearchResourceLoader;

Expand All @@ -33,11 +34,11 @@
* @author Emmanuel Bernard
* @author Hardy Ferentschik
*/
final class AnalyzerBuilder {
final class LuceneAnalyzerBuilder {

private static final String LUCENE_VERSION_PARAM = "luceneMatchVersion";

private AnalyzerBuilder() {
private LuceneAnalyzerBuilder() {
}

/**
Expand Down
Expand Up @@ -7,7 +7,7 @@
package org.hibernate.search.analyzer.impl;

import org.apache.lucene.analysis.Analyzer;
import org.hibernate.search.util.impl.PassThroughAnalyzer;
import org.hibernate.search.analyzer.spi.AnalyzerReference;

/**
* A reference to an {@link Analyzer}.
Expand All @@ -16,12 +16,6 @@
*/
public class LuceneAnalyzerReference implements AnalyzerReference {

/**
* Analyzer that applies no operation whatsoever to the flux.
* This is useful for queries operating on non tokenized fields.
*/
public static final LuceneAnalyzerReference PASS_THROUGH = new LuceneAnalyzerReference( PassThroughAnalyzer.INSTANCE );

private final Analyzer analyzer;

public LuceneAnalyzerReference(Analyzer analyzer) {
Expand Down
@@ -0,0 +1,153 @@
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.analyzer.impl;

import java.io.IOException;
import java.text.ParseException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.util.Version;
import org.hibernate.search.analyzer.spi.AnalyzerStrategy;
import org.hibernate.search.annotations.AnalyzerDef;
import org.hibernate.search.cfg.Environment;
import org.hibernate.search.cfg.spi.SearchConfiguration;
import org.hibernate.search.util.StringHelper;
import org.hibernate.search.util.impl.ClassLoaderHelper;
import org.hibernate.search.util.impl.PassThroughAnalyzer;
import org.hibernate.search.util.logging.impl.Log;
import org.hibernate.search.util.logging.impl.LoggerFactory;
import org.hibernate.search.engine.service.spi.ServiceManager;
import org.hibernate.search.exception.SearchException;


/**
* @author Yoann Rodiere
*/
public class LuceneEmbeddedAnalyzerStrategy implements AnalyzerStrategy<LuceneAnalyzerReference> {

private static final Log log = LoggerFactory.make();

private final ServiceManager serviceManager;

private final SearchConfiguration cfg;

private final Version luceneMatchVersion;

public LuceneEmbeddedAnalyzerStrategy(ServiceManager serviceManager, SearchConfiguration cfg) {
this.serviceManager = serviceManager;
this.cfg = cfg;
this.luceneMatchVersion = getLuceneMatchVersion( cfg );
}

private Version getLuceneMatchVersion(SearchConfiguration cfg) {
final Version version;
String tmp = cfg.getProperty( Environment.LUCENE_MATCH_VERSION );
if ( StringHelper.isEmpty( tmp ) ) {
log.recommendConfiguringLuceneVersion();
version = Environment.DEFAULT_LUCENE_MATCH_VERSION;
}
else {
try {
version = Version.parseLeniently( tmp );
if ( log.isDebugEnabled() ) {
log.debug( "Setting Lucene compatibility to Version " + version );
}
}
catch (IllegalArgumentException e) {
throw log.illegalLuceneVersionFormat( tmp, e.getMessage() );
}
catch (ParseException e) {
throw log.illegalLuceneVersionFormat( tmp, e.getMessage() );
}
}
return version;
}

@SuppressWarnings("unchecked")
@Override
public LuceneAnalyzerReference createDefaultAnalyzerReference() {
Class<? extends Analyzer> analyzerClass;
String analyzerClassName = cfg.getProperty( Environment.ANALYZER_CLASS );
if ( analyzerClassName != null ) {
try {
analyzerClass = ClassLoaderHelper.classForName( analyzerClassName, serviceManager );
}
catch (Exception e) {
// Maybe the string refers to an analyzer definition instead?
return createAnalyzerReference( analyzerClassName );
}
}
else {
analyzerClass = StandardAnalyzer.class;
}
return createAnalyzerReference( analyzerClass );
}

@Override
public LuceneAnalyzerReference createPassThroughAnalyzerReference() {
return new LuceneAnalyzerReference( PassThroughAnalyzer.INSTANCE );
}

@Override
public LuceneAnalyzerReference createAnalyzerReference(Class<?> analyzerClass) {
try {
Analyzer analyzer = ClassLoaderHelper.analyzerInstanceFromClass( analyzerClass, luceneMatchVersion );
return new LuceneAnalyzerReference( analyzer );
}
catch (ClassCastException e) {
throw new SearchException( "Lucene analyzer does not extend " + Analyzer.class.getName() + ": " + analyzerClass.getName(), e );
}
catch (Exception e) {
throw new SearchException( "Failed to instantiate lucene analyzer with type " + analyzerClass.getName(), e );
}
}

@Override
public LuceneAnalyzerReference createAnalyzerReference(String name) {
return new LuceneAnalyzerReference( new LazyLuceneAnalyzer( name ) );
}

@Override
public void initializeNamedAnalyzerReferences(Collection<LuceneAnalyzerReference> references, Map<String, AnalyzerDef> analyzerDefinitions) {
Map<String, Analyzer> initializedAnalyzers = new HashMap<>();
for ( LuceneAnalyzerReference reference : references ) {
initializeReference( initializedAnalyzers, reference, analyzerDefinitions );
}
}

private void initializeReference(Map<String, Analyzer> initializedAnalyzers, LuceneAnalyzerReference analyzerReference,
Map<String, AnalyzerDef> analyzerDefinitions) {
LazyLuceneAnalyzer lazyAnalyzer = (LazyLuceneAnalyzer) analyzerReference.getAnalyzer();

String name = lazyAnalyzer.getName();
Analyzer delegate = initializedAnalyzers.get( name );

if ( delegate == null ) {
AnalyzerDef analyzerDefinition = analyzerDefinitions.get( name );
if ( analyzerDefinition == null ) {
throw new SearchException( "Lucene analyzer found with an unknown definition: " + name );
}
delegate = buildAnalyzer( analyzerDefinition );
initializedAnalyzers.put( name, delegate );
}

lazyAnalyzer.setDelegate( delegate );
}

private Analyzer buildAnalyzer(AnalyzerDef analyzerDefinition) {
try {
return LuceneAnalyzerBuilder.buildAnalyzer( analyzerDefinition, luceneMatchVersion, serviceManager );
}
catch (IOException e) {
throw new SearchException( "Could not initialize Analyzer definition " + analyzerDefinition, e );
}
}
}

This file was deleted.

Expand Up @@ -6,6 +6,8 @@
*/
package org.hibernate.search.analyzer.impl;

import org.hibernate.search.analyzer.spi.AnalyzerReference;

/**
* A reference to a {@code RemoteAnalyzer}.
*
Expand All @@ -14,9 +16,6 @@
*/
public final class RemoteAnalyzerReference implements AnalyzerReference {

public static final RemoteAnalyzerReference DEFAULT = new RemoteAnalyzerReference( new LazyRemoteAnalyzer( "default" ) );
public static final RemoteAnalyzerReference PASS_THROUGH = new RemoteAnalyzerReference( new LazyRemoteAnalyzer( "keyword" ) );

private RemoteAnalyzer analyzer;

public RemoteAnalyzerReference(RemoteAnalyzer analyzer) {
Expand Down

0 comments on commit f1abd39

Please sign in to comment.