pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / src / java / org / apache / lucene / search / spans / SpanQuery.java
diff --git a/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/spans/SpanQuery.java b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/spans/SpanQuery.java
new file mode 100644 (file)
index 0000000..cae18b6
--- /dev/null
@@ -0,0 +1,41 @@
+package org.apache.lucene.search.spans;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.io.IOException;
+
+import org.apache.lucene.index.IndexReader;
+import org.apache.lucene.search.Query;
+import org.apache.lucene.search.Searcher;
+import org.apache.lucene.search.Weight;
+
+/** Base class for span-based queries. */
+public abstract class SpanQuery extends Query {
+  /** Expert: Returns the matches for this query in an index.  Used internally
+   * to search for spans. */
+  public abstract Spans getSpans(IndexReader reader) throws IOException;
+
+  /** Returns the name of the field matched by this query.*/
+  public abstract String getField();
+
+  @Override
+  public Weight createWeight(Searcher searcher) throws IOException {
+    return new SpanWeight(this, searcher);
+  }
+
+}