com.hcl.domino.data

Interface CollectionSearchQuery

All Superinterfaces:

SearchQuery

public interface CollectionSearchQuery
extends SearchQuery

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CollectionSearchQuery.AllCollapsedEntries
static class	CollectionSearchQuery.AllDeselectedEntries
static class	CollectionSearchQuery.AllExpandedEntries
static class	CollectionSearchQuery.AllSelectedEntries
static interface	CollectionSearchQuery.BasicCollectionEntryProcessor
static interface	CollectionSearchQuery.CollectionEntryProcessor<T> Builder interface that takes the collection entries and produces a result.
static class	CollectionSearchQuery.ExpandedEntries
static class	CollectionSearchQuery.ExpandMode
static class	CollectionSearchQuery.MultiColumnLookupKey
static class	CollectionSearchQuery.SelectedEntries
static class	CollectionSearchQuery.SelectMode
static class	CollectionSearchQuery.SingleColumnLookupKey

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
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 IDTable
CollectionSearchQuery	deselectByKey(List<Object> key, boolean exact) Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.deselectAll() and CollectionSearchQuery.AllDeselectedEntries.selectByKey(List, boolean).
CollectionSearchQuery	deselectByKey(String key, boolean exact) Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.selectAll() and CollectionSearchQuery.AllSelectedEntries.deselectByKey(String, boolean).
CollectionSearchQuery	direction(Navigate mode) Direction and read mode
CollectionSearchQuery	expand(CollectionSearchQuery.ExpandedEntries expandedEntries) Configure which elements are expanded
default Optional<CollectionEntry>	firstEntry() Returns the first CollectionEntry
default Optional<Integer>	firstId() Returns the first CollectionEntry
default void	forEach(CollectionSearchQuery.BasicCollectionEntryProcessor processor) Iterates through all selected entries and performs an action on each.
void	forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer)
CollectionSearchQuery	readColumnValues() Decodes the collection column values, they can be read via TypedAccess.get(String, Class, Object) or TypedAccess.getAsList(String, Class, List).
CollectionSearchQuery	readDocumentClass() Reads the document class for each view entry.
CollectionSearchQuery	readSpecialValues(Collection<CollectionEntry.SpecialValue> values) Read additional meta data for the collection entries or their document
CollectionSearchQuery	readSpecialValues(CollectionEntry.SpecialValue... values) Read additional meta data for the collection entries or their document
CollectionSearchQuery	readUNID() Reads the UNID of each collection entry.
CollectionSearchQuery	select(CollectionSearchQuery.SelectedEntries selectedEntries) Configure which elements are selected
CollectionSearchQuery	selectByKey(List<Object> key, boolean exact) Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.selectAll() and CollectionSearchQuery.AllSelectedEntries.deselectByKey(List, boolean).
CollectionSearchQuery	selectByKey(String key, boolean exact) Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.deselectAll() and CollectionSearchQuery.AllDeselectedEntries.selectByKey(String, boolean).
int	size() Slow method to compute the total number of collection entries
CollectionSearchQuery	startAtCategory(List<Object> categoryLevels) Restricts search result to a single category
CollectionSearchQuery	startAtCategory(String category) Restrict search result to a single category
CollectionSearchQuery	startAtEntryId(int noteId) Start reading view data at an entry with the specified note id
CollectionSearchQuery	startAtFirstEntry() Start reading view data at first entry
CollectionSearchQuery	startAtLastEntry() Start reading at last view row
CollectionSearchQuery	startAtPosition(String pos) Start reading at a fixed collection position.

Method Detail

startAtFirstEntry

CollectionSearchQuery startAtFirstEntry()

Start reading view data at first entry

Returns:

this search query

startAtEntryId

CollectionSearchQuery startAtEntryId(int noteId)

Start reading view data at an entry with the specified note id

Parameters:

noteId - note id

Returns:

this search query

startAtPosition

CollectionSearchQuery startAtPosition(String pos)

Start reading at a fixed collection position. Please note that this position is not a unique identifier for entries, it may change over time when the view index changes.

Parameters:

pos - position string, e.g. "1.2.1"

Returns:

this search query

startAtLastEntry

CollectionSearchQuery startAtLastEntry()

Start reading at last view row

Returns:

this search query

startAtCategory

CollectionSearchQuery startAtCategory(String category)

Restrict search result to a single category

Parameters:

