Package mil.nga.geopackage.io

Class Progress

java.lang.Object

mil.nga.geopackage.io.Progress

All Implemented Interfaces:

GeoPackageProgress

Direct Known Subclasses:

ZoomLevelProgress

public class Progress
extends Object
implements GeoPackageProgress

Progress logger

Since:

3.3.0

Author:

osbornb

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active	Active flag
protected int	countFrequency	Log count frequency
protected DecimalFormat	decimalFormat	Decimal format
protected int	localCount	Local count between logs
protected Date	localTime	Local time between logs
protected Integer	max	Max number
protected int	progress	Total progress
protected int	timeFrequency	Log time frequency, stored in milliseconds
protected String	title	Log Title
protected String	unit	Log Unit

Constructor Summary

Constructors

Constructor	Description
Progress(String title, int countFrequency, int timeFrequency)	Constructor
Progress(String title, String unit, int countFrequency, int timeFrequency)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addProgress(int progress)
void	cancel()	Cancel the operation
boolean	cleanupOnCancel()
int	getCountFrequency()	Get the count frequency
Integer	getMax()	Get the max
protected String	getPercentage(int count, int total)	Get the string percentage of the count and total
int	getProgress()	Get the total progress
int	getTimeFrequency()	Get the time frequency in seconds
boolean	isActive()
protected void	logProgress()	Log the progress
void	setCountFrequency(int countFrequency)	Set the count frequency
void	setMax(int max)
void	setTimeFrequency(int timeFrequency)	Set the time frequency in seconds

Methods inherited from class java.lang.Object

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

Field Detail

decimalFormat

protected DecimalFormat decimalFormat

Decimal format

max

protected Integer max

Max number

progress

protected int progress

Total progress

active

protected boolean active

Active flag

title

protected final String title

Log Title

unit

protected final String unit

Log Unit

countFrequency

protected int countFrequency

Log count frequency

timeFrequency

protected int timeFrequency

Log time frequency, stored in milliseconds

localCount

protected int localCount

Local count between logs

localTime

protected Date localTime

Local time between logs

Constructor Detail

Progress

public Progress(String title,
                int countFrequency,
                int timeFrequency)

Constructor

Parameters:

title - title

countFrequency - count frequency

timeFrequency - time frequency in seconds

Progress

public Progress(String title,
                String unit,
                int countFrequency,
                int timeFrequency)

Constructor

Parameters:

title - title

unit - unit

countFrequency - count frequency

timeFrequency - time frequency in seconds

Since:

3.5.0

Method Detail

setMax

public void setMax(int max)

Specified by:

setMax in interface GeoPackageProgress

addProgress

public void addProgress(int progress)

Specified by:

addProgress in interface GeoPackageProgress

logProgress

protected void logProgress()

Log the progress

isActive

public boolean isActive()

Specified by:

isActive in interface GeoPackageProgress

cleanupOnCancel

public boolean cleanupOnCancel()

Specified by:

cleanupOnCancel in interface GeoPackageProgress

cancel

public void cancel()

Cancel the operation

getMax

public Integer getMax()

Get the max

Returns:

max

getCountFrequency

public int getCountFrequency()

Get the count frequency

Returns:

count frequency

Since:

3.5.0

setCountFrequency

public void setCountFrequency(int countFrequency)

Set the count frequency

Parameters:

countFrequency - count frequency

Since:

3.5.0

getTimeFrequency

public int getTimeFrequency()

Get the time frequency in seconds

Returns:

time frequency in seconds

Since:

3.5.0

setTimeFrequency

public void setTimeFrequency(int timeFrequency)

Set the time frequency in seconds

Parameters:

timeFrequency - time frequency in seconds

Since:

3.5.0

getProgress

public int getProgress()

Get the total progress

Returns:

progress

getPercentage

protected String getPercentage(int count,
                               int total)

Get the string percentage of the count and total

Parameters:

count - current count

total - total count

Returns:

string percentage