DSearchReportJob Class

Describes a search report to be prepared from some or all of the items in a DSearchResults set.

File

File: dtsfc.h

Namespace: dtSearch

DSearchReportJob Constructor

Syntax

C++

class DSearchReportJob : public DOutputBase;

Data Members

Show:Inherited

No members matching the current filter

Data Member	Description
AfterHit	Text inserted after each hit (Inherited from DOutputBase)
BeforeHit	Text inserted before each hit (Inherited from DOutputBase)
ContextFooter	Text to appear after each block of context
ContextHeader	Text to appear in front of each block of context.
ContextSeparator	Text to appear between blocks of context (after the ContextFooter)
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output (Inherited from DOutputBase)
FileFooter	Text to appear after each file in the search report
FileHeader	Text to appear after each file in the search report
Footer	Text inserted at the end of the file (Inherited from DOutputBase)
Header	Text inserted at the start of the file (Inherited from DOutputBase)
HtmlBaseHref	For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from DOutputBase)
HtmlHead	For HTML output, HTML tags to insert in the header (Inherited from DOutputBase)
OutputFile	Name of file to create, if the output is to be written to a file. (Inherited from DOutputBase)

Group

Classes

Members

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
AttachResults	Attach search results to the DSearchReportJob. Unlike SetResults, AttachResults provides the option not to make a copy of the search results
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Clear all fields to default values (Inherited from DOutputBase)
ClearSelections	Clear all selections previously made using SelectAll or SelectRange
DSearchReportJob()	Constructor for a DSearchReportJob with no associated search results list.
DSearchReportJob(dtsSearchResults&)	Constructor for a DSearchReportJob associated with a search results list
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job. (Inherited from DOutputBase)
Execute	Generate the report
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFlags	Get ReportFlags for this report
GetOutputString	If output was to a string, returns a pointer to the output string (Inherited from DOutputBase)
GetOutputStringLen	Get the length of the output string (Inherited from DOutputBase)
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string (Inherited from DOutputBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DOutputBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError	(Inherited from DOutputBase)
OnOutput	Callback function to receive output as it is generated (Inherited from DOutputBase)
OnPercentDone	Callback function to update the progress of the conversion or search report (Inherited from DOutputBase)
OnQuestion	Not used (Inherited from DJobBase)
SelectAll	Select all items in the SearchResults.
SelectRange	Select a range of items in the SearchResults
SetContextParagraphs	Set the amount of context around each hit as a number of paragraphs
SetContextWholeFile	Include the whole file for each item in search results
SetContextWords	Set the number of words of context around each hit, and specify whether the exact number of words should be collected. If fExact is false, enough paragraphs will be collected around each hit to include at least the specified number of words.
SetDocExtractor	! Internal use only
SetFlags	Set ReportFlags for this report
SetMaxContextBlocks	Number of blocks of context to include in the report for each document.
SetMaxWordsToRead	Number of words to scan in each document looking for blocks of context to include in the report For example, if maxWordsToRead=5000, then the search report will only include hits that occur in the first 5000 words in each document. This setting can be used to generate faster (but not necessarily complete) reports by limiting the search report to hits near the beginning of each document
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi. (Inherited from DOutputBase)
SetOutputToCallback	Send output only to the virtual callback function, OnOutput (Inherited from DOutputBase)
SetOutputToFile	Send output to a file (Inherited from DOutputBase)
SetOutputToString	Send output to a string buffer managed by the class, and set the maximum length of the output string. (Inherited from DOutputBase)
SetResults	Attach search results to the DSearchReportJob, making a private internal copy of the search results.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Data Members

Show:Inherited

No members matching the current filter

Data Member	Description
AfterHit	Text inserted after each hit (Inherited from DOutputBase)
BeforeHit	Text inserted before each hit (Inherited from DOutputBase)
ContextFooter	Text to appear after each block of context
ContextHeader	Text to appear in front of each block of context.
ContextSeparator	Text to appear between blocks of context (after the ContextFooter)
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output (Inherited from DOutputBase)
FileFooter	Text to appear after each file in the search report
FileHeader	Text to appear after each file in the search report
Footer	Text inserted at the end of the file (Inherited from DOutputBase)
Header	Text inserted at the start of the file (Inherited from DOutputBase)
HtmlBaseHref	For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from DOutputBase)
HtmlHead	For HTML output, HTML tags to insert in the header (Inherited from DOutputBase)
OutputFile	Name of file to create, if the output is to be written to a file. (Inherited from DOutputBase)

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
AttachResults	Attach search results to the DSearchReportJob. Unlike SetResults, AttachResults provides the option not to make a copy of the search results
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Clear all fields to default values (Inherited from DOutputBase)
ClearSelections	Clear all selections previously made using SelectAll or SelectRange
DSearchReportJob()	Constructor for a DSearchReportJob with no associated search results list.
DSearchReportJob(dtsSearchResults&)	Constructor for a DSearchReportJob associated with a search results list
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job. (Inherited from DOutputBase)
Execute	Generate the report
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFlags	Get ReportFlags for this report
GetOutputString	If output was to a string, returns a pointer to the output string (Inherited from DOutputBase)
GetOutputStringLen	Get the length of the output string (Inherited from DOutputBase)
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string (Inherited from DOutputBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DOutputBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError	(Inherited from DOutputBase)
OnOutput	Callback function to receive output as it is generated (Inherited from DOutputBase)
OnPercentDone	Callback function to update the progress of the conversion or search report (Inherited from DOutputBase)
OnQuestion	Not used (Inherited from DJobBase)
SelectAll	Select all items in the SearchResults.
SelectRange	Select a range of items in the SearchResults
SetContextParagraphs	Set the amount of context around each hit as a number of paragraphs
SetContextWholeFile	Include the whole file for each item in search results
SetContextWords	Set the number of words of context around each hit, and specify whether the exact number of words should be collected. If fExact is false, enough paragraphs will be collected around each hit to include at least the specified number of words.
SetDocExtractor	! Internal use only
SetFlags	Set ReportFlags for this report
SetMaxContextBlocks	Number of blocks of context to include in the report for each document.
SetMaxWordsToRead	Number of words to scan in each document looking for blocks of context to include in the report For example, if maxWordsToRead=5000, then the search report will only include hits that occur in the first 5000 words in each document. This setting can be used to generate faster (but not necessarily complete) reports by limiting the search report to hits near the beginning of each document
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi. (Inherited from DOutputBase)
SetOutputToCallback	Send output only to the virtual callback function, OnOutput (Inherited from DOutputBase)
SetOutputToFile	Send output to a file (Inherited from DOutputBase)
SetOutputToString	Send output to a string buffer managed by the class, and set the maximum length of the output string. (Inherited from DOutputBase)
SetResults	Attach search results to the DSearchReportJob, making a private internal copy of the search results.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Remarks

To generate a search report,

(1) Start with a dtsSearchResults object representing the results of a search.

(2) Declare a DSearchReportJob, passing the dtsSearchResults to the constructor

(3) Select the items to include in the search report using the Select*() methods in DSearchReportJob

(4) Specify the amount of context to include using SetContextWords() or SetContextParagraphs()

(5) Set the output format for the report

(6) Call Execute() to generate the report

Format

A search report lists the hits found in one or more documents, with each hit surrounded by a specified amount of context. Each block of context starts with a contextHeader and ends with the contextFooter. Contiguous or overlapping blocks of context will be combined. The amount of context included in the report can be specified by words or by paragraphs.

Each block of context is constructed as follows:

[ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter]

The report as a whole is constructed as follows:

[Header] [FileHeader] [ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter] [ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter] ... more blocks of context, if present [FileFooter] ... more files ... [Footer]

Use the following symbols to insert file information into the FileHeader and FileFooter:

Symbol	Meaning
Filename	The name of the file (without path information). For PDF and HTML files, this will be the Title.
Location	The location of the file
Fullname	The path and filename of the file.
Size	File size in bytes
SizeK	File size in kilobytes
Date	Modification date of the file when indexed
Hits	Number of hits in the file
Title	The first 80 characters of the file
DocId	The docId of the file
Type	The file type (Microsoft Word, PDF, HTML, etc.)
Ordinal	The 1-based ordinal of this item in the SearchResults from which it was generated
IndexRetrievedFrom	The index where the file was found

Use %% around each symbol, like this: %%FullName%%

Use the following symbols to insert context information in the contextHeader, which appears in front of each block of context:

Symbol	Meaning
Page	Page number where the hit occurs
Paragraph	Paragraph number where the hit occurs (relative to the start of the page)
Word	Word offset of the block of context from the beginning of the file.
FirstHit	Word offset of the first hit in the block of context.

Example

// Assume m_pResults is a pointer to dtsSearchResults DSearchReportJob reportJob(*m_pResults); // Request exactly 10 words of context around each hit reportJob.SetContextWords(10, true); // Specify which items in search results to include reportJob.SelectRange(firstItemToInclude, lastItemToInclude); // Highlight hits in bold, with a line between each block of context reportJob.SetOutputFormat(it_Html); reportJob.BeforeHit.setU8("<b>"); reportJob.AfterHit.setU8("</b>"); reportJob.ContextHeader = "<hr>"; // Generate output to a string limited to 512 bytes reportJob.SetOutputToString(512); // Request at most two blocks of context for each document included in the report reportJob.SetMaxContextBlocks(2); // Use cached text in the index, if present reportJob.SetFlag(dtsReportGetFromCache); // Generate the report reportJob.Execute();

Class Hierarchy

dtSearch::DJobBase | dtSearch::DOutputBase | dtSearch::DSearchReportJob