Package adams.data.noise

Class AbstractDenoiser.DenoiserJob<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.multiprocess.AbstractJob

adams.data.noise.AbstractDenoiser.DenoiserJob<T>

All Implemented Interfaces:

CleanUpHandler, LoggingLevelHandler, LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, Job, Serializable

Enclosing class:

AbstractDenoiser<T extends DataContainer>

public static class AbstractDenoiser.DenoiserJob<T extends DataContainer>
extends AbstractJob

A job class specific to denoisers.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected T	m_Data	the data to push through the denoiser.
protected T	m_DenoisedData	the denoised data.
protected AbstractDenoiser	m_Denoiser	the denoiser to use.

Fields inherited from class adams.multiprocess.AbstractJob

m_Complete, m_ExecutionError, m_JobCompleteListener, m_JobInfo, m_ProgressInfo, m_Stopped

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
DenoiserJob(AbstractDenoiser denoiser, T data)	Initializes the job.

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
protected String	getAdditionalErrorInformation()	Returns additional information to be added to the error message.
T	getData()	The input data.
T	getDenoisedData()	The output data, if any.
AbstractDenoiser	getDenoiser()	Returns the denoiser being used.
protected String	postProcessCheck()	Checks whether all post-conditions have been met.
protected String	preProcessCheck()	Checks whether all pre-conditions have been met.
protected void	process()	Does the actual execution of the job.
String	toString()	Returns a string representation of the job.

Methods inherited from class adams.multiprocess.AbstractJob

execute, getExecutionError, getJobCompleteListener, getJobInfo, getProgressInfo, hasExecutionError, isComplete, isStopped, jobCompleted, setJobCompleteListener, setJobInfo, setProgressInfo, stopExecution

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Field Detail

m_Denoiser

protected AbstractDenoiser m_Denoiser

the denoiser to use.

m_Data

protected T extends DataContainer m_Data

the data to push through the denoiser.

m_DenoisedData

protected T extends DataContainer m_DenoisedData

the denoised data.

Constructor Detail

DenoiserJob

public DenoiserJob(AbstractDenoiser denoiser,
                   T data)

Initializes the job.

Parameters:

denoiser - the denoiser to use for denoising

data - the data to pass through the denoiser

Method Detail

getDenoiser

public AbstractDenoiser getDenoiser()

Returns the denoiser being used.

Returns:

the denoiser in use

getData

public T getData()

The input data.

Returns:

the input data

getDenoisedData

public T getDenoisedData()

The output data, if any.

Returns:

the output data, or null in case of an error

preProcessCheck

protected String preProcessCheck()

Checks whether all pre-conditions have been met.

Specified by:

preProcessCheck in class AbstractJob

Returns:

null if everything is OK, otherwise an error message

getAdditionalErrorInformation

protected String getAdditionalErrorInformation()

Returns additional information to be added to the error message.

Overrides:

getAdditionalErrorInformation in class AbstractJob

Returns:

the additional information

process

protected void process()
                throws Exception

Does the actual execution of the job.

Specified by:

process in class AbstractJob

Throws:

Exception - if fails to execute job

postProcessCheck

protected String postProcessCheck()

Checks whether all post-conditions have been met.

Specified by:

postProcessCheck in class AbstractJob

Returns:

null if everything is OK, otherwise an error message

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory. Sets the input data to null.

Specified by:

cleanUp in interface CleanUpHandler

Specified by:

cleanUp in interface Job

Overrides:

cleanUp in class AbstractJob

toString

public String toString()

Returns a string representation of the job.

Specified by:

toString in class AbstractJob

Returns:

a string representation