Class LimitTokenCountFilter

  • All Implemented Interfaces:
    Closeable, AutoCloseable, Unwrappable<TokenStream>

    public final class LimitTokenCountFilter
    extends TokenFilter
    This TokenFilter limits the number of tokens while indexing. It is a replacement for the maximum field length setting inside IndexWriter.

    By default, this filter ignores any tokens in the wrapped TokenStream once the limit has been reached, 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

      • LimitTokenCountFilter

        public LimitTokenCountFilter​(TokenStream in,
                                     int maxTokenCount)
        Build a filter that only accepts tokens up to a maximum number. This filter will not consume any tokens beyond the maxTokenCount limit
        See Also:
      • LimitTokenCountFilter

        public LimitTokenCountFilter​(TokenStream in,
                                     int maxTokenCount,
                                     boolean consumeAllTokens)
        Build an filter that limits the maximum number of tokens per field.
        in - the stream to wrap
        maxTokenCount - max number of tokens to produce
        consumeAllTokens - whether all tokens from the input must be consumed even if maxTokenCount is reached.