Class WordDelimiterFilter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Unwrappable<TokenStream>
- split on intra-word delimiters (by default, all non alpha-numeric characters):
"Wi-Fi"
→"Wi", "Fi"
- split on case transitions:
"PowerShot"
→"Power", "Shot"
- split on letter-number transitions:
"SD500"
→"SD", "500"
- leading and trailing intra-word delimiters on each subword are ignored:
"//hello---there, 'dude'"
→"hello", "there", "dude"
- trailing "'s" are removed for each subword:
"O'Neil's"
→"O", "Neil"
- Note: this step isn't performed in a separate filter because of possible subword combinations.
- If no CATENATE option is set, then no subword combinations are generated:
"PowerShot"
→0:"Power", 1:"Shot"
(0 and 1 are the token positions) - CATENATE_WORDS means that in addition to the subwords, maximum runs of non-numeric subwords
are catenated and produced at the same position of the last subword in the run:
"PowerShot"
→0:"Power", 1:"Shot" 1:"PowerShot"
"A's+B's&C's"
>0:"A", 1:"B", 2:"C", 2:"ABC"
"Super-Duper-XL500-42-AutoCoder!"
→0:"Super", 1:"Duper", 2:"XL", 2:"SuperDuperXL", 3:"500" 4:"42", 5:"Auto", 6:"Coder", 6:"AutoCoder"
- CATENATE_NUMBERS works like CATENATE_WORDS, but for adjacent digit sequences.
- CATENATE_ALL smushes together all the token parts without distinguishing numbers and words.
WordDelimiterFilter
is to help match words with different subword delimiters.
For example, if the source text contained "wi-fi" one may want "wifi" "WiFi" "wi-fi" "wi+fi"
queries to all match. One way of doing so is to specify CATENATE options in the analyzer used for
indexing, and not in the analyzer used for querying. Given that the current StandardTokenizer
immediately removes many intra-word delimiters, it is recommended that this
filter be used after a tokenizer that does not do this (such as WhitespaceTokenizer
).-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Deprecated.(package private) final class
Deprecated.A WDF concatenated 'run'Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
Deprecated.static final int
Deprecated.static final int
Deprecated.private AttributeSource.State[]
Deprecated.private int
Deprecated.private int
Deprecated.static final int
Deprecated.Causes all subword parts to be catenated:static final int
Deprecated.Causes maximum runs of word parts to be catenated:static final int
Deprecated.Causes maximum runs of word parts to be catenated:private final WordDelimiterFilter.WordDelimiterConcatenation
Deprecated.private final WordDelimiterFilter.WordDelimiterConcatenation
Deprecated.static final int
Deprecated.private boolean
Deprecated.private final int
Deprecated.static final int
Deprecated.Causes number subwords to be generated:static final int
Deprecated.Causes parts of words to be generated:private boolean
Deprecated.private boolean
Deprecated.private boolean
Deprecated.private boolean
Deprecated.static final int
Deprecated.Suppresses processing terms withKeywordAttribute.isKeyword()
=true.private final WordDelimiterIterator
Deprecated.private final KeywordAttribute
Deprecated.private int
Deprecated.static final int
Deprecated.private final OffsetAttribute
Deprecated.private int[]
Deprecated.private final PositionIncrementAttribute
Deprecated.static final int
Deprecated.Causes original words are preserved and added to the subword list (Defaults to false)(package private) final CharArraySet
Deprecated.If not null is the set of tokens to protect from being delimitedprivate char[]
Deprecated.private int
Deprecated.private int
Deprecated.private String
Deprecated.(package private) final WordDelimiterFilter.OffsetSorter
Deprecated.static final int
Deprecated.If not set, causes case changes to be ignored (subwords will only be generated given SUBWORD_DELIM tokens)static final int
Deprecated.If not set, causes numeric changes to be ignored (subwords will only be generated given SUBWORD_DELIM tokens).private int[]
Deprecated.static final int
Deprecated.Causes trailing "'s" to be removed for each subwordstatic final int
Deprecated.private final CharTermAttribute
Deprecated.private final TypeAttribute
Deprecated.static final int
Deprecated.Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
Constructor Summary
ConstructorsConstructorDescriptionWordDelimiterFilter
(TokenStream in, byte[] charTypeTable, int configurationFlags, CharArraySet protWords) Deprecated.Creates a new WordDelimiterFilterWordDelimiterFilter
(TokenStream in, int configurationFlags, CharArraySet protWords) Deprecated.Creates a new WordDelimiterFilter usingWordDelimiterIterator.DEFAULT_WORD_DELIM_TABLE
as its charTypeTable -
Method Summary
Modifier and TypeMethodDescriptionprivate void
buffer()
Deprecated.private void
concatenate
(WordDelimiterFilter.WordDelimiterConcatenation concatenation) Deprecated.Concatenates the saved buffer to the given WordDelimiterConcatenationprivate boolean
flushConcatenation
(WordDelimiterFilter.WordDelimiterConcatenation concatenation) Deprecated.Flushes the given WordDelimiterConcatenation by either writing its concat and then clearing, or just clearing.private void
generatePart
(boolean isSingleWord) Deprecated.Generates a word/number part, updating the appropriate attributesprivate boolean
has
(int flag) Deprecated.Determines whether the given flag is setboolean
Deprecated.Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.(package private) static boolean
isAlpha
(int type) Deprecated.Checks if the given word type includesALPHA
(package private) static boolean
isDigit
(int type) Deprecated.Checks if the given word type includesDIGIT
(package private) static boolean
isSubwordDelim
(int type) Deprecated.Checks if the given word type includesSUBWORD_DELIM
(package private) static boolean
isUpper
(int type) Deprecated.Checks if the given word type includesUPPER
private int
position
(boolean inject) Deprecated.Get the position increment gap for a subword or concatenationvoid
reset()
Deprecated.This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.private void
Deprecated.Saves the existing attribute statesprivate boolean
shouldConcatenate
(int wordType) Deprecated.Determines whether to concatenate a word or number if the current word is the given typeprivate boolean
shouldGenerateParts
(int wordType) Deprecated.Determines whether a word/number part should be generated for a word of the given typeMethods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, unwrap
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
-
Field Details
-
LOWER
public static final int LOWERDeprecated.- See Also:
-
UPPER
public static final int UPPERDeprecated.- See Also:
-
DIGIT
public static final int DIGITDeprecated.- See Also:
-
SUBWORD_DELIM
public static final int SUBWORD_DELIMDeprecated.- See Also:
-
ALPHA
public static final int ALPHADeprecated.- See Also:
-
ALPHANUM
public static final int ALPHANUMDeprecated.- See Also:
-
GENERATE_WORD_PARTS
public static final int GENERATE_WORD_PARTSDeprecated.Causes parts of words to be generated:"PowerShot" => "Power" "Shot"
- See Also:
-
GENERATE_NUMBER_PARTS
public static final int GENERATE_NUMBER_PARTSDeprecated.Causes number subwords to be generated:"500-42" => "500" "42"
- See Also:
-
CATENATE_WORDS
public static final int CATENATE_WORDSDeprecated.Causes maximum runs of word parts to be catenated:"wi-fi" => "wifi"
- See Also:
-
CATENATE_NUMBERS
public static final int CATENATE_NUMBERSDeprecated.Causes maximum runs of word parts to be catenated:"500-42" => "50042"
- See Also:
-
CATENATE_ALL
public static final int CATENATE_ALLDeprecated.Causes all subword parts to be catenated:"wi-fi-4000" => "wifi4000"
- See Also:
-
PRESERVE_ORIGINAL
public static final int PRESERVE_ORIGINALDeprecated.Causes original words are preserved and added to the subword list (Defaults to false)"500-42" => "500" "42" "500-42"
- See Also:
-
SPLIT_ON_CASE_CHANGE
public static final int SPLIT_ON_CASE_CHANGEDeprecated.If not set, causes case changes to be ignored (subwords will only be generated given SUBWORD_DELIM tokens)- See Also:
-
SPLIT_ON_NUMERICS
public static final int SPLIT_ON_NUMERICSDeprecated.If not set, causes numeric changes to be ignored (subwords will only be generated given SUBWORD_DELIM tokens).- See Also:
-
STEM_ENGLISH_POSSESSIVE
public static final int STEM_ENGLISH_POSSESSIVEDeprecated.Causes trailing "'s" to be removed for each subword"O'Neil's" => "O", "Neil"
- See Also:
-
IGNORE_KEYWORDS
public static final int IGNORE_KEYWORDSDeprecated.Suppresses processing terms withKeywordAttribute.isKeyword()
=true.- See Also:
-
protWords
Deprecated.If not null is the set of tokens to protect from being delimited -
flags
private final int flagsDeprecated. -
termAttribute
Deprecated. -
keywordAttribute
Deprecated. -
offsetAttribute
Deprecated. -
posIncAttribute
Deprecated. -
typeAttribute
Deprecated. -
iterator
Deprecated. -
concat
Deprecated. -
lastConcatCount
private int lastConcatCountDeprecated. -
concatAll
Deprecated. -
accumPosInc
private int accumPosIncDeprecated. -
savedBuffer
private char[] savedBufferDeprecated. -
savedStartOffset
private int savedStartOffsetDeprecated. -
savedEndOffset
private int savedEndOffsetDeprecated. -
savedType
Deprecated. -
hasSavedState
private boolean hasSavedStateDeprecated. -
hasIllegalOffsets
private boolean hasIllegalOffsetsDeprecated. -
hasOutputToken
private boolean hasOutputTokenDeprecated. -
hasOutputFollowingOriginal
private boolean hasOutputFollowingOriginalDeprecated. -
buffered
Deprecated. -
startOff
private int[] startOffDeprecated. -
posInc
private int[] posIncDeprecated. -
bufferedLen
private int bufferedLenDeprecated. -
bufferedPos
private int bufferedPosDeprecated. -
first
private boolean firstDeprecated. -
sorter
Deprecated.
-
-
Constructor Details
-
WordDelimiterFilter
public WordDelimiterFilter(TokenStream in, byte[] charTypeTable, int configurationFlags, CharArraySet protWords) Deprecated.Creates a new WordDelimiterFilter- Parameters:
in
- TokenStream to be filteredcharTypeTable
- table containing character typesconfigurationFlags
- Flags configuring the filterprotWords
- If not null is the set of tokens to protect from being delimited
-
WordDelimiterFilter
Deprecated.Creates a new WordDelimiterFilter usingWordDelimiterIterator.DEFAULT_WORD_DELIM_TABLE
as its charTypeTable- Parameters:
in
- TokenStream to be filteredconfigurationFlags
- Flags configuring the filterprotWords
- If not null is the set of tokens to protect from being delimited
-
-
Method Details
-
incrementToken
Deprecated.Description copied from class:TokenStream
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriateAttributeImpl
s with the attributes of the next token.The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
s that this stream uses should be retrieved during instantiation.To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in
TokenStream.incrementToken()
.- Specified by:
incrementToken
in classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
reset
Deprecated.Description copied from class:TokenFilter
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.
If you override this method, always call
super.reset()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on further usage).NOTE: The default implementation chains the call to the input TokenStream, so be sure to call
super.reset()
when overriding this method.- Overrides:
reset
in classTokenFilter
- Throws:
IOException
-
buffer
private void buffer()Deprecated. -
saveState
private void saveState()Deprecated.Saves the existing attribute states -
flushConcatenation
Deprecated.Flushes the given WordDelimiterConcatenation by either writing its concat and then clearing, or just clearing.- Parameters:
concatenation
- WordDelimiterConcatenation that will be flushed- Returns:
true
if the concatenation was written before it was cleared,false
otherwise
-
shouldConcatenate
private boolean shouldConcatenate(int wordType) Deprecated.Determines whether to concatenate a word or number if the current word is the given type- Parameters:
wordType
- Type of the current word used to determine if it should be concatenated- Returns:
true
if concatenation should occur,false
otherwise
-
shouldGenerateParts
private boolean shouldGenerateParts(int wordType) Deprecated.Determines whether a word/number part should be generated for a word of the given type- Parameters:
wordType
- Type of the word used to determine if a word/number part should be generated- Returns:
true
if a word/number part should be generated,false
otherwise
-
concatenate
Deprecated.Concatenates the saved buffer to the given WordDelimiterConcatenation- Parameters:
concatenation
- WordDelimiterConcatenation to concatenate the buffer to
-
generatePart
private void generatePart(boolean isSingleWord) Deprecated.Generates a word/number part, updating the appropriate attributes- Parameters:
isSingleWord
-true
if the generation is occurring from a single word,false
otherwise
-
position
private int position(boolean inject) Deprecated.Get the position increment gap for a subword or concatenation- Parameters:
inject
- true if this token wants to be injected- Returns:
- position increment gap
-
isAlpha
static boolean isAlpha(int type) Deprecated.Checks if the given word type includesALPHA
- Parameters:
type
- Word type to check- Returns:
true
if the type contains ALPHA,false
otherwise
-
isDigit
static boolean isDigit(int type) Deprecated.Checks if the given word type includesDIGIT
- Parameters:
type
- Word type to check- Returns:
true
if the type contains DIGIT,false
otherwise
-
isSubwordDelim
static boolean isSubwordDelim(int type) Deprecated.Checks if the given word type includesSUBWORD_DELIM
- Parameters:
type
- Word type to check- Returns:
true
if the type contains SUBWORD_DELIM,false
otherwise
-
isUpper
static boolean isUpper(int type) Deprecated.Checks if the given word type includesUPPER
- Parameters:
type
- Word type to check- Returns:
true
if the type contains UPPER,false
otherwise
-
has
private boolean has(int flag) Deprecated.Determines whether the given flag is set- Parameters:
flag
- Flag to see if set- Returns:
true
if flag is set
-
WordDelimiterGraphFilter
instead: it produces a correct token graph so that e.g.PhraseQuery
works correctly when it's used in the search time analyzer.