org.egothor.core
Class Hit

java.lang.Object
  extended by org.egothor.core.Hit
Direct Known Subclasses:
Hit

public class Hit
extends java.lang.Object

Class Hit represents a hit of a query.

Author:
Leo Galambos

Field Summary
 int sim
          Similarity that was calculated for the given query and this hit.
 
Constructor Summary
Hit(DocumentData meta, int sim)
          Constructor for the Hit object.
 
Method Summary
 DocumentData getMeta()
          Return the metadata of the document that is represented by this hit.
 void setMeta(DocumentData meta)
          Sets the meta attribute of the Hit object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sim

public int sim
Similarity that was calculated for the given query and this hit.

Constructor Detail

Hit

public Hit(DocumentData meta,
           int sim)
Constructor for the Hit object.

Parameters:
meta - metadata of the document that is represented by the hit
sim - calculated similarity
Method Detail

setMeta

public void setMeta(DocumentData meta)
Sets the meta attribute of the Hit object

Parameters:
meta - the new metadata

getMeta

public DocumentData getMeta()
Return the metadata of the document that is represented by this hit.

Returns:
a DocMDocumentDataect containing the metadata