com.atlassian.confluence.search.v2.analysis

Class PatternTokenizerDescriptor

java.lang.Object

com.atlassian.confluence.search.v2.analysis.PatternTokenizerDescriptor

All Implemented Interfaces:

com.atlassian.confluence.plugins.index.api.TokenizerDescriptor

@ExperimentalApi
public class PatternTokenizerDescriptor
extends Object
implements com.atlassian.confluence.plugins.index.api.TokenizerDescriptor

The pattern tokenizer uses a regular expression to either split text into terms whenever it matches a word separator, or to capture matching text as terms.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
PatternTokenizerDescriptor(Pattern pattern, int group)

Method Summary

Modifier and Type	Method and Description
int	getGroup()
Pattern	getPattern()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PatternTokenizerDescriptor

public PatternTokenizerDescriptor(Pattern pattern,
                                  int group)

Parameters:

pattern - A Java regular expression.

group - Which capture group to extract as tokens. Defaults to -1 (split).

Method Detail

getPattern

public Pattern getPattern()

getGroup

public int getGroup()