nl.inl.blacklab.search

Interface Doc

All Known Implementing Classes:

DocImpl

public interface Doc

Combination of a document in the everse index, forward index and content store. Note that Doc, like Hit, can be ephemeral, so call save() if you need an immutable copy of it.

Method Summary

Modifier and Type	Method and Description
void	characterOffsets(Field field, int[] startsOfWords, int[] endsOfWords, boolean fillInDefaultsIfNotFound)
default String	contents() Get the document contents (original XML).
default String	contents(Field field) Get the contents of a field from a Lucene Document.
String	contents(Field field, int startAtWord, int endAtWord) Get part of the contents of a field from a Lucene Document.
String	contentsByCharPos(Field field, int startAtChar, int endAtChar) Get part of the contents of a field from a Lucene Document.
boolean	equals(Object obj)
static Doc	get(BlackLabIndex index, int id)
int	hashCode()
default String	highlightContent(Hits hits) Highlight field content with the specified hits.
String	highlightContent(Hits hits, int startAtWord, int endAtWord) Highlight part of field content with the specified hits, and make sure it's well-formed.
int	id()
BlackLabIndex	index()
boolean	isLuceneDocCached() Have we loaded and cached the Lucene document?
org.apache.lucene.document.Document	luceneDoc() Retrieve a Lucene Document object from the index.
List<Concordance>	makeConcordancesFromContentStore(Field field, int[] startsOfWords, int[] endsOfWords, XmlHighlighter hl) Determine the concordance strings for a number of concordances, given the relevant character positions.

Method Detail

get

static Doc get(BlackLabIndex index,
               int id)

index

BlackLabIndex index()

Returns:

index this document came from (may be a wrapped LeafReader or CompositeReader)

id

int id()

Returns:

Lucene id of the document.

luceneDoc

org.apache.lucene.document.Document luceneDoc()

Retrieve a Lucene Document object from the index. NOTE: you must check if the document isn't deleted using Search.isDeleted() first! Lucene 4.0+ allows you to retrieve deleted documents, making you responsible for checking whether documents are deleted or not. (This doesn't apply to search results; searches should never produce deleted documents. It does apply when you're e.g. iterating over all documents in the index)

Parameters:

docId - the document id

Returns:

the Lucene Document

Throws:

RuntimeException - if the document doesn't exist (use maxDoc() and isDeleted() to check first!)

isLuceneDocCached

boolean isLuceneDocCached()

Have we loaded and cached the Lucene document?

Returns:

true iff we have loaded the Lucene document already

contentsByCharPos

String contentsByCharPos(Field field,
                         int startAtChar,
                         int endAtChar)

Get part of the contents of a field from a Lucene Document. This takes into account that some fields are stored externally in content stores instead of in the Lucene index.

Parameters:

field - the field

startAtChar - where to start getting the content (-1 for start of document, 0 for first char)

endAtChar - where to end getting the content (-1 for end of document)

Returns:

the field content

contents

default String contents(Field field)

Get the contents of a field from a Lucene Document. This takes into account that some fields are stored externally in content stores instead of in the Lucene index.

Parameters:

docId - the Document id

field - the field

Returns:

the field content

contents

default String contents()

Get the document contents (original XML).

Parameters:

docId - the Document id

Returns:

the field content

contents

String contents(Field field,
                int startAtWord,
                int endAtWord)

Get part of the contents of a field from a Lucene Document. This takes into account that some fields are stored externally in content stores instead of in the Lucene index.

Parameters:

field - the field

startAtWord - where to start getting the content (-1 for start of document, 0 for first word)

endAtWord - where to end getting the content (-1 for end of document)

Returns:

the field content

highlightContent

String highlightContent(Hits hits,
                        int startAtWord,
                        int endAtWord)

Highlight part of field content with the specified hits, and make sure it's well-formed. Uses <hl></hl> tags to highlight the content.

Parameters:

hits - the hits

startAtWord - where to start highlighting (first word returned)

endAtWord - where to end highlighting (first word not returned)

Returns:

the highlighted content

highlightContent

default String highlightContent(Hits hits)

Highlight field content with the specified hits. Uses <hl></hl> tags to highlight the content.

Parameters:

docId - document to highlight a field from

hits - the hits

Returns:

the highlighted content

characterOffsets

void characterOffsets(Field field,
                      int[] startsOfWords,
                      int[] endsOfWords,
                      boolean fillInDefaultsIfNotFound)

makeConcordancesFromContentStore

List<Concordance> makeConcordancesFromContentStore(Field field,
                                                   int[] startsOfWords,
                                                   int[] endsOfWords,
                                                   XmlHighlighter hl)

Determine the concordance strings for a number of concordances, given the relevant character positions. Every concordance requires four character positions: concordance start and end, and hit start and end. Visualising it ('fox' is the hit word): [A] the quick brown [B] fox [C] jumps over the [D] The startsOfWords array contains the [A] and [B] positions for each concordance. The endsOfWords array contains the [C] and [D] positions for each concordance.

Parameters:

doc - the Lucene document number

field - the field

startsOfWords - the array of starts of words ([A] and [B] positions)

endsOfWords - the array of ends of words ([C] and [D] positions)

hl -

Returns:

the list of concordances

equals

boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object