org.h2gis.api

Interface ProgressVisitor

All Known Implementing Classes:

EmptyProgressVisitor

public interface ProgressVisitor

Progression information.

Author:

Nicolas Fortin

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CANCELED

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 setStep(int) with step count.
void	endStep() Same as 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.

Field Detail

PROPERTY_CANCELED

static final String PROPERTY_CANCELED

See Also:

Constant Field Values

Method Detail

subProcess

ProgressVisitor subProcess(int stepCount)

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

Parameters:

stepCount - Number of step into the sub-process.

Returns:

The sub-process as a ProgressVisitor

endStep

void endStep()

Same as setStep(int) with currentStep++

setStep

void setStep(int idStep)

Parameters:

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

getStepCount

int getStepCount()

Returns:

The step count of this progress

endOfProgress

void endOfProgress()

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

getProgression

double getProgression()

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

Returns:

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

isCanceled

boolean isCanceled()

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

Returns:

True if the process has been canceled.

cancel

void cancel()

Call this method to cancel the operation.

addPropertyChangeListener

void addPropertyChangeListener(String property,
                               PropertyChangeListener listener)

Add the specified PropertyChangeListener for this visitor specified property.

Parameters:

property - Property name one of PROPERTY_CANCELED.

listener - PropertyChangeListener instance.

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Remove the specified PropertyChangeListener.

Parameters:

listener - PropertyChangeListener instance.