org.apache.lucene.analysis.core

Class KeywordTokenizerFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.TokenizerFactory

org.apache.lucene.analysis.core.KeywordTokenizerFactory

public class KeywordTokenizerFactory
extends TokenizerFactory

Factory for KeywordTokenizer.

 <fieldType name="text_keyword" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.KeywordTokenizerFactory" maxTokenLen="256"/>
   </analyzer>
 </fieldType>

Options:

• maxTokenLen: max token length, should be greater than 0 and less than MAX_TOKEN_LENGTH_LIMIT (1024*1024). It is rare to need to change this else KeywordTokenizer::DEFAULT_BUFFER_SIZE

Since:

3.1

SPI Name (Note: This is case-insensitive. e.g., if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service):

"keyword"

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME SPI name

Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
KeywordTokenizerFactory(Map<String,String> args) Creates a new KeywordTokenizerFactory

Method Summary

Modifier and Type	Method and Description
KeywordTokenizer	create(AttributeFactory factory) Creates a TokenStream of the specified input using the given AttributeFactory

Methods inherited from class org.apache.lucene.analysis.util.TokenizerFactory

availableTokenizers, create, findSPIName, forName, lookupClass, reloadTokenizers

Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

SPI name

See Also:

Constant Field Values

Constructor Detail

KeywordTokenizerFactory

public KeywordTokenizerFactory(Map<String,String> args)

Creates a new KeywordTokenizerFactory

Method Detail

create

public KeywordTokenizer create(AttributeFactory factory)

Description copied from class: TokenizerFactory

Creates a TokenStream of the specified input using the given AttributeFactory

Specified by:

create in class TokenizerFactory