org.apache.lucene.search

Class Hit

Implemented Interfaces:
Serializable

public class Hit
extends Object
implements Serializable

Wrapper used by HitIterator to provide a lazily loaded hit from Hits.
Author:
Jeremy Rayner
See Also:
Serialized Form

Method Summary

String
get(String name)
Returns the string value of the field with the given name if any exist in this document, or null.
float
getBoost()
Returns the boost factor for this hit on any field of the underlying document.
Document
getDocument()
Returns document for this hit.
int
getId()
Returns id for this hit.
float
getScore()
Returns score for this hit.
String
toString()
Prints the parameters to be used to discover the promised result.

Method Details

get

public String get(String name)
            throws IOException
Returns the string value of the field with the given name if any exist in this document, or null. If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null.

getBoost

public float getBoost()
            throws IOException
Returns the boost factor for this hit on any field of the underlying document.

getDocument

public Document getDocument()
            throws IOException
Returns document for this hit.
See Also:
Hits.doc(int)

getId

public int getId()
            throws IOException
Returns id for this hit.

getScore

public float getScore()
            throws IOException
Returns score for this hit.

toString

public String toString()
Prints the parameters to be used to discover the promised result.

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.