de.bea.domingo
Interface DDocumentCollection

All Superinterfaces:

DBase, java.io.Serializable

All Known Implementing Classes:

DocumentCollectionProxy

public interface DDocumentCollection
extends DBase

Represents a collection of documents and provides access to documents within it.

Author:

Kurt Riede

Method Summary

void	fullTextSearch(java.lang.String query) 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.
void	fullTextSearch(java.lang.String query, int maxdocs) 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.
java.util.Iterator	getAllDocuments() Returns an Iterator to loop over all documents in the view.

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode, toString

Method Detail

getAllDocuments

java.util.Iterator getAllDocuments()

Returns an Iterator to loop over all documents in the view.

Returns:

Iterator

fullTextSearch

void fullTextSearch(java.lang.String query)

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.

See fullTextSearch(String, int) for more details.

Parameters:

query - The full-text query

fullTextSearch

void fullTextSearch(java.lang.String query,
                    int maxdocs)

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.

Usage

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 DDocument.getFTSearchScore() in DDocument.

If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use DDatabase.isFTIndexed().

To create an index on a local database, use DDatabase.updateFTIndex(boolean).

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

Parameters:

query - The full-text query

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