nl.inl.blacklab.index

Class IndexListener

java.lang.Object

nl.inl.blacklab.index.IndexListener

All Implemented Interfaces:

FileProcessor.ErrorHandler

Direct Known Subclasses:

IndexListenerDecorator, IndexListenerDevNull, IndexListenerReportConsole, IndexListenerReportConsoleVerbose

public class IndexListener
extends Object
implements FileProcessor.ErrorHandler

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

Constructor Summary

Constructors

Constructor and Description
IndexListener()

Method Summary

Modifier and Type	Method and Description
void	charsDone(long charsDone) Some number of characters has been processed.
void	closeEnd() The close process ended
void	closeStart() The close process started
void	documentDone(String name) A document was processed.
void	documentStarted(String name) We started processing a document Synchronized to allow parallel indexing.
boolean	errorOccurred(Throwable e, String path, File f) Report an error and decide whether to continue or not.
void	fileDone(String name)
void	fileStarted(String name) Started processing a file.
long	getCharsProcessed() Get the number of characters processed so far.
long	getCloseTime()
long	getDocsDone() Get the number of documents processed so far.
int	getErrors()
long	getFilesProcessed() Get the number of files processed so far.
long	getIndexStartTime()
long	getIndexTime()
long	getOptimizeTime()
long	getTokensProcessed() Get the number of characters processed so far.
long	getTotalTime()
void	indexEnd() The indexing process ended
void	indexerClosed()
void	indexerCreated(Indexer indexer)
void	indexStart() The indexing process started
void	luceneDocumentAdded()
void	rollbackEnd() Changes have been rolled back (called after an error).
void	rollbackStart() Changes will be rolled back (called after an error).
void	tokensDone(int n)
void	warning(String string)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexListener

public IndexListener()

Method Detail

getIndexStartTime

public long getIndexStartTime()

fileStarted

public void fileStarted(String name)

Started processing a file. Synchronized to allow parallel indexing.

Parameters:

name - name of the file

fileDone

public void fileDone(String name)

charsDone

public void charsDone(long charsDone)

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.

Parameters:

charsDone - the number of characters processed since the last call

documentStarted

public void documentStarted(String name)

We started processing a document Synchronized to allow parallel indexing.

Parameters:

name - name of the document

documentDone

public void documentDone(String name)

A document was processed. Synchronized to allow parallel indexing.

Parameters:

name - name of the document

getFilesProcessed

public long getFilesProcessed()

Get the number of files processed so far.

Returns:

the number of files processed so far

getCharsProcessed

public long getCharsProcessed()

Get the number of characters processed so far.

Returns:

the number of characters processed so far

getTokensProcessed

public long getTokensProcessed()

Get the number of characters processed so far.

Returns:

the number of characters processed so far

getDocsDone

public long getDocsDone()

Get the number of documents processed so far.

Returns:

the number of documents processed so far

indexStart

public void indexStart()

The indexing process started

indexEnd

public void indexEnd()

The indexing process ended

closeStart

public void closeStart()

The close process started

closeEnd

public void closeEnd()

The close process ended

getIndexTime

public long getIndexTime()

getOptimizeTime

public long getOptimizeTime()

getCloseTime

public long getCloseTime()

indexerCreated

public void indexerCreated(Indexer indexer)

indexerClosed

public void indexerClosed()

getTotalTime

public long getTotalTime()

luceneDocumentAdded

public void luceneDocumentAdded()

tokensDone

public void tokensDone(int n)

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

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

getErrors

public int getErrors()

rollbackStart

public void rollbackStart()

Changes will be rolled back (called after an error).

rollbackEnd

public void rollbackEnd()

Changes have been rolled back (called after an error).

warning

public void warning(String string)