org.h2gis.api

Class EmptyProgressVisitor

java.lang.Object

org.h2gis.api.EmptyProgressVisitor

All Implemented Interfaces:

ProgressVisitor

public class EmptyProgressVisitor
extends Object
implements ProgressVisitor

A progress visitor that do nothing.

Author:

Nicolas Fortin

Field Summary

Fields inherited from interface org.h2gis.api.ProgressVisitor

PROPERTY_CANCELED

Constructor Summary

Constructors

Constructor and Description
EmptyProgressVisitor()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(String property, PropertyChangeListener listener) Add the specified PropertyChangeListener for this visitor specified property.
void	cancel() Call this method to cancel the operation.
void	endOfProgress() Same thing as call ProgressVisitor.setStep(int) with step count.
void	endStep() Same as ProgressVisitor.setStep(int) with currentStep++
double	getProgression() Get the step progression which belong to [0,1]
int	getStepCount()
boolean	isCanceled() Return true if the process hes been canceled, false otherwise.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove the specified PropertyChangeListener.
void	setStep(int idStep)
ProgressVisitor	subProcess(int stepCount) Create a sub process.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyProgressVisitor

public EmptyProgressVisitor()

Method Detail

endOfProgress

public void endOfProgress()

Description copied from interface: ProgressVisitor

Same thing as call ProgressVisitor.setStep(int) with step count.

Specified by:

endOfProgress in interface ProgressVisitor

subProcess

public ProgressVisitor subProcess(int stepCount)

Description copied from interface: ProgressVisitor

Create a sub process. When this sub process finish it will count as a single step in this process.

Specified by:

subProcess in interface ProgressVisitor

Parameters:

stepCount - Number of step into the sub-process.

Returns:

The sub-process as a ProgressVisitor

endStep

public void endStep()

Description copied from interface: ProgressVisitor

Same as ProgressVisitor.setStep(int) with currentStep++

Specified by:

endStep in interface ProgressVisitor

setStep

public void setStep(int idStep)

Specified by:

setStep in interface ProgressVisitor

Parameters:

idStep - Set the current step, must be in [0-stepCount]

getStepCount

public int getStepCount()

Specified by:

getStepCount in interface ProgressVisitor

Returns:

The step count of this progress

getProgression

public double getProgression()

Description copied from interface: ProgressVisitor

Get the step progression which belong to [0,1]

Specified by:

getProgression in interface ProgressVisitor

Returns:

This step progression [O-1], take account sub process progression.

isCanceled

public boolean isCanceled()

Description copied from interface: ProgressVisitor

Return true if the process hes been canceled, false otherwise.

Specified by:

isCanceled in interface ProgressVisitor

Returns:

True if the process has been canceled.

cancel

public void cancel()

Description copied from interface: ProgressVisitor

Call this method to cancel the operation.

Specified by:

cancel in interface ProgressVisitor

addPropertyChangeListener

public void addPropertyChangeListener(String property,
                                      PropertyChangeListener listener)

Description copied from interface: ProgressVisitor

Add the specified PropertyChangeListener for this visitor specified property.

Specified by:

addPropertyChangeListener in interface ProgressVisitor

Parameters:

property - Property name one of ProgressVisitor.PROPERTY_CANCELED.

listener - PropertyChangeListener instance.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: ProgressVisitor

Remove the specified PropertyChangeListener.

Specified by:

removePropertyChangeListener in interface ProgressVisitor

Parameters:

listener - PropertyChangeListener instance.