package org.nzdl.service;

import java.util.*;

public class NzdlQueryHit extends java.lang.Object {

  private String m_docID = null;
  private int    m_resultNum = -1;   // I don't actually know what it means !!!
  private int    m_ranking = -1;
  private int    m_numTermsMatched = -1;
  private int    m_numPhrasesMatched = -1;
  private int [] m_docFreqs = null; // I don't actually know what it means !!!
  /*
   * The key in the map will be the metaData Tag
   * The value for the key will be a Set of strings
   * Ex: key = "Author", value = {A. Mahoui, S. Franks}
   */
  private Map m_metaData = null;

  /** */

  public void setDocumentID( String _docID ) {
    m_docID = _docID;
  }

  public void setRanking( int _ranking ) {
    m_ranking = _ranking;
  }

  public void setResultNumber( int _resultNum ) {
    m_resultNum = _resultNum;
  }

  public void setNumOfTermsMatched( int _numTermsMatched ) {
    m_numTermsMatched = _numTermsMatched;
  }

  public void setNumOfPhrasesMatched( int _numPhrasesMatched ) {
    m_numPhrasesMatched = _numPhrasesMatched;
  }

  public void setMetaData( Map _metaData ) {
    m_metaData = _metaData;
  }

  /** */

  public String getDocumentID() {
    return m_docID;
  }

  public int getRanking() {
    return m_ranking;
  }

  public int getResultNumber() {
    return m_resultNum;
  }

  public int getNumOfTermsMatched() {
    return m_numTermsMatched;
  }

  public int getNumOfPhrasesMatched() {
    return m_numPhrasesMatched;
  }

  public Map getMetaData() {
    return m_metaData;
  }

  /** returns a set of String objects */
  public Set getMetaDataValues( String _metaTag ) {
    return (Set) m_metaData.get( _metaTag );
  }

  /** returns a set of key (String) objects */
  public Set getMetaDataTags() {
    return m_metaData.keySet();
  }

  public Collection getMetaDataValues() {
    return m_metaData.values();
  }

}