com.hcl.domino.data

Interface DbQueryResult<CHAINTYPE extends DbQueryResult<?>>

All Known Subinterfaces:

DocumentSummaryQueryResult, FormulaQueryResult, FTQueryResult

All Known Implementing Classes:

DQLQueryResult

public interface DbQueryResult<CHAINTYPE extends DbQueryResult<?>>

Method Summary

Modifier and Type	Method and Description
<T> T	build(int skip, int count, CollectionSearchQuery.CollectionEntryProcessor<T> processor) Build a result out of the collection entries
default List<CollectionEntry>	collectEntries() Collect all CollectionEntry objects as list
List<CollectionEntry>	collectEntries(int skip, int count) Collect all CollectionEntry objects as list
void	collectEntries(int skip, int count, Collection<CollectionEntry> collection) Collect all CollectionEntry objects in a Collection
Set<Integer>	collectIds(int skip, int count) Return the note ids of the search result as an ordered Set.
void	collectIds(int skip, int count, Collection<Integer> idTable) Adds all note ids of the search result to a note ID collection, with special support for IDTables
CHAINTYPE	computeValues(Map<String,String> itemsAndFormulas) Dynamically computes virtual item values from the summary buffer data
CHAINTYPE	computeValues(String... itemsAndFormulas) Dynamically computes virtual item values from the summary buffer data
void	forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer) Iterates over each document in the search result
Stream<Document>	getDocuments()
Optional<IDTable>	getNoteIds() Returns an IDTable of documents matching the search.
Database	getParentDatabase() Returns the Database that was used to run the query
int	size() Returns the total number of results
CHAINTYPE	sort(DominoCollection collection) Sorts/filters the note ids of the search result like the specified DominoCollection.

Method Detail

getParentDatabase

Database getParentDatabase()

Returns the Database that was used to run the query

Returns:

database

getNoteIds

Optional<IDTable> getNoteIds()

Returns an IDTable of documents matching the search.

Returns:

an Optional describing the documents matched by the search, or an empty one if the search did not request a document collection

getDocuments

Stream<Document> getDocuments()

build

<T> T build(int skip,
            int count,
            CollectionSearchQuery.CollectionEntryProcessor<T> processor)

Build a result out of the collection entries

Type Parameters:

T - result type

Parameters:

skip - paging offset

count - paging count

processor - builder code to produce the result

Returns:

result

collectIds

Set<Integer> collectIds(int skip,
                        int count)

Return the note ids of the search result as an ordered Set.

Implementations are likely, but not guaranteed, to return a LinkedHashSet.

Parameters:

skip - paging offset

count - paging count

Returns:

set of note ids

collectIds

void collectIds(int skip,
                int count,
                Collection<Integer> idTable)

Adds all note ids of the search result to a note ID collection, with special support for IDTables

Parameters:

skip - paging offset

count - paging count

idTable - note ID collection

computeValues

CHAINTYPE computeValues(String... itemsAndFormulas)

Dynamically computes virtual item values from the summary buffer data

Parameters:

itemsAndFormulas - tuples with item name/formula; leave formula empty to read an existing document item, e.g. ["_created", "@Created", "Form", ""]

Returns:

this search query

computeValues

CHAINTYPE computeValues(Map<String,String> itemsAndFormulas)

Dynamically computes virtual item values from the summary buffer data

Parameters:

itemsAndFormulas - map of item/formula pairs

Returns:

this search query

sort

CHAINTYPE sort(DominoCollection collection)

Sorts/filters the note ids of the search result like the specified DominoCollection. Note ids that are not part of the collection will be ignored.

Parameters:

collection - collection

Returns:

this search query

collectEntries

default List<CollectionEntry> collectEntries()

Collect all CollectionEntry objects as list

Returns:

all entries

collectEntries

List<CollectionEntry> collectEntries(int skip,
                                     int count)

Collect all CollectionEntry objects as list

Parameters:

skip - paging offset

count - paging count

Returns:

list of collection entries

collectEntries

void collectEntries(int skip,
                    int count,
                    Collection<CollectionEntry> collection)

Collect all CollectionEntry objects in a Collection

Parameters:

skip - paging offset

count - paging count

collection - collection to add entries

forEachDocument

void forEachDocument(int skip,
                     int count,
                     BiConsumer<Document,Loop> consumer)

Iterates over each document in the search result

Parameters:

skip - paging offset

count - paging count

consumer - consumer to receive document

size

int size()

Returns the total number of results

Returns:

total