org.apache.lucene.analysis.pattern.SimplePatternTokenizerFactory Maven / Gradle / Ivy
/*
* 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.lucene.analysis.pattern;
import java.util.Map;
import org.apache.lucene.analysis.util.TokenizerFactory;
import org.apache.lucene.util.AttributeFactory;
import org.apache.lucene.util.automaton.Automaton;
import org.apache.lucene.util.automaton.Operations;
import org.apache.lucene.util.automaton.RegExp;
/**
* Factory for {@link SimplePatternTokenizer}, for matching tokens based on the provided regexp.
*
* This tokenizer uses Lucene {@link RegExp} pattern matching to construct distinct tokens
* for the input stream. The syntax is more limited than {@link PatternTokenizer}, but the
* tokenization is quite a bit faster. It takes two arguments:
*
*
* - "pattern" (required) is the regular expression, according to the syntax described at {@link RegExp}
* - "determinizeWorkLimit" (optional, default 10000) the limit on total effort spent to
* determinize the automaton computed from the regexp
*
*
* The pattern matches the characters to include in a token (not the split characters), and the
* matching is greedy such that the longest token matching at a given point is created. Empty
* tokens are never created.
*
*
For example, to match tokens delimited by simple whitespace characters:
*
*
* <fieldType name="text_ptn" class="solr.TextField" positionIncrementGap="100">
* <analyzer>
* <tokenizer class="solr.SimplePatternTokenizerFactory" pattern="[^ \t\r\n]+"/>
* </analyzer>
* </fieldType>
*
* @lucene.experimental
*
* @see SimplePatternTokenizer
*
* @since 6.5.0
* @lucene.spi {@value #NAME}
*/
public class SimplePatternTokenizerFactory extends TokenizerFactory {
/** SPI name */
public static final String NAME = "simplePattern";
public static final String PATTERN = "pattern";
private final Automaton dfa;
private final int determinizeWorkLimit;
/** Creates a new SimplePatternTokenizerFactory */
public SimplePatternTokenizerFactory(Map args) {
super(args);
determinizeWorkLimit =
getInt(args, "determinizeWorkLimit", Operations.DEFAULT_DETERMINIZE_WORK_LIMIT);
dfa = Operations.determinize(new RegExp(require(args, PATTERN)).toAutomaton(), determinizeWorkLimit);
if (args.isEmpty() == false) {
throw new IllegalArgumentException("Unknown parameters: " + args);
}
}
@Override
public SimplePatternTokenizer create(final AttributeFactory factory) {
return new SimplePatternTokenizer(factory, dfa);
}
}