SearchJob Class

The SearchJob object performs searches with or without an index.

public class SearchJob;

File

SearchJob.java

Remarks

To perform a search, make a SearchJob, use the properties to describe the task you want the engine to perform, and call the execute() method. After the search, use the getResults() method to obtain a SearchResults object with the results of the search.

Errors

After executing a SearchJob, call getErrors() to check for any errors that may have occurred during the job.

For search request syntax, see:

Search Requests in Overviews

For information on optimizing search speed, see:

Optimizing Search Performance

Group

Classes

Methods

Method	Description
clear	Free memory allocated for SearchResults and the SearchFilter attached to this SearchJob.
execute	Execute the search, returning zero if the search succeeded, or a non-zero value if it failed.
getErrors	After a search, returns any errors that occurred during the search
getFileCount	After a search, contains the number of files retrieved.
getHitCount	After a search, contains the number of hits in all files retrieved.
getResults	Returns the results of the search
getResultsAsFilter	Returns a SearchFilter with all documents matching the search request, if setWantResultsAsFilter(true) was called before the search.
setAutoStopLimit	AutoStopLimit causes a search to halt automatically when a specified number of documents have been found.
setBooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search.
setDirListName	In an unindexed search, the name of a file containing list of directories to search.
setDirToSearch	In an unindexed search, the directory to search.
setExcludeFilters	In an unindexed search, a file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
setFieldWeights	Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20)
setFileConditions	In an indexed search, filename, date, or size criteria that a file must meet to be retrieved.
setFilter	Attach a SearchFilter to a search to limit the documents that can be retrieved
setFuzziness	If non-zero, the engine will match words that are close to but not identical to a search term.
setIncludeFilters	In an unindexed search, a file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
setIndexCache	Attach an IndexCache to a search to have the search re-use existing open indexes
setIndexesToSearch	List of indexes to search.
setMaxFilesToRetrieve	Use this property to limit the number of retrieved documents returned.
setNaturalLanguage	Treat search request as a natural language search rather than a structured search request.
setPhonicSearching	If true, the engine will perform a phonic search for each of the words in the search request.
setRequest	Specifies the text to be found.
setResults	Deprecated -- use SearchResults.getResults() to obtain search results after a search.
setSearchFlags	SearchFlags value with various search options
setStatusHandler	The object that will receive status notification messages from the engine while the search is in progress.
setStemming	If true, the engine will match grammatical variations of words in the search request, using the stemming rules in STEMMING.DAT.
setSynonyms	Enable synonym searching.
setTimeoutSeconds	Set to a non-zero value to force the search to halt after a specified time.
setUnindexedSearchFlags	UnindexedSearchFlags value with various search options for unindexed searches
setUserSynonyms	Enable synonym searching.
setWantResultsAsFilter	Set before executing a search to obtain a SearchFilter containing the results of the search after the search is executed.
setWordNetRelated	Enable synonym searching.
setWordNetSynonyms	Enable synonym searching.

Legend

Method

Links

Classes, Legend, Members, Methods