Class Word2VecSynonymFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.analysis.synonym.word2vec.Word2VecSynonymFilter
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,Unwrappable<TokenStream>
public final class Word2VecSynonymFilter extends TokenFilter
Applies single-token synonyms from a Word2Vec trained network to an incomingTokenStream
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description private AttributeSource.State
lastState
private int
maxSynonymsPerTerm
private float
minAcceptedSimilarity
private PositionIncrementAttribute
posIncrementAtt
private PositionLengthAttribute
posLenAtt
private java.util.LinkedList<TermAndBoost>
synonymBuffer
private Word2VecSynonymProvider
synonymProvider
private CharTermAttribute
termAtt
private TypeAttribute
typeAtt
-
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 Word2VecSynonymFilter(TokenStream input, Word2VecSynonymProvider synonymProvider, int maxSynonymsPerTerm, float minAcceptedSimilarity)
Apply previously built synonymProvider to incoming tokens.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.-
Methods 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 Detail
-
termAtt
private final CharTermAttribute termAtt
-
posIncrementAtt
private final PositionIncrementAttribute posIncrementAtt
-
posLenAtt
private final PositionLengthAttribute posLenAtt
-
typeAtt
private final TypeAttribute typeAtt
-
synonymProvider
private final Word2VecSynonymProvider synonymProvider
-
maxSynonymsPerTerm
private final int maxSynonymsPerTerm
-
minAcceptedSimilarity
private final float minAcceptedSimilarity
-
synonymBuffer
private final java.util.LinkedList<TermAndBoost> synonymBuffer
-
lastState
private AttributeSource.State lastState
-
-
Constructor Detail
-
Word2VecSynonymFilter
public Word2VecSynonymFilter(TokenStream input, Word2VecSynonymProvider synonymProvider, int maxSynonymsPerTerm, float minAcceptedSimilarity)
Apply previously built synonymProvider to incoming tokens.- Parameters:
input
- input tokenstreamsynonymProvider
- synonym providermaxSynonymsPerTerm
- maximum number of result returned by the synonym searchminAcceptedSimilarity
- minimal value of cosine similarity between the searched vector and the retrieved ones
-
-
Method Detail
-
incrementToken
public boolean incrementToken() throws java.io.IOException
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
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
-
-