Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query. This method does not find word variants.

Defined in

View

Syntax

public int FTSearch(String query)
   throws NotesException

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

Parameters

String query

The full-text query. See below.

The maximum number of documents you want returned from the search. If you want to receive all documents that match the query, specify 0.

int

The number of documents in the view after the search. Each of these documents matches the query.

After calling FTSearch, you can use the regular View methods to navigate the result, which is a subset of the documents in the view. If the database is not full-text indexed, the documents in the subset are in the same order as they are in the original view. However, if the database is full-text indexed, the documents in the subset are sorted into descending order of relevance. The method getFirstDocument returns the first document in the subset, getLastDocument returns the last document, and so on.

Use the clear method to clear the full-text search filtering. The View methods now navigate to the full set of documents in the view.

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.

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 "Finding documents in a database" in Lotus Notes Help.

Language cross-reference

FTSearch method in LotusScript NotesView class

ViewShowOnlySearchResults @command in formula language

Example
See Also

Working with view entries and navigators

Glossary