|
Lucene example source code file (Searchable.java)
The Lucene Searchable.java source codepackage org.apache.lucene.search; /** * 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 java.io.Closeable; import org.apache.lucene.document.Document; import org.apache.lucene.document.FieldSelector; import org.apache.lucene.index.CorruptIndexException; import org.apache.lucene.index.Term; /** * The interface for search implementations. * * <p> * Searchable is the abstract network protocol for searching. Implementations * provide search over a single index, over multiple indices, and over indices * on remote servers. * * <p> * Queries, filters and sort criteria are designed to be compact so that they * may be efficiently passed to a remote index, with only the top-scoring hits * being returned, rather than every matching hit. * * <b>NOTE: this interface is kept public for convenience. Since it is not * expected to be implemented directly, it may be changed unexpectedly between * releases. * * @deprecated In 4.0 this interface is removed/absorbed * into IndexSearcher */ @Deprecated public interface Searchable extends Closeable { /** * Lower-level search API. * * <p> * {@link Collector#collect(int)} is called for every document. <br> * Collector-based access to remote indexes is discouraged. * * <p> * Applications should only use this if they need <i>all of the matching * documents. The high-level search API ({@link Searcher#search(Query,int)}) is * usually more efficient, as it skips non-high-scoring hits. * * @param weight * to match documents * @param filter * if non-null, used to permit documents to be collected. * @param collector * to receive hits * @throws BooleanQuery.TooManyClauses */ void search(Weight weight, Filter filter, Collector collector) throws IOException; /** Frees resources associated with this Searcher. * Be careful not to call this method while you are still using objects * that reference this Searchable. */ void close() throws IOException; /** Expert: Returns the number of documents containing <code>term. * * @see org.apache.lucene.index.IndexReader#docFreq(Term) */ int docFreq(Term term) throws IOException; /** Expert: For each term in the terms array, calculates the number of * documents containing <code>term. Returns an array with these * document frequencies. Used to minimize number of remote calls. */ int[] docFreqs(Term[] terms) throws IOException; /** Expert: Returns one greater than the largest possible document number. * * @see org.apache.lucene.index.IndexReader#maxDoc() */ int maxDoc() throws IOException; /** Expert: Low-level search implementation. Finds the top <code>n * hits for <code>query, applying Other Lucene examples (source code examples)Here is a short list of links related to this Lucene Searchable.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.