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

/*
 *  QueryResult.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 class QueryResult{

  /** Persistance document ID.*/
  private Object docID;

  /** Score(relevance) of the result between 0 and 1 */
  private float relevance;

  /** List of Terms*/
  private List fieldValues;

  /** Constructor of the class. */
  public QueryResult(Object docID,float relevance, List fieldValues){
    this.docID = docID;
    this.relevance = relevance;
    this.fieldValues = fieldValues;
  }

  /** @return persistance document ID.*/
  public Object getDocumentID(){
    return docID;
  }

  /** @return relevance of this result. */
  public float getScore(){
    return relevance;
  }

  /** returns certain document fields (if specified) from the search() call */
  public List getFields(){
    return fieldValues;
  }

}