| /* |
| 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. |
| */ |
| package org.apache.wiki.search; |
| |
| import org.apache.wiki.WikiPage; |
| import org.apache.wiki.api.core.Context; |
| import org.apache.wiki.api.exceptions.ProviderException; |
| import org.apache.wiki.api.providers.WikiProvider; |
| |
| import java.io.IOException; |
| import java.util.Collection; |
| |
| /** |
| * Interface for the search providers that handle searching the Wiki |
| * |
| * @since 2.2.21. |
| */ |
| public interface SearchProvider extends WikiProvider { |
| |
| /** |
| * Delete a page from the search index |
| * @param page Page to remove from search index |
| */ |
| void pageRemoved( WikiPage page ); |
| |
| /** |
| * Adds a WikiPage for indexing queue. This is called a queue, since |
| * this method is expected to return pretty quickly, and indexing to |
| * be done in a separate thread. |
| * |
| * @param page The WikiPage to be indexed. |
| */ |
| void reindexPage( WikiPage page ); |
| |
| /** |
| * Search for pages matching a search query |
| * @param query query to search for |
| * @param wikiContext the context within which to run the search |
| * @return collection of pages that match query |
| * @throws ProviderException if the search provider failed. |
| * @throws IOException if for some reason the query could not be executed. |
| */ |
| Collection< SearchResult > findPages( String query, Context wikiContext ) throws ProviderException, IOException; |
| |
| } |