Class LimitTokenPositionFilter

  • All Implemented Interfaces:, java.lang.AutoCloseable

    public final class LimitTokenPositionFilter
    extends TokenFilter
    This TokenFilter limits its emitted tokens to those with positions that are not greater than the configured limit.

    By default, this filter ignores any tokens in the wrapped TokenStream once the limit has been exceeded, which can result in reset() being called prior to incrementToken() returning false. For most TokenStream implementations this should be acceptable, and faster then consuming the full stream. If you are wrapping a TokenStream which requires that the full stream of tokens be exhausted in order to function properly, use the consumeAllTokens option.

    • Constructor Detail

      • LimitTokenPositionFilter

        public LimitTokenPositionFilter​(TokenStream in,
                                        int maxTokenPosition)
        Build a filter that only accepts tokens up to and including the given maximum position. This filter will not consume any tokens with position greater than the maxTokenPosition limit.
        in - the stream to wrap
        maxTokenPosition - max position of tokens to produce (1st token always has position 1)
        See Also:
      • LimitTokenPositionFilter

        public LimitTokenPositionFilter​(TokenStream in,
                                        int maxTokenPosition,
                                        boolean consumeAllTokens)
        Build a filter that limits the maximum position of tokens to emit.
        in - the stream to wrap
        maxTokenPosition - max position of tokens to produce (1st token always has position 1)
        consumeAllTokens - whether all tokens from the wrapped input stream must be consumed even if maxTokenPosition is exceeded.
    • Method Detail

      • incrementToken

        public boolean incrementToken()
        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
        false for end of stream; true otherwise
      • reset

        public void reset()
        Description copied from class: TokenFilter
        This method is called by a consumer before it begins consumption using TokenStream.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 throw IllegalStateException 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.

        reset in class TokenFilter