lucene-java-3.4.0/lucene/src/java/org/apache/lucene/analysis/tokenattributes/KeywordAttribute.java

   1 package org.apache.lucene.analysis.tokenattributes;
   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 org.apache.lucene.analysis.TokenStream;
  21 import org.apache.lucene.util.Attribute;
  22
  23 /**
  24  * This attribute can be used to mark a token as a keyword. Keyword aware
  25  * {@link TokenStream}s can decide to modify a token based on the return value
  26  * of {@link #isKeyword()} if the token is modified. Stemming filters for
  27  * instance can use this attribute to conditionally skip a term if
  28  * {@link #isKeyword()} returns <code>true</code>.
  29  */
  30 public interface KeywordAttribute extends Attribute {
  31
  32   /**
  33    * Returns <code>true</code> iff the current token is a keyword, otherwise
  34    * <code>false</code>/
  35    *
  36    * @return <code>true</code> iff the current token is a keyword, otherwise
  37    *         <code>false</code>/
  38    */
  39   public boolean isKeyword();
  40
  41   /**
  42    * Marks the current token as keyword iff set to <code>true</code>.
  43    *
  44    * @param isKeyword
  45    *          <code>true</code> iff the current token is a keyword, otherwise
  46    *          <code>false</code>.
  47    */
  48   public void setKeyword(boolean isKeyword);
  49 }