Class DelimitedPayloadTokenFilter

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable

    public final class DelimitedPayloadTokenFilter
    extends 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 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

    See Also:
    PayloadEncoder
    • Constructor Detail

      • DelimitedPayloadTokenFilter

        public DelimitedPayloadTokenFilter​(TokenStream input,
                                           char delimiter,
                                           PayloadEncoder encoder)
    • 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 appropriate AttributeImpls 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 AttributeImpls 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 class TokenStream
        Returns:
        false for end of stream; true otherwise
        Throws:
        java.io.IOException