Class PrefixAwareTokenFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.miscellaneous.PrefixAwareTokenFilter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class PrefixAwareTokenFilter extends org.apache.lucene.analysis.TokenStream
Joins two token streams and leaves the last token of the first stream available to be used when updating the token values in the second stream based on that token. The default implementation adds last prefix token end offset to the suffix token start and end offsets. NOTE: This filter might not behave correctly if used with custom Attributes, i.e. Attributes other than the ones located in org.apache.lucene.analysis.tokenattributes.
-
-
Constructor Summary
Constructors Constructor Description PrefixAwareTokenFilter(org.apache.lucene.analysis.TokenStream prefix, org.apache.lucene.analysis.TokenStream suffix)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
void
end()
org.apache.lucene.analysis.TokenStream
getPrefix()
org.apache.lucene.analysis.TokenStream
getSuffix()
boolean
incrementToken()
void
reset()
void
setPrefix(org.apache.lucene.analysis.TokenStream prefix)
void
setSuffix(org.apache.lucene.analysis.TokenStream suffix)
org.apache.lucene.analysis.Token
updateSuffixToken(org.apache.lucene.analysis.Token suffixToken, org.apache.lucene.analysis.Token lastPrefixToken)
The default implementation adds last prefix token end offset to the suffix token start and end offsets.-
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
-
-
-
-
Method Detail
-
incrementToken
public final boolean incrementToken() throws IOException
- Specified by:
incrementToken
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
updateSuffixToken
public org.apache.lucene.analysis.Token updateSuffixToken(org.apache.lucene.analysis.Token suffixToken, org.apache.lucene.analysis.Token lastPrefixToken)
The default implementation adds last prefix token end offset to the suffix token start and end offsets.- Parameters:
suffixToken
- a token from the suffix streamlastPrefixToken
- the last token from the prefix stream- Returns:
- consumer token
-
end
public void end() throws IOException
- Overrides:
end
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
reset
public void reset() throws IOException
- Overrides:
reset
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
getPrefix
public org.apache.lucene.analysis.TokenStream getPrefix()
-
setPrefix
public void setPrefix(org.apache.lucene.analysis.TokenStream prefix)
-
getSuffix
public org.apache.lucene.analysis.TokenStream getSuffix()
-
setSuffix
public void setSuffix(org.apache.lucene.analysis.TokenStream suffix)
-
-