gate.creole.ir.Search 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!

/*
 *  Search.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 java.util.List;

public interface Search{

  /** Sets coprus in which will doing search operations. */
  public void setCorpus(IndexedCorpus ic);

  /** Search in corpus with this query. Unlimited result length.*/
  public QueryResultList search(String query)
                         throws IndexException, SearchException;

  /** Search in corpus with this query.
   *  Size of the result list is limited. */
  public QueryResultList search(String query, int limit)
                         throws IndexException, SearchException;

  /** Search in corpus with this query.
   *  In each QueryResult will be added values of these fields.
   *  Result length is unlimited. */
  public QueryResultList search(String query, List fieldNames)
                         throws IndexException, SearchException;

  /** Search in corpus with this query.
   *  In each QueryResult will be added values of these fields.
   *  Result length is limited. */
  public QueryResultList search(String query, int limit, List fieldNames)
                         throws IndexException, SearchException;

}