lucene-java-3.4.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/surround/query/DistanceSubQuery.java

   1 package org.apache.lucene.queryParser.surround.query;
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one or more
   4  * contributor license agreements.  See the NOTICE file distributed with
   5  * this work for additional information regarding copyright ownership.
   6  * The ASF licenses this file to You under the Apache License, Version 2.0
   7  * (the "License"); you may not use this file except in compliance with
   8  * the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import java.io.IOException;
  20
  21 public interface DistanceSubQuery {
  22   /** When distanceSubQueryNotAllowed() returns non null, the reason why the subquery
  23    * is not allowed as a distance subquery is returned.
  24    * <br>When distanceSubQueryNotAllowed() returns null addSpanNearQueries() can be used
  25    * in the creation of the span near clause for the subquery.
  26    */
  27   String distanceSubQueryNotAllowed();
  28
  29   void addSpanQueries(SpanNearClauseFactory sncf) throws IOException;
  30 }
  31