com.groupdocs.search.common

Class SearchReport

java.lang.Object

com.groupdocs.search.common.SearchReport

public abstract class SearchReport
extends Object

Represents a detailed information on a search operation.

Learn more

• Search reports

The example demonstrates a typical usage of the class.

 
 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Searching in index
 SearchResult result1 = index.search("Einstein");
 SearchResult result2 = index.search("\"Theory of Relativity\"");
 // Getting search reports
 SearchReport[] reports = index.getSearchReports();
 // Printing reports to the console
 for (SearchReport report : reports) {
     System.out.println("Query: " + report.getTextQuery());
     DateFormat df = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
     System.out.println("Time: " + df.format(report.getStartTime()));
     System.out.println("Duration: " + report.getSearchDuration());
     System.out.println("Documents: " + report.getDocumentCount());
     System.out.println("Occurrences: " + report.getOccurrenceCount());
     System.out.println();
 }
 
 

Constructor Summary

Constructors

Constructor and Description
SearchReport()

Method Summary

Modifier and Type	Method and Description
abstract int	getDocumentCount() Gets the number of documents found.
abstract Date	getEndTime() Gets the end time of the search.
abstract SearchQuery	getObjectQuery() Gets the search query in object form.
abstract int	getOccurrenceCount() Gets the total number of occurrences found.
abstract double	getSearchDuration() Gets the search duration in seconds.
abstract SearchOptions	getSearchOptions() Gets the search options.
abstract Date	getStartTime() Gets the start time of the search.
abstract String	getTextQuery() Gets the search query in text form.
abstract String	toString() Returns a String that represents the current SearchReport.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchReport

public SearchReport()

Method Detail

getDocumentCount

public abstract int getDocumentCount()

Gets the number of documents found.

Returns:

The number of documents found.

getEndTime

public abstract Date getEndTime()

Gets the end time of the search.

Returns:

The end time of the search.

getObjectQuery

public abstract SearchQuery getObjectQuery()

Gets the search query in object form.

Returns:

The search query in object form.

getOccurrenceCount

public abstract int getOccurrenceCount()

Gets the total number of occurrences found.

Returns:

The total number of occurrences found.

getSearchDuration

public abstract double getSearchDuration()

Gets the search duration in seconds.

Returns:

The search duration in seconds.

getSearchOptions

public abstract SearchOptions getSearchOptions()

Gets the search options.

Returns:

The search options.

getStartTime

public abstract Date getStartTime()

Gets the start time of the search.

Returns:

The start time of the search.

getTextQuery

public abstract String getTextQuery()

Gets the search query in text form.

Returns:

The search query in text form.

toString

public abstract String toString()

Returns a String that represents the current SearchReport.

Overrides:

toString in class Object

Returns:

A String that represents the current SearchReport.