org.apache.solr.analysis
Class CapitalizationFilterFactory

java.lang.Object
  org.apache.solr.analysis.BaseTokenFilterFactory
      org.apache.solr.analysis.CapitalizationFilterFactory

All Implemented Interfaces:

TokenFilterFactory

public class CapitalizationFilterFactory
extends BaseTokenFilterFactory

A filter to apply normal capitalization rules to Tokens. It will make the first letter capital and the rest lower case.

This filter is particularly useful to build nice looking facet parameters. This filter is not appropriate if you intend to use a prefix query.

The factory takes parameters:
"onlyFirstWord" - should each word be capitalized or all of the words?
"keep" - a keep word list. Each word that should be kept separated by whitespace.
"keepIgnoreCase - true or false. If true, the keep list will be considered case-insensitive. "forceFirstLetter" - Force the first letter to be capitalized even if it is in the keep list
"okPrefix" - do not change word capitalization if a word begins with something in this list. for example if "McK" is on the okPrefix list, the word "McKinley" should not be changed to "Mckinley"
"minWordLength" - how long the word needs to be to get capitalization applied. If the minWordLength is 3, "and" > "And" but "or" stays "or"
"maxWordCount" - if the token contains more then maxWordCount words, the capitalization is assumed to be correct.

Since:

solr 1.3

Version:

$Id: CapitalizationFilterFactory.java 891596 2009-12-17 09:19:06Z shalin $

Field Summary

protected java.util.Map<java.lang.String,java.lang.String>	args The init args
static int	DEFAULT_MAX_WORD_COUNT
static java.lang.String	FORCE_FIRST_LETTER
static java.lang.String	KEEP
static java.lang.String	KEEP_IGNORE_CASE
protected org.apache.lucene.util.Version	luceneMatchVersion the luceneVersion arg
static java.lang.String	MAX_TOKEN_LENGTH
static java.lang.String	MAX_WORD_COUNT
static java.lang.String	MIN_WORD_LENGTH
static java.lang.String	OK_PREFIX
static java.lang.String	ONLY_FIRST_WORD

Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory

log

Constructor Summary

CapitalizationFilterFactory()

Method Summary

protected void	assureMatchVersion() this method can be called in the #create method, to inform user, that for this factory a luceneMatchVersion is required
org.apache.solr.analysis.CapitalizationFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
java.util.Map<java.lang.String,java.lang.String>	getArgs()
protected boolean	getBoolean(java.lang.String name, boolean defaultVal)
protected boolean	getBoolean(java.lang.String name, boolean defaultVal, boolean useDefault)
protected int	getInt(java.lang.String name)
protected int	getInt(java.lang.String name, int defaultVal)
protected int	getInt(java.lang.String name, int defaultVal, boolean useDefault)
protected org.apache.lucene.analysis.CharArraySet	getWordSet(ResourceLoader loader, java.lang.String wordFiles, boolean ignoreCase)
void	init(java.util.Map<java.lang.String,java.lang.String> args) init will be called just once, immediately after creation.
void	processWord(char[] buffer, int offset, int length, int wordCount)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.analysis.TokenFilterFactory

getArgs

Field Detail

DEFAULT_MAX_WORD_COUNT

public static final int DEFAULT_MAX_WORD_COUNT

See Also:

Constant Field Values

KEEP

public static final java.lang.String KEEP

See Also:

Constant Field Values

KEEP_IGNORE_CASE

public static final java.lang.String KEEP_IGNORE_CASE

See Also:

Constant Field Values

OK_PREFIX

public static final java.lang.String OK_PREFIX

See Also:

Constant Field Values

MIN_WORD_LENGTH

public static final java.lang.String MIN_WORD_LENGTH

See Also:

Constant Field Values

MAX_WORD_COUNT

public static final java.lang.String MAX_WORD_COUNT

See Also:

Constant Field Values

MAX_TOKEN_LENGTH

public static final java.lang.String MAX_TOKEN_LENGTH

See Also:

Constant Field Values

ONLY_FIRST_WORD

public static final java.lang.String ONLY_FIRST_WORD

See Also:

Constant Field Values

FORCE_FIRST_LETTER

public static final java.lang.String FORCE_FIRST_LETTER

See Also:

Constant Field Values

args

protected java.util.Map<java.lang.String,java.lang.String> args

The init args

luceneMatchVersion

protected org.apache.lucene.util.Version luceneMatchVersion

the luceneVersion arg

Constructor Detail

CapitalizationFilterFactory

public CapitalizationFilterFactory()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> args)

Description copied from interface: TokenFilterFactory

init will be called just once, immediately after creation.

The args are user-level initialization parameters that may be specified when declaring the factory in the schema.xml

Specified by:

init in interface TokenFilterFactory

processWord

public void processWord(char[] buffer,
                        int offset,
                        int length,
                        int wordCount)

create

public org.apache.solr.analysis.CapitalizationFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream

getArgs

public java.util.Map<java.lang.String,java.lang.String> getArgs()

assureMatchVersion

protected final void assureMatchVersion()

this method can be called in the #create method, to inform user, that for this factory a luceneMatchVersion is required

getInt

protected int getInt(java.lang.String name)

getInt

protected int getInt(java.lang.String name,
                     int defaultVal)

getInt

protected int getInt(java.lang.String name,
                     int defaultVal,
                     boolean useDefault)

getBoolean

protected boolean getBoolean(java.lang.String name,
                             boolean defaultVal)

getBoolean

protected boolean getBoolean(java.lang.String name,
                             boolean defaultVal,
                             boolean useDefault)

getWordSet

protected org.apache.lucene.analysis.CharArraySet getWordSet(ResourceLoader loader,
                                                             java.lang.String wordFiles,
                                                             boolean ignoreCase)
                                                      throws java.io.IOException

Throws:

java.io.IOException