Class SynonymFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.analysis.synonym.SynonymFilter
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
@Deprecated public final class SynonymFilter extends TokenFilter
Deprecated.UseSynonymGraphFilter
instead, but be sure to also useFlattenGraphFilter
at index time (not at search time) as well.Matches single or multi word synonyms in a token stream. This token stream cannot properly handle position increments != 1, ie, you should place this filter before filtering out stop words.Note that with the current implementation, parsing is greedy, so whenever multiple parses would apply, the rule starting the earliest and parsing the most tokens wins. For example if you have these rules:
a -> x a b -> y b c d -> z
Then inputa b c d e
parses toy b c d
, ie the 2nd rule "wins" because it started earliest and matched the most input tokens of other rules starting at that point.A future improvement to this filter could allow non-greedy parsing, such that the 3rd rule would win, and also separately allow multiple parses, such that all 3 rules would match, perhaps even on a rule by rule basis.
NOTE: when a match occurs, the output tokens associated with the matching rule are "stacked" on top of the input stream (if the rule had
keepOrig=true
) and also on top of another matched rule's output tokens. This is not a correct solution, as really the output should be an arbitrary graph/lattice. For example, with the above match, you would expect an exactPhraseQuery
"y b c"
to match the parsed tokens, but it will fail to do so. This limitation is necessary because Lucene's TokenStream (and index) cannot yet represent an arbitrary graph.NOTE: If multiple incoming tokens arrive on the same position, only the first token at that position is used for parsing. Subsequent tokens simply pass through and are not parsed. A future improvement would be to allow these tokens to also be matched.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
SynonymFilter.PendingInput
Deprecated.private static class
SynonymFilter.PendingOutputs
Deprecated.-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description private ByteArrayDataInput
bytesReader
Deprecated.private int
captureCount
Deprecated.private boolean
finished
Deprecated.private FST<BytesRef>
fst
Deprecated.private FST.BytesReader
fstReader
Deprecated.private SynonymFilter.PendingInput[]
futureInputs
Deprecated.private SynonymFilter.PendingOutputs[]
futureOutputs
Deprecated.private boolean
ignoreCase
Deprecated.private int
inputSkipCount
Deprecated.private int
lastEndOffset
Deprecated.private int
lastStartOffset
Deprecated.private int
nextRead
Deprecated.private int
nextWrite
Deprecated.private OffsetAttribute
offsetAtt
Deprecated.private PositionIncrementAttribute
posIncrAtt
Deprecated.private PositionLengthAttribute
posLenAtt
Deprecated.private int
rollBufferSize
Deprecated.private FST.Arc<BytesRef>
scratchArc
Deprecated.private BytesRef
scratchBytes
Deprecated.private CharsRefBuilder
scratchChars
Deprecated.private SynonymMap
synonyms
Deprecated.private CharTermAttribute
termAtt
Deprecated.static java.lang.String
TYPE_SYNONYM
Deprecated.private TypeAttribute
typeAtt
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
Constructors Constructor Description SynonymFilter(TokenStream input, SynonymMap synonyms, boolean ignoreCase)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private void
addOutput(BytesRef bytes, int matchInputLength, int matchEndOffset)
Deprecated.private void
capture()
Deprecated.(package private) int
getCaptureCount()
Deprecated.boolean
incrementToken()
Deprecated.Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.private void
parse()
Deprecated.void
reset()
Deprecated.This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.private int
rollIncr(int count)
Deprecated.-
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end
-
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 Detail
-
TYPE_SYNONYM
public static final java.lang.String TYPE_SYNONYM
Deprecated.- See Also:
- Constant Field Values
-
synonyms
private final SynonymMap synonyms
Deprecated.
-
ignoreCase
private final boolean ignoreCase
Deprecated.
-
rollBufferSize
private final int rollBufferSize
Deprecated.
-
captureCount
private int captureCount
Deprecated.
-
termAtt
private final CharTermAttribute termAtt
Deprecated.
-
posIncrAtt
private final PositionIncrementAttribute posIncrAtt
Deprecated.
-
posLenAtt
private final PositionLengthAttribute posLenAtt
Deprecated.
-
typeAtt
private final TypeAttribute typeAtt
Deprecated.
-
offsetAtt
private final OffsetAttribute offsetAtt
Deprecated.
-
inputSkipCount
private int inputSkipCount
Deprecated.
-
futureInputs
private final SynonymFilter.PendingInput[] futureInputs
Deprecated.
-
bytesReader
private final ByteArrayDataInput bytesReader
Deprecated.
-
futureOutputs
private final SynonymFilter.PendingOutputs[] futureOutputs
Deprecated.
-
nextWrite
private int nextWrite
Deprecated.
-
nextRead
private int nextRead
Deprecated.
-
finished
private boolean finished
Deprecated.
-
fstReader
private final FST.BytesReader fstReader
Deprecated.
-
scratchBytes
private final BytesRef scratchBytes
Deprecated.
-
scratchChars
private final CharsRefBuilder scratchChars
Deprecated.
-
lastStartOffset
private int lastStartOffset
Deprecated.
-
lastEndOffset
private int lastEndOffset
Deprecated.
-
-
Constructor Detail
-
SynonymFilter
public SynonymFilter(TokenStream input, SynonymMap synonyms, boolean ignoreCase)
Deprecated.- Parameters:
input
- input tokenstreamsynonyms
- synonym mapignoreCase
- case-folds input for matching withCharacter.toLowerCase(int)
. Note, if you set this to true, it's your responsibility to lowercase the input entries when you create theSynonymMap
-
-
Method Detail
-
capture
private void capture()
Deprecated.
-
parse
private void parse() throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
addOutput
private void addOutput(BytesRef bytes, int matchInputLength, int matchEndOffset)
Deprecated.
-
rollIncr
private int rollIncr(int count)
Deprecated.
-
getCaptureCount
int getCaptureCount()
Deprecated.
-
incrementToken
public boolean incrementToken() throws java.io.IOException
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:
java.io.IOException
-
reset
public void reset() throws java.io.IOException
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:
java.io.IOException
-
-