com.hcl.domino.dbdirectory

Interface DirectorySearchQuery

All Superinterfaces:

SearchQuery

public interface DirectorySearchQuery
extends SearchQuery

With this query you can scan for files and subdirectories in a directory (either locally or on the server).

Specify a formula argument to improve efficiency when processing a subset of the notes in a database.

In addition, the formula argument can be used to return computed "on-the-fly" information.

To do this, you specify that a value returned from a formula is to be stored in a temporary field of each note.

This temporary field and its value is then accessible in the summary buffer received by the NSFSearch action routine without having to open the note.

For example, suppose you want the size of each note found by NSFSearch.
Do the following before the call to NSFSearch:
Call search with a formula like this:
"DEFAULT dLength := @DocLength; @All"
and specify DirectorySearchQuery.SearchFlag.SUMMARY for the SearchFlags argument.

In the action routine of NSFSearch, if you get a search match, look at the summary information.
The dLength field will be one of the items in the summary information buffer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DirectorySearchQuery.SearchFlag Flags to control result of the Database.queryDQL(com.hcl.domino.dql.DQL.DQLTerm).

Method Summary

Modifier and Type	Method and Description
void	forEach(int skip, int limit, BiConsumer<DirEntry,Loop> consumer) Iterates over each DirEntry in the search result
DirectorySearchQuery	since(TemporalAccessor since) The date of the earliest modified file that is matched.
Stream<DirEntry>	stream() Returns a Stream of DirEntry, e.g.
DirectorySearchQuery	withDirectory(String directory) Configure the directory to scan in
DirectorySearchQuery	withFileTypes(Collection<FileType> fileTypes) Set the types of file to be returned by the query.
DirectorySearchQuery	withFlags(Collection<DirectorySearchQuery.SearchFlag> searchFlags) Configures some flags for the query.
DirectorySearchQuery	withFormula(String formula) Configures a formula for the search.
DirectorySearchQuery	withServer(String server) Configures a server for the search.

Method Detail

withServer

DirectorySearchQuery withServer(String server)

Configures a server for the search.

Parameters:

server - the server

Returns:

the refined query

withDirectory

DirectorySearchQuery withDirectory(String directory)

Configure the directory to scan in

Parameters:

directory - directory ("" for top level)

Returns:

the refined query

withFormula

DirectorySearchQuery withFormula(String formula)

Configures a formula for the search. Note: When performing the search, it might throw a FormulaCompilationException

Parameters:

formula - the formula

Returns:

the refined query

withFlags

DirectorySearchQuery withFlags(Collection<DirectorySearchQuery.SearchFlag> searchFlags)

Configures some flags for the query.

Parameters:

searchFlags - the flags to be used

Returns:

the refined query

withFileTypes

DirectorySearchQuery withFileTypes(Collection<FileType> fileTypes)

Set the types of file to be returned by the query.

Parameters:

fileTypes - the file-types

Returns:

the refined query

since

DirectorySearchQuery since(TemporalAccessor since)

The date of the earliest modified file that is matched. The note's "Modified in this file" date is compared to this date.

Parameters:

since - the time or null if you do not wish any filtering by date

Returns:

the refined query

forEach

void forEach(int skip,
             int limit,
             BiConsumer<DirEntry,Loop> consumer)
      throws DominoException

Iterates over each DirEntry in the search result

Parameters:

skip - paging offset

limit - paging count

consumer - consumer to receive document

Throws:

DominoException - thrown if an error occured, e.g. the formula could not be evaluated

stream

Stream<DirEntry> stream()
                 throws DominoException

Returns a Stream of DirEntry, e.g. to map them to your own objects

Returns:

stream

Throws:

DominoException - thrown if an error occured, e.g. the formula could not be evaluated