com.hcl.domino.data

Interface FTQueryResult

All Superinterfaces:

DbQueryResult<FTQueryResult>

public interface FTQueryResult
extends DbQueryResult<FTQueryResult>

Container for a FT search result

Author:

Karsten Lehmann

Method Summary

Modifier and Type	Method and Description
List<String>	getHighlightStrings() When using FTQuery.RETURN_HIGHLIGHT_STRINGS, this method returns the search strings parsed from the FT query.
List<NoteIdWithScore>	getMatchesWithScore() Returns the sorted note ids of search matches with their search score (0-255).
Optional<IDTable>	getNoteIds() Returns an IDTable of documents matching the search.
int	getNumDocs() Returns the number of documents returned in the results, may be less than getNumHits() if Database.queryFTIndex(String, int, java.util.Set, java.util.Set, int, int) is used with paging parameters.
int	getNumHits() Returns the actual number of documents found for this search.
long	getSearchDuration() Returns the duration the search took in milliseconds

Methods inherited from interface com.hcl.domino.data.DbQueryResult

build, collectEntries, collectEntries, collectEntries, collectIds, collectIds, computeValues, computeValues, forEachDocument, getDocuments, getParentDatabase, size, sort

Method Detail

getSearchDuration

long getSearchDuration()

Returns the duration the search took in milliseconds

Returns:

duration

getNumHits

int getNumHits()

Returns the actual number of documents found for this search. This number may be greater than getNumDocs() if Database.queryFTIndex(String, int, java.util.Set, java.util.Set, int, int) is used with paging parameters.

Returns:

hits

getNumDocs

int getNumDocs()

Returns the number of documents returned in the results, may be less than getNumHits() if Database.queryFTIndex(String, int, java.util.Set, java.util.Set, int, int) is used with paging parameters.

Returns:

count

getNoteIds

Optional<IDTable> getNoteIds()

Returns an IDTable of documents matching the search.

Specified by:

getNoteIds in interface DbQueryResult<FTQueryResult>

Returns:

an Optional describing the IDTable if ftSearch method has been used or ftSearchExt has been called with FTQuery.RETURN_IDTABLE option (and we have any hits), or an empty one if it was not

getMatchesWithScore

List<NoteIdWithScore> getMatchesWithScore()

Returns the sorted note ids of search matches with their search score (0-255).

Returns:

matches with note id and search score

getHighlightStrings

List<String> getHighlightStrings()

When using FTQuery.RETURN_HIGHLIGHT_STRINGS, this method returns the search strings parsed from the FT query. E.g. for a query "(greg* or west*) and higg*", the list contains "greg*", "west*" and "higg*".

Returns:

hightlight strings or empty list