001    /*
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.    
018     */
019    package org.apache.wiki.search;
020    
021    import java.io.IOException;
022    import java.util.Collection;
023    
024    import org.apache.wiki.WikiPage;
025    import org.apache.wiki.WikiProvider;
026    import org.apache.wiki.api.exceptions.ProviderException;
027    
028    /**
029     *  Interface for the search providers that handle searching the Wiki
030     *
031     *  @since 2.2.21.
032     */
033    public interface SearchProvider extends WikiProvider
034    {
035        /**
036         * Delete a page from the search index
037         * @param page Page to remove from search index
038         */
039        void pageRemoved(WikiPage page);
040    
041        /**
042         *  Adds a WikiPage for indexing queue.  This is called a queue, since
043         *  this method is expected to return pretty quickly, and indexing to
044         *  be done in a separate thread.
045         *
046         *  @param page The WikiPage to be indexed.
047         */
048        void reindexPage(WikiPage page);
049    
050        /**
051         * Search for pages matching a search query
052         * @param query query to search for
053         * @return collection of pages that match query
054         * @throws ProviderException if the search provider failed.
055         * @throws IOException if for some reason the query could not be executed.
056         */
057        Collection findPages(String query) throws ProviderException, IOException;
058    }