de.bea.domingo.proxy
Class DocumentCollectionProxy

java.lang.Object
  de.bea.domingo.monitor.AbstractMonitorEnabled
      de.bea.domingo.proxy.BaseProxy
          de.bea.domingo.proxy.BaseCollectionProxy
              de.bea.domingo.proxy.DocumentCollectionProxy

All Implemented Interfaces:

DBase, DDocumentCollection, MonitorEnabled, java.io.Serializable

public final class DocumentCollectionProxy
extends BaseCollectionProxy
implements DDocumentCollection

Represents the Domino-Class DocumentCollection.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseCollectionProxy

BaseCollectionProxy.ViewIterator

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy

BaseProxy.DocumentCollectionIterator

Field Summary

Fields inherited from class de.bea.domingo.proxy.BaseProxy

DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES

Constructor Summary

DocumentCollectionProxy(NotesProxyFactory theFactory, DBase parent, lotus.domino.DocumentCollection documentCollection, DNotesMonitor monitor)
Constructor.

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.
java.lang.String	toString() Returns a short description of an instance.

Methods inherited from class de.bea.domingo.proxy.BaseProxy

checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern

Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode

Constructor Detail

DocumentCollectionProxy

public DocumentCollectionProxy(NotesProxyFactory theFactory,
                               DBase parent,
                               lotus.domino.DocumentCollection documentCollection,
                               DNotesMonitor monitor)

Constructor.

Parameters:

theFactory - the controlling factory

parent - the parent object

documentCollection - the Notes DocumentCollection

monitor - the monitor

See Also:

DocumentCollection

Method Detail

toString

public java.lang.String toString()

Description copied from interface: DBase

Returns a short description of an instance.

Specified by:

toString in interface DBase

Overrides:

toString in class java.lang.Object

Returns:

"DocumentCollection"

See Also:

Object.toString()

getAllDocuments

public java.util.Iterator getAllDocuments()

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

Specified by:

getAllDocuments in interface DDocumentCollection

Returns:

Iterator

See Also:

DDocumentCollection.getAllDocuments()

fullTextSearch

public 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 DDocumentCollection.fullTextSearch(String, int) for more details.

Specified by:

fullTextSearch in interface DDocumentCollection

Parameters:

query - The full-text query

See Also:

DDocumentCollection.fullTextSearch(java.lang.String)

fullTextSearch

public 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.

Specified by:

fullTextSearch in interface DDocumentCollection

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.

See Also:

DDocumentCollection.fullTextSearch(java.lang.String, int)