ilog.views.maps.raster.datasource

Class IlvThreadMonitoringData

java.lang.Object

ilog.views.maps.raster.datasource.IlvThreadMonitoringData

public class IlvThreadMonitoringData
extends Object

Stores the monitoring information for a specific subactivity. The progress of a monitored subactivity must be in the range of 0 to 100 percent.

Call updateProgress(int) to correct the progress of this subactivity so that it falls inside the minimum and maximum parameters supplied to this object.

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
IlvThreadMonitoringData(IlvThreadedActivityMonitor monitor, Object activity, String description, int min, int max) Creates a subactivity monitoring utility class.

Method Summary

Modifier and Type	Method and Description
Object	getActivity() Returns the activity ID.
String	getDescription() Returns the subactivity description.
int	getMax() Returns the value of activity advancement when a subactivity ends.
int	getMin() Returns the value of activity advancement when a subactivity starts.
IlvThreadedActivityMonitor	getMonitor() Returns the activity monitor used.
void	setActivity(Object activity) Sets the activity ID.
void	setDescription(String description) Sets the activity description.
void	setMax(int max) Sets the value of activity advancement when a subactivity ends.
void	setMin(int min) Sets the value of activity advancement when a subactivity starts.
void	updateProgress(int percent) Updates the activity percentage according to the progress of the subactivity.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvThreadMonitoringData

public IlvThreadMonitoringData(IlvThreadedActivityMonitor monitor,
                               Object activity,
                               String description,
                               int min,
                               int max)

Creates a subactivity monitoring utility class.

Parameters:

monitor - The monitor managing the activities.

activity - The activity id.

description - The description of this subactivity.

min - minimum The minimum progress when subactivity starts. This value must be in the range 0 to 100.

max - maximum The maximum progress when subactivity ends. This value must be in the range 0 to 100.

Method Detail

updateProgress

public void updateProgress(int percent)

Updates the activity percentage according to the progress of the subactivity.

Parameters:

percent - The advancement percentage of the activity. This value must be in the range 0 to 100.

getActivity

public Object getActivity()

Returns the activity ID.

Returns:

The activity ID.

setActivity

public void setActivity(Object activity)

Sets the activity ID.

Parameters:

activity - The activity ID.

getDescription

public String getDescription()

Returns the subactivity description.

Returns:

The subactivity description.

setDescription

public void setDescription(String description)

Sets the activity description.

Parameters:

description - The activity description.

getMax

public int getMax()

Returns the value of activity advancement when a subactivity ends.

Returns:

The value of activity advancement when a subactivity ends.

setMax

public void setMax(int max)

Sets the value of activity advancement when a subactivity ends.

Parameters:

max - The value of activity advancement when a subactivity ends.

getMin

public int getMin()

Returns the value of activity advancement when a subactivity starts.

Returns:

The value of activity advancement when a subactivity starts.

setMin

public void setMin(int min)

Sets the value of activity advancement when a subactivity starts.

Parameters:

min - The value of activity advancement when a subactivity starts.

getMonitor

public IlvThreadedActivityMonitor getMonitor()

Returns the activity monitor used.

Returns:

The activity monitor used.