corpus-server/src/main/java/org/apache/opennlp/corpus_server/search/SearchService.java

/*
 * 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.opennlp.corpus_server.search;

import java.io.IOException;
import java.util.List;

import org.apache.opennlp.corpus_server.store.CorporaStore;
import org.apache.opennlp.corpus_server.store.CorpusStore;

public interface SearchService {

  /**
   * Initializes the search service, called before any other method.
   * 
   * @param corporaStore
   * @throws IOException
   */
  void initialize(CorporaStore corporaStore) throws IOException;
  
  /**
   * Creates the index for the given corpus.
   * 
   * @param store
   * @throws IOException
   */
  void createIndex(CorpusStore store) throws IOException;
  
  void dropIndex(CorpusStore store) throws IOException;
  
  /**
   * Indexes or re-indexes a CAS.
   * 
   * @param store
   * @param casId
   * @throws IOException
   */
  void index(CorpusStore store, String casId) throws IOException;
  
  /**
   * Removes the CAS from the index.
   * 
   * @param store
   * @param casId
   * @throws IOException
   */
  void removeFromIndex(CorpusStore store, String casId) throws IOException;
  
  /**
   * Search for CASes matching the given query in the given corpus.
   * 
   * @param store
   * @param q
   * @return
   * @throws IOException
   */
  List<String> search(CorpusStore store, String q) throws IOException;

  /**
   * Shuts down the search service. No other methods expect initialize
   * might be called after this.
   * 
   * @throws IOException
   */
  void shutdown() throws IOException;
}