org.elasticsearch.index.analysis.PreConfiguredTokenFilter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.index.analysis;
import org.apache.lucene.analysis.TokenFilter;
import org.apache.lucene.analysis.TokenStream;
import org.elasticsearch.Version;
import org.elasticsearch.indices.analysis.PreBuiltCacheFactory;
import org.elasticsearch.indices.analysis.PreBuiltCacheFactory.CachingStrategy;
import java.util.function.BiFunction;
import java.util.function.Function;
/**
* Provides pre-configured, shared {@link TokenFilter}s.
*/
public final class PreConfiguredTokenFilter extends PreConfiguredAnalysisComponent {
/**
* Create a pre-configured token filter that may not vary at all.
*/
public static PreConfiguredTokenFilter singleton(
String name,
boolean useFilterForMultitermQueries,
Function create
) {
return new PreConfiguredTokenFilter(
name,
useFilterForMultitermQueries,
true,
CachingStrategy.ONE,
(tokenStream, version) -> create.apply(tokenStream)
);
}
/**
* Create a pre-configured token filter that may not vary at all.
*/
public static PreConfiguredTokenFilter singleton(
String name,
boolean useFilterForMultitermQueries,
boolean allowForSynonymParsing,
Function create
) {
return new PreConfiguredTokenFilter(
name,
useFilterForMultitermQueries,
allowForSynonymParsing,
CachingStrategy.ONE,
(tokenStream, version) -> create.apply(tokenStream)
);
}
/**
* Create a pre-configured token filter that may vary based on the Lucene version.
*/
public static PreConfiguredTokenFilter luceneVersion(
String name,
boolean useFilterForMultitermQueries,
BiFunction create
) {
return new PreConfiguredTokenFilter(
name,
useFilterForMultitermQueries,
true,
CachingStrategy.LUCENE,
(tokenStream, version) -> create.apply(tokenStream, version.luceneVersion)
);
}
/**
* Create a pre-configured token filter that may vary based on the Elasticsearch version.
*/
public static PreConfiguredTokenFilter elasticsearchVersion(
String name,
boolean useFilterForMultitermQueries,
BiFunction create
) {
return new PreConfiguredTokenFilter(name, useFilterForMultitermQueries, true, CachingStrategy.ELASTICSEARCH, create);
}
/**
* Create a pre-configured token filter that may vary based on the Elasticsearch version.
*/
public static PreConfiguredTokenFilter elasticsearchVersion(
String name,
boolean useFilterForMultitermQueries,
boolean useFilterForParsingSynonyms,
BiFunction create
) {
return new PreConfiguredTokenFilter(
name,
useFilterForMultitermQueries,
useFilterForParsingSynonyms,
CachingStrategy.ELASTICSEARCH,
create
);
}
private final boolean useFilterForMultitermQueries;
private final boolean allowForSynonymParsing;
private final BiFunction create;
private PreConfiguredTokenFilter(
String name,
boolean useFilterForMultitermQueries,
boolean allowForSynonymParsing,
PreBuiltCacheFactory.CachingStrategy cache,
BiFunction create
) {
super(name, cache);
this.useFilterForMultitermQueries = useFilterForMultitermQueries;
this.allowForSynonymParsing = allowForSynonymParsing;
this.create = create;
}
/**
* Can this {@link TokenFilter} be used in multi-term queries?
*/
public boolean shouldUseFilterForMultitermQueries() {
return useFilterForMultitermQueries;
}
@Override
protected TokenFilterFactory create(Version version) {
if (useFilterForMultitermQueries) {
return new NormalizingTokenFilterFactory() {
@Override
public TokenStream normalize(TokenStream tokenStream) {
return create.apply(tokenStream, version);
}
@Override
public String name() {
return getName();
}
@Override
public TokenStream create(TokenStream tokenStream) {
return create.apply(tokenStream, version);
}
@Override
public TokenFilterFactory getSynonymFilter() {
if (allowForSynonymParsing) {
return this;
}
throw new IllegalArgumentException("Token filter [" + name() + "] cannot be used to parse synonyms");
}
};
}
return new TokenFilterFactory() {
@Override
public String name() {
return getName();
}
@Override
public TokenStream create(TokenStream tokenStream) {
return create.apply(tokenStream, version);
}
@Override
public TokenFilterFactory getSynonymFilter() {
if (allowForSynonymParsing) {
return this;
}
throw new IllegalArgumentException("Token filter [" + name() + "] cannot be used to parse synonyms");
}
};
}
}