nl.inl.blacklab.search

Class DocImpl

java.lang.Object

nl.inl.blacklab.search.DocImpl

All Implemented Interfaces:

Doc

public class DocImpl
extends Object
implements Doc

Constructor Summary

Constructors

Constructor and Description
DocImpl(BlackLabIndex index, int id)

Method Summary

Modifier and Type	Method and Description
void	characterOffsets(Field field, int[] startsOfWords, int[] endsOfWords, boolean fillInDefaultsIfNotFound)
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)
int	hashCode()
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.inl.blacklab.search.Doc

contents, contents, get, highlightContent

Constructor Detail

DocImpl

public DocImpl(BlackLabIndex index,
               int id)

Method Detail

index

public BlackLabIndex index()

Specified by:

index in interface Doc

Returns:

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

id

public int id()

Specified by:

id in interface Doc

Returns:

Lucene id of the document.

luceneDoc

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

Description copied from interface: Doc

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)

Specified by:

luceneDoc in interface Doc

Returns:

the Lucene Document

isLuceneDocCached

public boolean isLuceneDocCached()

Description copied from interface: Doc

Have we loaded and cached the Lucene document?

Specified by:

isLuceneDocCached in interface Doc

Returns:

true iff we have loaded the Lucene document already

characterOffsets

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

Specified by:

characterOffsets in interface Doc

contentsByCharPos

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

Description copied from interface: Doc

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.

Specified by:

contentsByCharPos in interface Doc

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

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

Description copied from interface: Doc

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.

Specified by:

contents in interface Doc

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

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

Description copied from interface: Doc

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

Specified by:

highlightContent in interface Doc

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

makeConcordancesFromContentStore

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

Description copied from interface: Doc

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.

Specified by:

makeConcordancesFromContentStore in interface Doc

Parameters:

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)

Returns:

the list of concordances

hashCode

public int hashCode()

Specified by:

hashCode in interface Doc

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Doc

Overrides:

equals in class Object