Close
dtSearch Engine API for Java
SearchResults.getDocDetailMap Method
Syntax
Java
public void getDocDetailMap(java.util.Map table);

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 natural language search, the weighted score for the document.
  • _hitcount: number of hits found for this document.
  • _size: size of the document when indexed, in bytes.
  • _wordcount: number of words in the document when indexed.
  • _date: modification date of the document when indexed, in local date format.
  • _genericDate: modification date of the document when indexed, in generic date format (M03/D25/Y1997).
  • _time: modification time of the document in HH:MM:SS format.
  • _iindex: the index that the document was retrieved from (an index into the list in the IndexesToSearch list in the SearchJob).
  • _indexPath: path of the index that the document was retrieved from.
  • _docid: the document id for this document.
  • _hitsByWord: hit count for each search term, generated when the flag dtsSearchWantHitsByWord is set in SearchJob.
  • _hitDetails: hit count for each word matched by each search term, generated when the flag dtsSearchWantHitDetails is set in SearchJob.