nl.inl.blacklab.search

Class DocContentsFromForwardIndex

java.lang.Object

nl.inl.blacklab.search.DocContents

nl.inl.blacklab.search.DocContentsFromForwardIndex

public class DocContentsFromForwardIndex
extends DocContents

(Part of) the contents of a document, in separate annotations read from the forward indices. The tokens list in this class stores all the annotations for each word, in this order:

• punctuation before this word ("punct")
• all other annotations except punctuation and word (e.g. "lemma", "pos")
• the word itself ("word")

So if you had "lemma" and "pos" as extra annotations in addition to "punct" and "word", and you had 10 words of context, the List size would be 40. (The reason for the specific ordering is ease of converting it to XML, with the extra annotations being attributes and the word itself being the element content of the word tags)

Constructor Summary

Constructors

Constructor and Description
DocContentsFromForwardIndex(List<Annotation> annotations, List<String> tokens) Construct DocContentsFromForwardIndex object.

Method Summary

Modifier and Type	Method and Description
List<Annotation>	annotations()
List<String>	tokens()
List<String>	tokens(Annotation annotation) Get the tokens of a specific annotation
String	xml()

Methods inherited from class nl.inl.blacklab.search.DocContents

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocContentsFromForwardIndex

public DocContentsFromForwardIndex(List<Annotation> annotations,
                                   List<String> tokens)

Construct DocContentsFromForwardIndex object.

Parameters:

annotations - the order of annotations in the tokens list

tokens - the tokens

Method Detail

annotations

public List<Annotation> annotations()

tokens

public List<String> tokens()

tokens

public List<String> tokens(Annotation annotation)

Get the tokens of a specific annotation

Parameters:

annotation - annotation to get the tokens for

Returns:

the tokens

xml

public String xml()

Specified by:

xml in class DocContents