public class HyphenationCompoundWordTokenFilter extends CompoundWordTokenFilterBase
TokenFilter that decomposes compound words found in many Germanic languages.
"Donaudampfschiff" becomes Donau, dampf, schiff so that you can find "Donaudampfschiff" even when you only enter "schiff". It uses a hyphenation grammar and a word dictionary to achieve this.
You must specify the required Version compatibility when creating
CompoundWordTokenFilterBase:
If you pass in a CharArraySet as dictionary,
it should be case-insensitive unless it contains only lowercased entries and you
have LowerCaseFilter before this filter in your analysis chain.
For optional performance (as this filter does lots of lookups to the dictionary,
you should use the latter analysis chain/CharArraySet). Be aware: If you supply arbitrary
Sets to the ctors or String[] dictionaries, they will be automatically
transformed to case-insensitive!
CompoundWordTokenFilterBase.CompoundTokenDEFAULT_MAX_SUBWORD_SIZE, DEFAULT_MIN_SUBWORD_SIZE, DEFAULT_MIN_WORD_SIZE, dictionary, maxSubwordSize, minSubwordSize, minWordSize, offsetAtt, onlyLongestMatch, termAtt, tokens| Constructor and Description |
|---|
HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary)
Deprecated.
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary,
int minWordSize,
int minSubwordSize,
int maxSubwordSize,
boolean onlyLongestMatch)
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
String[] dictionary)
Deprecated.
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
String[] dictionary,
int minWordSize,
int minSubwordSize,
int maxSubwordSize,
boolean onlyLongestMatch)
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator)
Create a HyphenationCompoundWordTokenFilter with no dictionary.
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
int minWordSize,
int minSubwordSize,
int maxSubwordSize)
Create a HyphenationCompoundWordTokenFilter with no dictionary.
|
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary)
Creates a new
HyphenationCompoundWordTokenFilter instance. |
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary,
int minWordSize,
int minSubwordSize,
int maxSubwordSize,
boolean onlyLongestMatch)
Creates a new
HyphenationCompoundWordTokenFilter instance. |
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
String[] dictionary)
Deprecated.
Use the constructors taking
Set |
HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
String[] dictionary,
int minWordSize,
int minSubwordSize,
int maxSubwordSize,
boolean onlyLongestMatch)
Deprecated.
Use the constructors taking
Set |
| Modifier and Type | Method and Description |
|---|---|
protected void |
decompose()
Decomposes the current
CompoundWordTokenFilterBase.termAtt and places CompoundWordTokenFilterBase.CompoundToken instances in the CompoundWordTokenFilterBase.tokens list. |
static HyphenationTree |
getHyphenationTree(File hyphenationFile)
Create a hyphenator tree
|
static HyphenationTree |
getHyphenationTree(InputSource hyphenationSource)
Create a hyphenator tree
|
static HyphenationTree |
getHyphenationTree(Reader hyphenationReader)
Deprecated.
Don't use Readers with fixed charset to load XML files, unless programatically created.
Use
getHyphenationTree(InputSource) instead, where you can supply default charset and input
stream, if you like. |
static HyphenationTree |
getHyphenationTree(String hyphenationFilename)
Create a hyphenator tree
|
incrementToken, makeDictionary, resetaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion, org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, String[] dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, boolean onlyLongestMatch)
SetHyphenationCompoundWordTokenFilter instance.matchVersion - Lucene version to enable correct Unicode 4.0 behavior in the
dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match againstminWordSize - only words longer than this get processedminSubwordSize - only subwords longer than this get to the output streammaxSubwordSize - only subwords shorter than this get to the output streamonlyLongestMatch - Add only the longest matching subword to the stream@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion, org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, String[] dictionary)
SetHyphenationCompoundWordTokenFilter instance.matchVersion - Lucene version to enable correct Unicode 4.0 behavior in the
dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match againstpublic HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary)
HyphenationCompoundWordTokenFilter instance.matchVersion - Lucene version to enable correct Unicode 4.0 behavior in the
dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match against.public HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
Set<?> dictionary,
int minWordSize,
int minSubwordSize,
int maxSubwordSize,
boolean onlyLongestMatch)
HyphenationCompoundWordTokenFilter instance.matchVersion - Lucene version to enable correct Unicode 4.0 behavior in the
dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match against.minWordSize - only words longer than this get processedminSubwordSize - only subwords longer than this get to the output streammaxSubwordSize - only subwords shorter than this get to the output streamonlyLongestMatch - Add only the longest matching subword to the streampublic HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator,
int minWordSize,
int minSubwordSize,
int maxSubwordSize)
public HyphenationCompoundWordTokenFilter(org.apache.lucene.util.Version matchVersion,
org.apache.lucene.analysis.TokenStream input,
HyphenationTree hyphenator)
@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, String[] dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, boolean onlyLongestMatch)
HyphenationCompoundWordTokenFilter(Version, TokenStream, HyphenationTree, String[], int, int, int, boolean) instead.HyphenationCompoundWordTokenFilter instance.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match againstminWordSize - only words longer than this get processedminSubwordSize - only subwords longer than this get to the output
streammaxSubwordSize - only subwords shorter than this get to the output
streamonlyLongestMatch - Add only the longest matching subword to the stream@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, String[] dictionary)
HyphenationCompoundWordTokenFilter(Version, TokenStream, HyphenationTree, String[]) instead.HyphenationCompoundWordTokenFilter instance.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match against@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, Set<?> dictionary)
HyphenationCompoundWordTokenFilter(Version, TokenStream, HyphenationTree, Set) instead.HyphenationCompoundWordTokenFilter instance.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match against. If this is a CharArraySet it must have set ignoreCase=false and only contain
lower case strings.@Deprecated public HyphenationCompoundWordTokenFilter(org.apache.lucene.analysis.TokenStream input, HyphenationTree hyphenator, Set<?> dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, boolean onlyLongestMatch)
HyphenationCompoundWordTokenFilter(Version, TokenStream, HyphenationTree, Set, int, int, int, boolean) instead.HyphenationCompoundWordTokenFilter instance.input - the TokenStream to processhyphenator - the hyphenation pattern tree to use for hyphenationdictionary - the word dictionary to match against. If this is a CharArraySet it must have set ignoreCase=false and only contain
lower case strings.minWordSize - only words longer than this get processedminSubwordSize - only subwords longer than this get to the output
streammaxSubwordSize - only subwords shorter than this get to the output
streamonlyLongestMatch - Add only the longest matching subword to the streampublic static HyphenationTree getHyphenationTree(String hyphenationFilename) throws Exception
hyphenationFilename - the filename of the XML grammar to loadExceptionpublic static HyphenationTree getHyphenationTree(File hyphenationFile) throws Exception
hyphenationFile - the file of the XML grammar to loadException@Deprecated public static HyphenationTree getHyphenationTree(Reader hyphenationReader) throws Exception
getHyphenationTree(InputSource) instead, where you can supply default charset and input
stream, if you like.hyphenationReader - the reader of the XML grammar to load fromExceptionpublic static HyphenationTree getHyphenationTree(InputSource hyphenationSource) throws Exception
hyphenationSource - the InputSource pointing to the XML grammarExceptionprotected void decompose()
CompoundWordTokenFilterBaseCompoundWordTokenFilterBase.termAtt and places CompoundWordTokenFilterBase.CompoundToken instances in the CompoundWordTokenFilterBase.tokens list.
The original token may not be placed in the list, as it is automatically passed through this filter.decompose in class CompoundWordTokenFilterBaseCopyright © 2000-2015 Apache Software Foundation. All Rights Reserved.