Conducts a full-text search of all the documents in a document collection, and reduces the collection to a sorted collection of those documents that match.

Defined in

DocumentCollection

Syntax

public void FTSearch(String query)
   throws NotesException

public void FTSearch(String query, int maxdocs)
   throws NotesException

Parameters

String query

The full-text query. See the section "Query Syntax" that follows.

The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.

This method moves the current pointer to the first document in the collection.

The collection of documents that match the full-text query are sorted by relevance, with highest relevance first. You can access the relevance score of each document in the collection using getFTSearchScore Document.

If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use isFTIndexed. To create an index on a local database, use updateFTIndex.

This method searches all documents in a document collection. To search all documents in a database, use FTSearch in Database. To search only documents found in a particular view, use FTSearch in View or FTSearch in ViewEntryCollection.

Query syntax

To search for a word or phrase, enter the word or phrase as is, except that search keywords must be enclosed in quotes. Remember to escape quotes if you are inside a literal.

Wildcards, operators, and other syntax are permitted. For the complete syntax rules, see "Refining a search query using operators" in Lotus Notes Help. Search for "query syntax" in the Domino Designer Eclipse help system or information center (for example, http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/index.jsp), both of which include Lotus Notes.

Language cross-reference

FTSearch method in LotusScript NotesDocumentCollection class

Example
See Also

Collecting all documents and all unprocessed documents
Collecting documents by searching in Java classes

Glossary