org.pfsw.tools.cda.core.processing

Class AnalyzableElementsProcessingTask<IE extends IAnalyzableElement,PE extends IAnalyzableElement>

java.lang.Object

org.pfsw.tools.cda.core.processing.AnalyzableElementsProcessingTask<IE,PE>

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

AllClassesProcessingTask, ClassesProcessingTask, ContainersProcessingTask, PackagesProcessingTask

public abstract class AnalyzableElementsProcessingTask<IE extends IAnalyzableElement,PE extends IAnalyzableElement>
extends java.lang.Object
implements java.lang.Runnable

Abstract superclass for all processing classes that iterate over specific analyzable elements starting at a root element.

IE = Initiating Element type
PE = Processing Element type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyzableElementsProcessingTask(java.lang.String type, IProgressMonitor monitor, IElementsProcessingResultHandler resultHandler)

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<PE>	createInitialExcludeCollection() Returns a collection with elements that should be excluded.
protected ProcessingResult<PE>	createResult(java.util.Collection<PE> collectedElements) Returns a new result object based on the given result collection.
protected abstract boolean	doProcessing(java.util.Collection<PE> result) Does the processing over the workset's elements.
protected abstract IMutableAnalyzableElementProcessor<PE>	getElementProcessor() Returns the processor that processes and matches the elements given to it.
protected java.lang.String	getProcessingType()
protected IProgressMonitor	getProgressMonitor()
protected IElementsProcessingResultHandler	getResultHandler()
protected abstract IE	getStartElement() Returns the element on which the processing gets executed.
protected Workset	getWorkset() Returns the workset or the analyzed element.
protected boolean	hasProgressMonitor()
boolean	isRecursiveProcessing()
protected java.util.Collection<PE>	newResultCollection() Creates a new result collection.
protected boolean	recursiveProcessing(java.util.Collection<PE> excludes, java.util.Collection<PE> result) Executes the processing over the workset's elements for the start element and afterwards for all found elements recursively until no new one was found.
void	run() Executes the whole processing.
void	setIsRecursiveProcessing(boolean newValue)
protected void	setProcessingType(java.lang.String newValue)
protected void	setProgressMonitor(IProgressMonitor newValue)
protected void	setResultHandler(IElementsProcessingResultHandler newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzableElementsProcessingTask

protected AnalyzableElementsProcessingTask(java.lang.String type,
                                           IProgressMonitor monitor,
                                           IElementsProcessingResultHandler resultHandler)

Parameters:

type - A unique identifier for the processing task. It will be passed to the resultHandler to identify the process.

monitor - An optional monitor that can show the progress (may be null).

resultHandler - The object that will be called to receive the result when the thread is finished.

Method Detail

run

public void run()

Executes the whole processing. Subclasses should not override this methods.

Specified by:

run in interface java.lang.Runnable

isRecursiveProcessing

public boolean isRecursiveProcessing()

setIsRecursiveProcessing

public void setIsRecursiveProcessing(boolean newValue)

getStartElement

protected abstract IE getStartElement()

Returns the element on which the processing gets executed.

doProcessing

protected abstract boolean doProcessing(java.util.Collection<PE> result)

Does the processing over the workset's elements. Returns false if canceled, otherwise true.

getElementProcessor

protected abstract IMutableAnalyzableElementProcessor<PE> getElementProcessor()

Returns the processor that processes and matches the elements given to it.

recursiveProcessing

protected boolean recursiveProcessing(java.util.Collection<PE> excludes,
                                      java.util.Collection<PE> result)

Executes the processing over the workset's elements for the start element and afterwards for all found elements recursively until no new one was found. Returns false if cancelled, otherwise true.

getWorkset

protected Workset getWorkset()

Returns the workset or the analyzed element.

createResult

protected ProcessingResult<PE> createResult(java.util.Collection<PE> collectedElements)

Returns a new result object based on the given result collection. Subclasses may override this method in order to add more data to the result.

createInitialExcludeCollection

protected java.util.Collection<PE> createInitialExcludeCollection()

Returns a collection with elements that should be excluded. here it returns an empty collection. Subclasses may override this to provide a collection that already contains some elements.

newResultCollection

protected java.util.Collection<PE> newResultCollection()

Creates a new result collection. Subclasses may override this to provide their own collection type of different initial capacity.

Returns:

new ArrayList(100)

hasProgressMonitor

protected boolean hasProgressMonitor()

getProcessingType

protected java.lang.String getProcessingType()

setProcessingType

protected void setProcessingType(java.lang.String newValue)

getProgressMonitor

protected IProgressMonitor getProgressMonitor()

setProgressMonitor

protected void setProgressMonitor(IProgressMonitor newValue)

getResultHandler

protected IElementsProcessingResultHandler getResultHandler()

setResultHandler

protected void setResultHandler(IElementsProcessingResultHandler newValue)