Class PatternTokenizerFactory

  extended by org.apache.lucene.analysis.util.AbstractAnalysisFactory
      extended by org.apache.lucene.analysis.util.TokenizerFactory
          extended by org.apache.lucene.analysis.pattern.PatternTokenizerFactory

public class PatternTokenizerFactory
extends TokenizerFactory

Factory for PatternTokenizer. This tokenizer uses regex pattern matching to construct distinct tokens for the input stream. It takes two arguments: "pattern" and "group".

group=-1 (the default) is equivalent to "split". In this case, the tokens will be equivalent to the output from (without empty tokens): String.split(java.lang.String)

Using group >= 0 selects the matching group as the token. For example, if you have:

  pattern = \'([^\']+)\'
  group = 0
  input = aaa 'bbb' 'ccc'
the output will be two tokens: 'bbb' and 'ccc' (including the ' marks). With the same input but using group=1, the output would be: bbb and ccc (no ' marks)

NOTE: This Tokenizer does not output tokens that are of zero length.

 <fieldType name="text_ptn" class="solr.TextField" positionIncrementGap="100">
     <tokenizer class="solr.PatternTokenizerFactory" pattern="\'([^\']+)\'" group="1"/>

See Also:

Field Summary
protected  int group
static String GROUP
protected  Pattern pattern
static String PATTERN
Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
args, luceneMatchVersion
Constructor Summary
Method Summary
 Tokenizer create(Reader in)
          Split the input using configured pattern
 void init(Map<String,String> args)
          Require a configured pattern
Methods inherited from class org.apache.lucene.analysis.util.TokenizerFactory
availableTokenizers, forName, lookupClass, reloadTokenizers
Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSnowballWordSet, getWordSet, setLuceneMatchVersion, splitFileNames
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail


public static final String PATTERN
See Also:
Constant Field Values


public static final String GROUP
See Also:
Constant Field Values


protected Pattern pattern


protected int group
Constructor Detail


public PatternTokenizerFactory()
Method Detail


public void init(Map<String,String> args)
Require a configured pattern

init in class AbstractAnalysisFactory


public Tokenizer create(Reader in)
Split the input using configured pattern

Specified by:
create in class TokenizerFactory

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.