lucene-java-3.4.0/lucene/src/java/org/apache/lucene/search/PrefixFilter.java

   1 package org.apache.lucene.search;
   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.index.Term;
  21
  22 /**
  23  * A Filter that restricts search results to values that have a matching prefix in a given
  24  * field.
  25  */
  26 public class PrefixFilter extends MultiTermQueryWrapperFilter<PrefixQuery> {
  27
  28   public PrefixFilter(Term prefix) {
  29     super(new PrefixQuery(prefix));
  30   }
  31
  32   public Term getPrefix() { return query.getPrefix(); }
  33
  34   /** Prints a user-readable version of this query. */
  35   @Override
  36   public String toString () {
  37     StringBuilder buffer = new StringBuilder();
  38     buffer.append("PrefixFilter(");
  39     buffer.append(getPrefix().toString());
  40     buffer.append(")");
  41     return buffer.toString();
  42   }
  43
  44 }
  45
  46
  47