|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.solr.analysis.BaseTokenFilterFactory
org.apache.solr.analysis.CapitalizationFilterFactory
public class CapitalizationFilterFactory
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:<fieldType name="text_cptlztn" class="solr.TextField" positionIncrementGap="100"> <analyzer> <tokenizer class="solr.WhitespaceTokenizerFactory"/> <filter class="solr.CapitalizationFilterFactory" onlyFirstWord="true" keep="java solr lucene" keepIgnoreCase="false" okPrefix="McK McD McA"/> </analyzer> </fieldType>
Field Summary | |
---|---|
protected Map<String,String> |
args
The init args |
static int |
DEFAULT_MAX_WORD_COUNT
|
static String |
FORCE_FIRST_LETTER
|
static String |
KEEP
|
static String |
KEEP_IGNORE_CASE
|
protected Version |
luceneMatchVersion
the luceneVersion arg |
static String |
MAX_TOKEN_LENGTH
|
static String |
MAX_WORD_COUNT
|
static String |
MIN_WORD_LENGTH
|
static String |
OK_PREFIX
|
static 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 TokenizerFactory.create(java.io.Reader)
or TokenFilterFactory.create(org.apache.lucene.analysis.TokenStream) methods,
to inform user, that for this factory a luceneMatchVersion is required |
org.apache.solr.analysis.CapitalizationFilter |
create(TokenStream input)
Transform the specified input TokenStream |
Map<String,String> |
getArgs()
|
protected boolean |
getBoolean(String name,
boolean defaultVal)
|
protected boolean |
getBoolean(String name,
boolean defaultVal,
boolean useDefault)
|
protected int |
getInt(String name)
|
protected int |
getInt(String name,
int defaultVal)
|
protected int |
getInt(String name,
int defaultVal,
boolean useDefault)
|
protected CharArraySet |
getSnowballWordSet(ResourceLoader loader,
String wordFiles,
boolean ignoreCase)
same as getWordSet(ResourceLoader, String, boolean) ,
except the input is in snowball format. |
protected CharArraySet |
getWordSet(ResourceLoader loader,
String wordFiles,
boolean ignoreCase)
|
void |
init(Map<String,String> args)
init will be called just once, immediately after creation. |
void |
processWord(char[] buffer,
int offset,
int length,
int wordCount)
|
protected void |
warnDeprecated(String message)
|
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 |
---|
public static final int DEFAULT_MAX_WORD_COUNT
public static final String KEEP
public static final String KEEP_IGNORE_CASE
public static final String OK_PREFIX
public static final String MIN_WORD_LENGTH
public static final String MAX_WORD_COUNT
public static final String MAX_TOKEN_LENGTH
public static final String ONLY_FIRST_WORD
public static final String FORCE_FIRST_LETTER
protected Map<String,String> args
protected Version luceneMatchVersion
Constructor Detail |
---|
public CapitalizationFilterFactory()
Method Detail |
---|
public void init(Map<String,String> args)
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
init
in interface TokenFilterFactory
public void processWord(char[] buffer, int offset, int length, int wordCount)
public org.apache.solr.analysis.CapitalizationFilter create(TokenStream input)
TokenFilterFactory
public Map<String,String> getArgs()
protected final void assureMatchVersion()
TokenizerFactory.create(java.io.Reader)
or TokenFilterFactory.create(org.apache.lucene.analysis.TokenStream)
methods,
to inform user, that for this factory a luceneMatchVersion
is required
protected final void warnDeprecated(String message)
protected int getInt(String name)
protected int getInt(String name, int defaultVal)
protected int getInt(String name, int defaultVal, boolean useDefault)
protected boolean getBoolean(String name, boolean defaultVal)
protected boolean getBoolean(String name, boolean defaultVal, boolean useDefault)
protected CharArraySet getWordSet(ResourceLoader loader, String wordFiles, boolean ignoreCase) throws IOException
IOException
protected CharArraySet getSnowballWordSet(ResourceLoader loader, String wordFiles, boolean ignoreCase) throws IOException
getWordSet(ResourceLoader, String, boolean)
,
except the input is in snowball format.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |