lucene-java-3.5.0/lucene/contrib/highlighter/src/java/org/apache/lucene/search/highlight/OffsetLimitTokenFilter.java

   1 package org.apache.lucene.search.highlight;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.IOException;
  21
  22 import org.apache.lucene.analysis.TokenFilter;
  23 import org.apache.lucene.analysis.TokenStream;
  24 import org.apache.lucene.analysis.tokenattributes.OffsetAttribute;
  25
  26 /**
  27  * This TokenFilter limits the number of tokens while indexing by adding up the
  28  * current offset.
  29  */
  30 public final class OffsetLimitTokenFilter extends TokenFilter {
  31
  32   private int offsetCount;
  33   private OffsetAttribute offsetAttrib = getAttribute(OffsetAttribute.class);
  34   private int offsetLimit;
  35
  36   public OffsetLimitTokenFilter(TokenStream input, int offsetLimit) {
  37     super(input);
  38     this.offsetLimit = offsetLimit;
  39   }
  40
  41   @Override
  42   public boolean incrementToken() throws IOException {
  43     if (offsetCount < offsetLimit && input.incrementToken()) {
  44       int offsetLength = offsetAttrib.endOffset() - offsetAttrib.startOffset();
  45       offsetCount += offsetLength;
  46       return true;
  47     }
  48     return false;
  49   }
  50
  51   @Override
  52   public void reset() throws IOException {
  53     super.reset();
  54     offsetCount = 0;
  55   }
  56
  57 }