Links
dtSearch Text Retrieval Engine -- Java API 7.70
SearchJob Class
Classes | Legend | Members | Methods | Send Feedback

The SearchJob object performs searches with or without an index.

Class Hierarchy
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
Methods
Method 
Description 
Free memory allocated for SearchResults and the SearchFilter attached to this SearchJob. 
Execute the search, returning zero if the search succeeded, or a non-zero value if it failed. 
After a search, returns any errors that occurred during the search 
After a search, contains the number of files retrieved. 
After a search, contains the number of hits in all files retrieved. 
Returns the results of the search 
Returns a SearchFilter with all documents matching the search request, if setWantResultsAsFilter(true) was called before the search. 
AutoStopLimit causes a search to halt automatically when a specified number of documents have been found. 
Additional boolean conditions that a document must meet to be retrieved in a search. 
In an unindexed search, the name of a file containing list of directories to search. 
In an unindexed search, the directory to search. 
In an unindexed search, a file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters. 
Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20) 
In an indexed search, filename, date, or size criteria that a file must meet to be retrieved. 
Attach a SearchFilter to a search to limit the documents that can be retrieved 
If non-zero, the engine will match words that are close to but not identical to a search term. 
In an unindexed search, a file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters. 
Attach an IndexCache to a search to have the search re-use existing open indexes 

List of indexes to search. 
Use this property to limit the number of retrieved documents returned. 
Treat search request as a natural language search rather than a structured search request. 
If true, the engine will perform a phonic search for each of the words in the search request. 
Specifies the text to be found. 
Deprecated -- use SearchResults.getResults() to obtain search results after a search. 
SearchFlags value with various search options 
The object that will receive status notification messages from the engine while the search is in progress. 
If true, the engine will match grammatical variations of words in the search request, using the stemming rules in STEMMING.DAT. 
Enable synonym searching. 
Set to a non-zero value to force the search to halt after a specified time. 
UnindexedSearchFlags value with various search options for unindexed searches 
Enable synonym searching. 
Set before executing a search to obtain a SearchFilter containing the results of the search after the search is executed. 
Enable synonym searching. 
Enable synonym searching. 
Legend
 
Method 
Links
You are here: Classes > SearchJob Class
Copyright (c) 1998-2012 dtSearch Corp. All rights reserved.