category - category, use "\" for multiple category levels

Returns:

this search query

startAtCategory

CollectionSearchQuery startAtCategory(List<Object> categoryLevels)

Restricts search result to a single category

Parameters:

categoryLevels - different levels of category values, supports strings and TemporalAccessor objects

Returns:

this search query

expand

CollectionSearchQuery expand(CollectionSearchQuery.ExpandedEntries expandedEntries)

Configure which elements are expanded

Parameters:

expandedEntries - use CollectionSearchQuery.ExpandedEntries.expandAll() or CollectionSearchQuery.ExpandedEntries.collapseAll() to start building this object

Returns:

this search query

select

CollectionSearchQuery select(CollectionSearchQuery.SelectedEntries selectedEntries)

Configure which elements are selected

Parameters:

selectedEntries - use CollectionSearchQuery.SelectedEntries.selectAll() or CollectionSearchQuery.SelectedEntries.deselectAll() to start building this object

Returns:

this search query

selectByKey

CollectionSearchQuery selectByKey(String key,
                                  boolean exact)

Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.deselectAll() and CollectionSearchQuery.AllDeselectedEntries.selectByKey(String, boolean).

Parameters:

key - lookup key

exact - true for exact match, false for prefix search

Returns:

this search query

selectByKey

CollectionSearchQuery selectByKey(List<Object> key,
                                  boolean exact)

Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.selectAll() and CollectionSearchQuery.AllSelectedEntries.deselectByKey(List, boolean).

Parameters:

key - lookup key

exact - true for exact match, false for prefix search

Returns:

this search query

deselectByKey

CollectionSearchQuery deselectByKey(String key,
                                    boolean exact)

Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.selectAll() and CollectionSearchQuery.AllSelectedEntries.deselectByKey(String, boolean).

Parameters:

key - lookup key

exact - true for exact match, false for prefix search

Returns:

this search query

deselectByKey

CollectionSearchQuery deselectByKey(List<Object> key,
                                    boolean exact)

Convenience method that calls select(SelectedEntries) with CollectionSearchQuery.SelectedEntries.deselectAll() and CollectionSearchQuery.AllDeselectedEntries.selectByKey(List, boolean).

Parameters:

key - lookup key

exact - true for exact match, false for prefix search

Returns:

this search query

direction

CollectionSearchQuery direction(Navigate mode)

Direction and read mode

Parameters:

mode - mode

Returns:

this search query

readColumnValues

CollectionSearchQuery readColumnValues()

Decodes the collection column values, they can be read via TypedAccess.get(String, Class, Object) or TypedAccess.getAsList(String, Class, List).

Returns:

this search query

readUNID

CollectionSearchQuery readUNID()

Reads the UNID of each collection entry.

Returns:

this search query

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

forEach

default void forEach(CollectionSearchQuery.BasicCollectionEntryProcessor processor)

Iterates through all selected entries and performs an action on each.

This is equivalent to calling build(int, int, CollectionEntryProcessor) with a processor that performs no action on start/end and returns no value.

Parameters:

processor - the processor to execute on each entry

Since:

1.0.18

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 IDTable

Parameters:

skip - paging offset

count - paging count

idTable - note ID collection

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

firstEntry

default Optional<CollectionEntry> firstEntry()

Returns the first CollectionEntry

Returns:

an Optional describing the first entry, or an empty Optional if there are no matched entries

firstId

default Optional<Integer> firstId()

Returns the first CollectionEntry

Returns:

an Optional describing the first entry's note ID, or an empty Optional if there are no matched entries

collectEntries

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

Collect all CollectionEntry objects in a Collection

Parameters:

skip - the number of entries to skip when collecting

count - the maximum number of entries to collect

collection - collection to add entries

size

int size()

Slow method to compute the total number of collection entries

Returns:

total

readSpecialValues

CollectionSearchQuery readSpecialValues(CollectionEntry.SpecialValue... values)

Read additional meta data for the collection entries or their document

Parameters:

values - special values

Returns:

this search query

readSpecialValues

CollectionSearchQuery readSpecialValues(Collection<CollectionEntry.SpecialValue> values)

Read additional meta data for the collection entries or their document

Parameters:

values - special values

Returns:

this search query

readDocumentClass

CollectionSearchQuery readDocumentClass()

Reads the document class for each view entry.

Returns:

this search query

Since:

1.0.18

forEachDocument

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