Package org.mycore.common.processing

Class MCRAbstractProgressable

java.lang.Object

org.mycore.common.processing.MCRAbstractProgressable

All Implemented Interfaces:

MCRListenableProgressable, MCRProgressable

Direct Known Subclasses:

MCRAbstractProcessable

public class MCRAbstractProgressable
extends Object
implements MCRListenableProgressable

Base implementation for an MCRProgressable. If you use this class make sure to call setProgress(Integer) and setProgressText(String) to invoke the MCRProgressableListener.

Author:

Matthias Eichner

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	progress
protected final List<MCRProgressableListener>	progressListener
protected String	progressText

Constructor Summary

Constructors

Constructor	Description
MCRAbstractProgressable()

Method Summary

Modifier and Type	Method	Description
void	addProgressListener(MCRProgressableListener listener)	Adds a new MCRProgressableListener to this MCRProgressable.
protected void	fireProgressChanged(Integer oldProgress)
protected void	fireProgressTextChanged(String oldProgressText)
Integer	getProgress()	Returns a value between 0-100 which determines the progress.
String	getProgressText()	Returns a human readable text indicating the state of the progress.
void	removeProgressListener(MCRProgressableListener listener)	Removes a MCRProgressableListener from this MCRProgressable.
void	setProgress(Integer progress)	Sets the progress for this process.
void	setProgressText(String progressText)	Sets the progress text for this process.

Methods inherited from class java.lang.Object

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

Field Details

progress

protected Integer progress

progressText

protected String progressText

progressListener

protected final List<MCRProgressableListener> progressListener

Constructor Details

MCRAbstractProgressable

public MCRAbstractProgressable()

Method Details

setProgress

public void setProgress(Integer progress)

Sets the progress for this process.

Parameters:

progress - the new progress between 0 and 100

setProgressText

public void setProgressText(String progressText)

Sets the progress text for this process.

Parameters:

progressText - the new progress text

getProgress

public Integer getProgress()

Description copied from interface: MCRProgressable

Returns a value between 0-100 which determines the progress. Can return null if the process is not started yet.

Specified by:

getProgress in interface MCRProgressable

Returns:

the progress between 0-100 or null

getProgressText

public String getProgressText()

Description copied from interface: MCRProgressable

Returns a human readable text indicating the state of the progress.

Specified by:

getProgressText in interface MCRProgressable

Returns:

progress text

addProgressListener

public void addProgressListener(MCRProgressableListener listener)

Description copied from interface: MCRListenableProgressable

Adds a new MCRProgressableListener to this MCRProgressable.

Specified by:

addProgressListener in interface MCRListenableProgressable

Parameters:

listener - the listener to add

removeProgressListener

public void removeProgressListener(MCRProgressableListener listener)

Description copied from interface: MCRListenableProgressable

Removes a MCRProgressableListener from this MCRProgressable.

Specified by:

removeProgressListener in interface MCRListenableProgressable

Parameters:

listener - the listener to remove

fireProgressChanged

protected void fireProgressChanged(Integer oldProgress)

fireProgressTextChanged

protected void fireProgressTextChanged(String oldProgressText)