Method 

Description 

addIndex 

Add an index to the filter, returning an integer that can be used to identify the index in the selection functions. 

and 

Combine this filter with another filter in a logical "AND" operation. Only documents included in both filters will be included in this filter following an AND. 

andNot 

Combine this filter with another filter in a logical "AND NOT" operation. Only documents NOT included in the other filter will be included in this filter following an AND. 

clear 

Free memory allocated for the filter 

equals 

Compare two filters for equality 

getIndexCount 

Get number of indexes in this filter 

getIndexPath 

Get index path for an index in this filter 

getItems 

Get doc ids of documents in this filter 

or 

Combine this filter with another filter in a logical "OR" operation. All documents included in either filter will be included in this filter following an OR. 

read 

Read the search filter from a disk file. Returns 0 if the file was read successfully, or non-zero if an error occurred. 

readMultiple 

Read a series of search filters from disk files. The filenames list is a single string containing a list of quoted filenames. Returns the number of search filters read successfully. All of the search filters are logically combined with an "OR" operation. 

selectAll 

Select all of the documents in the index. 

selectItems 

Set the selection state of a range of document ids, from firstId to lastId, to the selection state indicated by fSelected. 

selectItemsBySearch 

Set the selection state of all documents in an index that match search request. Returns the number of documents that matched the search, or a negative value if the search failed. The searchRequest can contain File Conditions (such as filename or date searches) in addition to text searches. 

selectNone 

Select no documents in the index. By default, no documents are selected when a search filter is created, so there is no need to call selectNone to initialize the filter. 

write 

Save the search filter to a disk file. Returns 0 if the file was created successfully, or non-zero if an error occurred.