org.basex.core

Class Progress

java.lang.Object

org.basex.core.Progress

Direct Known Subclasses:

Builder, Command, IndexBuilder, Parser, QueryContext, QueryProcessor, Zip

public abstract class Progress
extends java.lang.Object

This class is implemented by all kinds of processes. It gives feedback on the current process. Moreover, it allows to interrupt the process by calling the stop() method.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
boolean	updating Updating flag.

Constructor Summary

Constructors

Constructor and Description
Progress()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	abort() Aborts a failed or interrupted progress.
void	checkStop() Checks if the progress was interrupted; if yes, sends a runtime exception.
protected java.lang.String	det() Returns short information on this process.
java.lang.String	detail() Returns detailed information on the current process or sub process.
protected double	prog() Returns a progress value (0 - 1).
double	progress() Returns a progress value from the interval [0, 1].
protected <P extends Progress> P	progress(P prog) Sets a new sub progress.
void	startTimeout(long sec) Starts a timeout thread.
void	stop() Stops a process or sub process.
void	stopTimeout() Stops the timeout thread.
protected java.lang.String	tit() Returns short information on this process.
java.lang.String	title() Returns short information on the current process or sub process.

Methods inherited from class java.lang.Object

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

Field Detail

updating

public boolean updating

Updating flag.

Constructor Detail

Progress

public Progress()

Method Detail

title

public final java.lang.String title()

Returns short information on the current process or sub process.

Returns:

header information

detail

public final java.lang.String detail()

Returns detailed information on the current process or sub process. Can be overwritten to give more detailed information.

Returns:

information in detail

progress

public final double progress()

Returns a progress value from the interval [0, 1].

Returns:

header information

progress

protected final <P extends Progress> P progress(P prog)

Sets a new sub progress.

Type Parameters:

P - progress type

Parameters:

prog - progress

Returns:

passed on progress reference

stop

public final void stop()

Stops a process or sub process.

checkStop

public final void checkStop()

Checks if the progress was interrupted; if yes, sends a runtime exception.

abort

protected void abort()

Aborts a failed or interrupted progress.

startTimeout

public final void startTimeout(long sec)

Starts a timeout thread.

Parameters:

sec - seconds to wait; deactivated if set to 0

stopTimeout

public final void stopTimeout()

Stops the timeout thread.

tit

protected java.lang.String tit()

Returns short information on this process. Can be overwritten to give more detailed information.

Returns:

header information

det

protected java.lang.String det()

Returns short information on this process.

Returns:

header information

prog

protected double prog()

Returns a progress value (0 - 1). Can be overwritten to give more detailed information.

Returns:

header information