public final class DelimitedPayloadTokenFilter extends TokenFilter
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 a PayloadEncoder
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
PayloadEncoder
AttributeSource.State
Modifier and Type | Field and Description |
---|---|
static char |
DEFAULT_DELIMITER |
private char |
delimiter |
private PayloadEncoder |
encoder |
private PayloadAttribute |
payAtt |
private CharTermAttribute |
termAtt |
input
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
Constructor and Description |
---|
DelimitedPayloadTokenFilter(TokenStream input,
char delimiter,
PayloadEncoder encoder) |
Modifier and Type | Method and Description |
---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
close, end, reset
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
public static final char DEFAULT_DELIMITER
private final char delimiter
private final CharTermAttribute termAtt
private final PayloadAttribute payAtt
private final PayloadEncoder encoder
public DelimitedPayloadTokenFilter(TokenStream input, char delimiter, PayloadEncoder encoder)
public boolean incrementToken() throws java.io.IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
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)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
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()
.
incrementToken
in class TokenStream
java.io.IOException