org.tm4j.topicmap.index.text
Interface QueryHit

All Known Implementing Classes:

LuceneQueryHitImpl

public interface QueryHit

This interface defines methods for accessing a concrete hit when quering the full text index

Author:

Harald Kuhn, harald_kuhn at users.sourceforge.net

Method Summary

TopicMapObject	getObject() Returns the TopicMapObject which is associated with this Hit The String value that caused the hit is probably stored in one of the properties of the object.
float	getScore() Returns the score rating given to this hit by the used search engine

Method Detail

getObject

public TopicMapObject getObject()

Returns the TopicMapObject which is associated with this Hit The String value that caused the hit is probably stored in one of the properties of the object. The field is dependant of the concrete implementation returned. Occurrence data or dataLocator // depends on wether use uri´s is activated BaseName data Variant variantName.data

Returns:

the TopicMapObject which contains the hit in its value

getScore

public float getScore()

Returns the score rating given to this hit by the used search engine

Returns:

a boolean value ranging from 0 to 1