|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.gouv.culture.sdx.search.lucene.query.ResultDocument
A result document of a search.
Constructor Summary | |
ResultDocument()
Creates a ResultDocument object A logger must be set and then this object must be setUp. |
Method Summary | |
void |
enableLogging(org.apache.avalon.framework.logger.Logger logger)
Sets the logger. |
org.apache.lucene.document.Document |
getDocument()
Returns the Lucene document associated with this result. |
java.lang.String |
getFieldValue(java.lang.String field)
Returns the value of a field within this document. |
float |
getScore()
Returns the relavance ranking for this document. |
void |
setUp(org.apache.lucene.document.Document doc,
float score)
Builds a ResultDocument with a Lucene document and a relavance ranking. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ResultDocument()
A logger must be set and then this object must be setUp.
enableLogging(org.apache.avalon.framework.logger.Logger)
,
setUp(org.apache.lucene.document.Document, float)
Method Detail |
public void setUp(org.apache.lucene.document.Document doc, float score) throws SDXException
doc
- The Lucene documentscore
- The relavance ranking
SDXException
public java.lang.String getFieldValue(java.lang.String field)
null
,
it will turn over a null
String
if the field does not exist.
field
- The name of the field.public float getScore()
public org.apache.lucene.document.Document getDocument()
public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
enableLogging
in interface org.apache.avalon.framework.logger.LogEnabled
logger
- The logger.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |