resultitem.java

MG4J (Managing Gigabytes for Java) is a free full-text search engine for large document collections

package it.unimi.dsi.mg4j.query;

import java.util.Formatter;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2005-2007 Sebastiano Vigna 
 *
 *  This library is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License as published by the Free
 *  Software Foundation; either version 2.1 of the License, or (at your option)
 *  any later version.
 *
 *  This library is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *  or FITfNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

/** An instance of this class is used to pack the results gathered by {@link it.unimi.dsi.mg4j.query.QueryServlet}
 * in such a way that they are easily accessible from the Velocity Template Language.
 * 
 * @author Sebastiano Vigna
 * @since 0.9.2
 */

public class ResultItem extends BrowseItem {
	/** The document index of this result. */
	public final int doc;
	/** The score of this result. */
	public final double score;
	
	public ResultItem( final int doc, final double score ) {
		this.doc = doc;
		this.score = score;
	}
		
	public int doc() {
		return doc;
	}

	public final double score() {
		return score;
	}
	
	public final String score( int digits ) {
		return new Formatter( new StringBuilder() ).format( "%." + digits + "f", Double.valueOf( score ) ).out().toString();
	}

	public String toString() {
		return "[doc: " + doc + " title: " + title + " score: " + score + "]";
	}
	
}