org.elasticsearch.index.analysis.PreConfiguredCharFilter 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.CharFilter;
import org.apache.lucene.analysis.TokenFilter;
import org.elasticsearch.Version;
import org.elasticsearch.indices.analysis.PreBuiltCacheFactory.CachingStrategy;
import java.io.Reader;
import java.util.function.BiFunction;
import java.util.function.Function;
/**
* Provides pre-configured, shared {@link CharFilter}s.
*/
public class PreConfiguredCharFilter extends PreConfiguredAnalysisComponent {
/**
* Create a pre-configured char filter that may not vary at all.
*/
public static PreConfiguredCharFilter singleton(String name, boolean useFilterForMultitermQueries, Function create) {
return new PreConfiguredCharFilter(
name,
CachingStrategy.ONE,
useFilterForMultitermQueries,
(reader, version) -> create.apply(reader)
);
}
/**
* Create a pre-configured char filter that may not vary at all, provide access to the elasticsearch version
*/
public static PreConfiguredCharFilter singletonWithVersion(
String name,
boolean useFilterForMultitermQueries,
BiFunction create
) {
return new PreConfiguredCharFilter(
name,
CachingStrategy.ONE,
useFilterForMultitermQueries,
(reader, version) -> create.apply(reader, version)
);
}
/**
* Create a pre-configured token filter that may vary based on the Lucene version.
*/
public static PreConfiguredCharFilter luceneVersion(
String name,
boolean useFilterForMultitermQueries,
BiFunction create
) {
return new PreConfiguredCharFilter(
name,
CachingStrategy.LUCENE,
useFilterForMultitermQueries,
(reader, version) -> create.apply(reader, version.luceneVersion)
);
}
/**
* Create a pre-configured token filter that may vary based on the Elasticsearch version.
*/
public static PreConfiguredCharFilter elasticsearchVersion(
String name,
boolean useFilterForMultitermQueries,
BiFunction create
) {
return new PreConfiguredCharFilter(name, CachingStrategy.ELASTICSEARCH, useFilterForMultitermQueries, create);
}
private final boolean useFilterForMultitermQueries;
private final BiFunction create;
protected PreConfiguredCharFilter(
String name,
CachingStrategy cache,
boolean useFilterForMultitermQueries,
BiFunction create
) {
super(name, cache);
this.useFilterForMultitermQueries = useFilterForMultitermQueries;
this.create = create;
}
/**
* Can this {@link TokenFilter} be used in multi-term queries?
*/
public boolean shouldUseFilterForMultitermQueries() {
return useFilterForMultitermQueries;
}
@Override
protected CharFilterFactory create(Version version) {
if (useFilterForMultitermQueries) {
return new NormalizingCharFilterFactory() {
@Override
public String name() {
return getName();
}
@Override
public Reader create(Reader reader) {
return create.apply(reader, version);
}
};
}
return new CharFilterFactory() {
@Override
public Reader create(Reader reader) {
return create.apply(reader, version);
}
@Override
public String name() {
return getName();
}
};
}
}