gate.creole.ir.IndexManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  Indexmanager.java
 *
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 *
 *  Rosen Marinov, 19/Apr/2002
 *
 */

package gate.creole.ir;

import gate.Corpus;
import gate.Document;

import java.util.List;

public interface IndexManager{

  /**
   * Gets the corpus this index manages will index.
   * @return a {@link gate.Corpus} value;
   */
  public Corpus getCorpus();

  /**
   * Sets the corpus this index manages will index.
   * @param corpus a {@link gate.Corpus} value;
   */
  public void setCorpus(Corpus corpus);

  /**
   * Gets the index definition for this index manager.
   * @return a {@link IndexDefinition} value.
   */
  public IndexDefinition getIndexDefinition();

  /**
   * Sets the index definition for this index manager.
   * @param indexDefinition a {@link IndexDefinition} value.
   */
  public void setIndexDefinition(IndexDefinition indexDefinition);


  /** Creates index directory and indexing all
   *  documents in the corpus. */
  public void createIndex() throws IndexException;

  /** Optimize the existing index*/
  public void optimizeIndex() throws IndexException;

  /** Delete all index files and directories in index location. */
  public void deleteIndex() throws IndexException;

  /** Reindexing changed documents, removing removed documents and
   *  add to the index new corpus documents. */
  public void sync(List added, List removed, List changed) throws IndexException;


}