com.groupdocs.search.common

Class IndexingReport

java.lang.Object

com.groupdocs.search.common.IndexingReport

public abstract class IndexingReport
extends Object

Represents a detailed information on an indexing operation.

Learn more

• Indexing reports

The example demonstrates a typical usage of the class.

 
 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder1);
 index.add(documentsFolder2);
 // Getting indexing reports
 IndexingReport[] reports = index.getIndexingReports();
 // Printing reports to the console
 for (IndexingReport report : reports) {
     DateFormat df = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
     System.out.println("Time: " + df.format(report.getStartTime()));
     System.out.println("Duration: " + report.getIndexingTime());
     System.out.println("Documents total: " + report.getTotalDocumentsInIndex());
     System.out.println("Terms total: " + report.getTotalTermCount());
     System.out.println("Indexed documents size (MB): " + report.getIndexedDocumentsSize());
     System.out.println("Index size (MB): " + (report.getTotalIndexSize() / 1024.0 / 1024.0));
     System.out.println();
 }
 
 

Constructor Summary

Constructors

Constructor and Description
IndexingReport()

Method Summary

Modifier and Type	Method and Description
abstract Date	getEndTime() Gets the indexing end time.
abstract String[]	getErrors() Gets the list of errors.
abstract String[]	getIndexedDocuments() Gets the list of indexed documents.
abstract double	getIndexedDocumentsSize() Gets the total length of indexed documents in MB.
abstract double	getIndexingTime() Gets the indexing duration in seconds.
abstract String[]	getRemovedDocuments() Gets the list of removed from index documents.
abstract int	getSegmentCount() Gets the number of index segments.
abstract Date	getStartTime() Gets the indexing start time.
abstract int	getTotalDocumentsInIndex() Gets the total number of documents in the index.
abstract long	getTotalIndexSize() Gets the total index size in bytes.
abstract int	getTotalTermCount() Gets the total number of terms in index.
abstract String[]	getUpdatedDocuments() Gets the list of updated documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexingReport

public IndexingReport()

Method Detail

getEndTime

public abstract Date getEndTime()

Gets the indexing end time.

Returns:

The indexing end time.

getErrors

public abstract String[] getErrors()

Gets the list of errors.

Returns:

The list of errors.

getIndexedDocuments

public abstract String[] getIndexedDocuments()

Gets the list of indexed documents.

Returns:

The list of indexed documents.

getIndexedDocumentsSize

public abstract double getIndexedDocumentsSize()

Gets the total length of indexed documents in MB.

Returns:

The total length of indexed documents in MB.

getIndexingTime

public abstract double getIndexingTime()

Gets the indexing duration in seconds.

Returns:

The indexing duration in seconds.

getRemovedDocuments

public abstract String[] getRemovedDocuments()

Gets the list of removed from index documents.

Returns:

The list of removed from index documents.

getSegmentCount

public abstract int getSegmentCount()

Gets the number of index segments.

Returns:

The number of index segments.

getStartTime

public abstract Date getStartTime()

Gets the indexing start time.

Returns:

The indexing start time.

getTotalDocumentsInIndex

public abstract int getTotalDocumentsInIndex()

Gets the total number of documents in the index.

Returns:

The total number of documents in the index.

getTotalIndexSize

public abstract long getTotalIndexSize()

Gets the total index size in bytes.

Returns:

The total index size in bytes.

getTotalTermCount

public abstract int getTotalTermCount()

Gets the total number of terms in index.

Returns:

The total number of terms in index.

getUpdatedDocuments

public abstract String[] getUpdatedDocuments()

Gets the list of updated documents.

Returns:

The list of updated documents.