Class DelimitedPayloadTokenFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.analysis.payloads.DelimitedPayloadTokenFilter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class DelimitedPayloadTokenFilter extends org.apache.lucene.analysis.TokenFilter
Characters before the delimiter are the "token", those after are the payload. For example, if the delimiter is '|', then for the string "foo|bar", foo is the token and "bar" is a payload. Note, you can also include aPayloadEncoder
to convert the payload in an appropriate way (from characters to bytes). Note make sure your Tokenizer doesn't split on the delimiter, or this won't work- See Also:
PayloadEncoder
-
-
Field Summary
Fields Modifier and Type Field Description static char
DEFAULT_DELIMITER
-
Constructor Summary
Constructors Constructor Description DelimitedPayloadTokenFilter(org.apache.lucene.analysis.TokenStream input, char delimiter, PayloadEncoder encoder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
incrementToken()
-
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
-
-
-
-
Field Detail
-
DEFAULT_DELIMITER
public static final char DEFAULT_DELIMITER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DelimitedPayloadTokenFilter
public DelimitedPayloadTokenFilter(org.apache.lucene.analysis.TokenStream input, char delimiter, PayloadEncoder encoder)
-
-
Method Detail
-
incrementToken
public boolean incrementToken() throws IOException
- Specified by:
incrementToken
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
-