/* 
    P/P   *  Method: org.apache.roller.weblogger.business.search.IndexManager__static_init
          */
     1  /*
     2  * Licensed to the Apache Software Foundation (ASF) under one or more
     3  *  contributor license agreements.  The ASF licenses this file to You
     4  * under the Apache License, Version 2.0 (the "License"); you may not
     5  * use this file except in compliance with the License.
     6  * You may obtain a copy of the License at
     7  *
     8  *     http://www.apache.org/licenses/LICENSE-2.0
     9  *
    10  * Unless required by applicable law or agreed to in writing, software
    11  * distributed under the License is distributed on an "AS IS" BASIS,
    12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  * See the License for the specific language governing permissions and
    14  * limitations under the License.  For additional information regarding
    15  * copyright in this work, please see the NOTICE file in the top level
    16  * directory of this distribution.
    17  */
    18  package org.apache.roller.weblogger.business.search;
    19  
    20  import org.apache.roller.weblogger.WebloggerException;
    21  import org.apache.roller.weblogger.business.InitializationException;
    22  import org.apache.roller.weblogger.business.search.operations.IndexOperation;
    23  import org.apache.roller.weblogger.pojos.WeblogEntry;
    24  import org.apache.roller.weblogger.pojos.Weblog;
    25  
    26  /**
    27   * Interface to Roller's Lucene-based search facility.
    28   * @author Dave Johnson
    29   */
    30  public interface IndexManager
    31  {
    32      /** Does index need to be rebuild */
    33      public abstract boolean isInconsistentAtStartup();
    34      
    35      /** Remove user from index, returns immediately and operates in background */
    36      public void removeWebsiteIndex(Weblog website) throws WebloggerException;
    37      
    38      /** Remove entry from index, returns immediately and operates in background */
    39      public void removeEntryIndexOperation(WeblogEntry entry) throws WebloggerException;
    40      
    41      /** Add entry to index, returns immediately and operates in background */
    42      public void addEntryIndexOperation(WeblogEntry entry) throws WebloggerException;
    43      
    44      /** R-index entry, returns immediately and operates in background */
    45      public void addEntryReIndexOperation(WeblogEntry entry) throws WebloggerException;
    46      
    47      /** Execute operation immediately */
    48      public abstract void executeIndexOperationNow(final IndexOperation op);
    49  
    50      /**
    51       * Release all resources associated with Roller session.
    52       */
    53      public abstract void release();
    54      
    55      
    56      /**
    57       * Initialize the search system.
    58       *
    59       * @throws InitializationException If there is a problem during initialization.
    60       */
    61      public void initialize() throws InitializationException;
    62      
    63      
    64      /** Shutdown to be called on application shutdown */
    65      public abstract void shutdown();
    66  
    67      public abstract void rebuildWebsiteIndex(Weblog website) throws WebloggerException;
    68  
    69      public abstract void rebuildWebsiteIndex() throws WebloggerException;
    70  
    71  }