nl.inl.blacklab.index

Class IndexListenerReportConsole

java.lang.Object

nl.inl.blacklab.index.IndexListener

nl.inl.blacklab.index.IndexListenerReportConsole

All Implemented Interfaces:

FileProcessor.ErrorHandler

public class IndexListenerReportConsole
extends IndexListener

Used to report progress while indexing, so we can give feedback to the user.

Constructor Summary

Constructors

Constructor and Description
IndexListenerReportConsole()

Method Summary

Modifier and Type	Method and Description
void	charsDone(long charsDone) Some number of characters has been processed.
boolean	errorOccurred(Throwable e, String path, File f) Report an error and decide whether to continue or not.
void	indexEnd() The indexing process ended
void	warning(String msg)

Methods inherited from class nl.inl.blacklab.index.IndexListener

closeEnd, closeStart, documentDone, documentStarted, fileDone, fileStarted, getCharsProcessed, getCloseTime, getDocsDone, getErrors, getFilesProcessed, getIndexStartTime, getIndexTime, getOptimizeTime, getTokensProcessed, getTotalTime, indexerClosed, indexerCreated, indexStart, luceneDocumentAdded, rollbackEnd, rollbackStart, tokensDone

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexListenerReportConsole

public IndexListenerReportConsole()

Method Detail

charsDone

public void charsDone(long charsDone)

Description copied from class: IndexListener

Some number of characters has been processed. (this should be called regularly by the indexing class, so we can provide accurate progress reports) Synchronized to allow parallel indexing.

Overrides:

charsDone in class IndexListener

Parameters:

charsDone - the number of characters processed since the last call

indexEnd

public void indexEnd()

Description copied from class: IndexListener

The indexing process ended

Overrides:

indexEnd in class IndexListener

errorOccurred

public boolean errorOccurred(Throwable e,
                             String path,
                             File f)

Description copied from interface: FileProcessor.ErrorHandler

Report an error and decide whether to continue or not.

Specified by:

errorOccurred in interface FileProcessor.ErrorHandler

Overrides:

errorOccurred in class IndexListener

Parameters:

e - the exception

path - path to the file that the error occurred in. This includes pathing in archives if the file is inside an archive.

f - (optional, if known) the file from which the InputStream was built, or - if the InputStream is a file within an archive - the archive.

Returns:

true if we should continue, false to abort

warning

public void warning(String msg)

Overrides:

warning in class IndexListener