SearchResults Class

The SearchResults object provides access to the results of an in-memory search.

public class SearchResults;

File

SearchResults.java

Remarks

To create a SearchResults object containing the results of a search,

Set up a SearchJob to perform the search.
Call setMaxFilesToRetrieve to specify the maximum size of the SearchResults set.
Call execute() to execute the search()
After the search is complete, call the SearchJob's getResults method to get the search results.

Fields

Field	Description
stSortAscending	Sort in ascending order
stSortByDate	Sort by modification date
stSortByHits	Sort by hit count (or score, in a natural language search
stSortByIndex	Sort by the path to the index a document was found in
stSortByLocation	Sort by file location (usually the folder name)
stSortByName	Sort by filename
stSortBySize	Sort by file size
stSortByTime	Sort by file modification time (not date)
stSortByTitle	Sort by file title
stSortByType	Sort by file type
stSortByUserField	Sort by a user-defined field, proivded in the fieldName parameter
stSortCaseInsensitive	For string sorts, use a case-insensitive sort
stSortDescending	Sort in descending order
stSortNumeric	Sort strings in order by numeric value

Group

Classes

Methods

Method	Description
addDoc	Add a document to search results
empty	Remove all items from a search results list (this immediately frees memory needed for the items)
getCount	Number of documents in the search results
getDocCalendar	Document modified date
getDocDate	Document modified date
getDocDetailItem	Provides access to detailed information about the retrieved document in the DocDetails string.
getDocDetailItems	Returns the same document fields as getDocDetailMap(), but formatted as a single string.
getDocDetailMap	Builds a java.util.Map from the field information associated with a document.
getDocDisplayName	If non-blank, an alternative name to display for the document (for example, the title of an HTML document).
getDocHitCount	Number of hits found in the currently selected document.
getDocHits	An integer array containing the word offsets of the hits found in the currently selected document.
getDocId	Doc id of the currently selected document
getDocName	Name of the currently selected document
getDocSize	Size of the currently selected document, in bytes
getDocTypeId	TypeId identifying the file format of the currently selected document
getHitByteOffsets	Generates a list of byte offsets of the hits in a file, for plain text files only.
getHitBytePageParaOffsets	Generates a list of byte offsets of the hits in a file, for plain text files only.
getNthDoc	Call GetNthDoc to select the nth document in the search results set and returns true if the document was selected.
getRequest	Returns the search request that generated these results
makePdfWebHighlightFile	Generates xml data used to highlight hits in Adobe Reader through a web browser interface.
newSearchReportJob	Use a SearchReportJob to generate a search report from some or all of the items listed in a SearchResults object.
serializeAsXml	Generates a stream of XML containing data in the search results list.
serializeFromXml	Fills a SearchResults object with data from an XML stream generated by serializeAsXml
serializeItemAsXml	Generates a stream of XML data for a particular item in the search results list
setSortKey	Set the sort key for the currently-selected document.
sort	This is the overview for the sort method overload.
urlDecodeItem	UrlDecodeItem converts a string created by urlEncodeItem back into a search results item.
urlEncodeItem	urlEncodeItem creates a url-encoded string describing the currently-selected item in search results.

Legend

	Data Member
	Method

Links

Fields, Classes, Legend, Members, Methods, sort Method