org.apache.solr.analysis
Class PatternTokenizerFactory

java.lang.Object
  extended by org.apache.solr.analysis.BaseTokenizerFactory
      extended by org.apache.solr.analysis.PatternTokenizerFactory
All Implemented Interfaces:
TokenizerFactory

public class PatternTokenizerFactory
extends BaseTokenizerFactory

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.

Since:
solr1.2
Version:
$Id:$
See Also:
PatternTokenizer

Field Summary
protected  Map<String,String> args
           
protected  int group
           
static String GROUP
           
protected  Pattern pattern
           
static String PATTERN
           
 
Fields inherited from class org.apache.solr.analysis.BaseTokenizerFactory
log
 
Constructor Summary
PatternTokenizerFactory()
           
 
Method Summary
 Tokenizer create(Reader in)
          Split the input using configured pattern
static List<Token> group(Matcher matcher, String input, int group)
          Deprecated.  
 void init(Map<String,String> args)
          Require a configured pattern
static List<Token> split(Matcher matcher, String input)
          Deprecated.  
 
Methods inherited from class org.apache.solr.analysis.BaseTokenizerFactory
getArgs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PATTERN

public static final String PATTERN
See Also:
Constant Field Values

GROUP

public static final String GROUP
See Also:
Constant Field Values

args

protected Map<String,String> args

pattern

protected Pattern pattern

group

protected int group
Constructor Detail

PatternTokenizerFactory

public PatternTokenizerFactory()
Method Detail

init

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

Specified by:
init in interface TokenizerFactory
Overrides:
init in class BaseTokenizerFactory

create

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


split

@Deprecated
public static List<Token> split(Matcher matcher,
                                           String input)
Deprecated. 

This behaves just like String.split( ), but returns a list of Tokens rather then an array of strings NOTE: This method is not used in 1.4.


group

@Deprecated
public static List<Token> group(Matcher matcher,
                                           String input,
                                           int group)
Deprecated. 

Create tokens from the matches in a matcher NOTE: This method is not used in 1.4.



Copyright © 2011 Apache Software Foundation. All Rights Reserved.