com.qizx.api
Interface LibraryProgressObserver

public interface LibraryProgressObserver

Monitors the progress of diverse operations on a Library.

Caution: implementations of these methods should never throw RuntimeExceptions.

Method Summary

void	backupProgress(double fraction) Monitors the progress of a backup operation.
void	commitProgress(double fraction) Monitors the progress of a commit operation.
void	importProgress(double size) Monitors the progress of an importDocument operation.
void	optimizationProgress(double fraction) Monitors the progress of an "optimize" operation (Library.optimize()).
void	reindexingProgress(double fraction) Monitors the progress of a "re-index" operation (Library.reIndex()).

Method Detail

importProgress

public void importProgress(double size)

Monitors the progress of an importDocument operation.

Parameters:

size - estimated size in characters of XML contents stored so far.

commitProgress

public void commitProgress(double fraction)

Monitors the progress of a commit operation.

Parameters:

fraction - estimated completed fraction, from 0 to 1.

backupProgress

public void backupProgress(double fraction)

Monitors the progress of a backup operation.

Parameters:

fraction - estimated completed fraction, from 0 to 1.

optimizationProgress

public void optimizationProgress(double fraction)

Monitors the progress of an "optimize" operation (Library.optimize()).

Parameters:

fraction - estimated completed fraction. As long as the optimization task is not actually started, the value is negative (-1). The task can be delayed by operations on other Library sessions (e.g commits). As the optimization task runs, the fraction value goes from 0 to 1.

reindexingProgress

public void reindexingProgress(double fraction)

Monitors the progress of a "re-index" operation (Library.reIndex()).

Parameters:

fraction - estimated completed fraction. As long as the reindexing task is not actually started, the value is negative (-1). The task can be delayed by operations on other Library sessions (e.g commits). As the reindexing task runs, the fraction value goes from 0 to 1.