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 

Method 

Description 

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. For example, getDocDetailItem("UserField") would return the contents of a field named "UserField".
Predefined fields have an underscore (_) in front of the field name. User-defined fields stored in an index using the StoredFields property of an IndexJob follow the predefined fields and do not have an underscore prefix.
The predefined fields are:

• _filename: full path name of the document.
• _displayName: if non-blank, an alternative name to display for the document (for example, the title of an HTML document).
• _title: the first 80 characters of the document.
• _score:... more 

getDocDetailItems 

Returns the same document fields as getDocDetailMap(), but formatted as a single string. The string will contain a sequence of name = value pairs, delimited with carriage-return/newlines (chr$(13) + chr$(10)). 

getDocDetailMap 

Builds a java.util.Map from the field information associated with a document. The map will contain a sequence of (name, value) pairs of strings. Predefined fields have an underscore (_) in front of the field name. User-defined fields stored in an index using the StoredFields property of an IndexJob follow the predefined fields and do not have an underscore prefix.
The predefined fields are:

• _filename: full path name of the document.
• _displayName: if non-blank, an alternative name to display for the document (for example, the title of an HTML document).
• _title: the first 80 characters of the document.
• _score: in a... more 

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. For information on using this data to highlight hits, see Highlighting Hits in the dtSearch Engine help file. 

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.

After a search, the dtSearch Engine provides a list of hits for each file retrieved. This list provides the word offset of each word in a file that matches the search request. The easiest way to highlight hits in files retrieved with the dtSearch Engine is to use a FileConverter to convert the retrieved file to an HTML document with the hits highlighted.

For plain text files, the dtSearch Engine provides an alternative method. Instead of highlighting the hits directly, the Engine... more 

getHitBytePageParaOffsets 

Generates a list of byte offsets of the hits in a file, for plain text files only. See getHitByteOffsets for details. 

getNthDoc 

Call GetNthDoc to select the nth document in the search results set and returns true if the document was selected. The item numbers range from 0 to getCount()-1. 

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. See Indexing and Searching Adobe Acrobat Files in the dtSearch Engine help file for more information. 

newSearchReportJob 

Use a SearchReportJob to generate a search report from some or all of the items listed in a SearchResults object. To create a SearchReportJob, call the SearchResults object's NewSearchReportJob method. Then set up the properties of the SearchReportJob to reflect the format of the report you want to create call the execute method of the SearchReportJob to create the report. 

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. After calling setSortKey() for each document, call sort(Constants.dtsSortBySortKey) to sort search results by the specified keys. 

sort 

 

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. This string can be inserted in an HTML link as part of the HREF. 

 

Data Member 

 

Method