org.cdlib.xtf.textEngine
Class Snippet

Object
  extended by Snippet

public class Snippet
extends Object

Holds all the information regarding a specific text snippet within a document.

Author:
Martin Haye

Field Summary
 int endNode
          Node number of the last word in the hit
 int endOffset
          Word number of the last word in the hit, plus one
 int rank
          Rank of this snippet in the document, zero being the "best"
 float score
          Score of the snippet
 String sectionType
          'sectionType' from the original document, if any
 int startNode
          Node number of the first word in the hit
 int startOffset
          Word number of the first word in the hit
 String text
          Text of the snippet, including the hit and as much context as poss
 
Constructor Summary
Snippet()
           
 
Method Summary
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rank

public int rank
Rank of this snippet in the document, zero being the "best"


score

public float score
Score of the snippet


text

public String text
Text of the snippet, including the hit and as much context as poss


sectionType

public String sectionType
'sectionType' from the original document, if any


startNode

public int startNode
Node number of the first word in the hit


startOffset

public int startOffset
Word number of the first word in the hit


endNode

public int endNode
Node number of the last word in the hit


endOffset

public int endOffset
Word number of the last word in the hit, plus one

Constructor Detail

Snippet

public Snippet()