de.cismet.tools.gui.downloadmanager

Class AbstractDownload

java.lang.Object

java.util.Observable

de.cismet.tools.gui.downloadmanager.AbstractDownload

All Implemented Interfaces:

Download, Comparable, Runnable

Direct Known Subclasses:

AbstractCancellableDownload, ByteArrayDownload

public abstract class AbstractDownload
extends Observable
implements Download, Runnable, Comparable

The objects of this class represent downloads. This class encompasses several default methods which should be the same for most download which care about single files.

Version:

$Revision$, $Date$

Author:

jweintraut

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.tools.gui.downloadmanager.Download

Download.State

Field Summary

Fields

Modifier and Type	Field and Description
protected Exception	caughtException
protected String	directory
protected Future	downloadFuture
protected File	fileToSaveTo
protected static org.apache.log4j.Logger	log
protected boolean	started
protected Download.State	status
protected String	title

Constructor Summary

Constructors

Constructor and Description
AbstractDownload()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
protected void	determineDestinationFile(String filename, String extension) Determines the destination file for this download.
boolean	equals(Object obj)
protected void	error(Exception exception) Logs a caught exception and sets some members accordingly.
Exception	getCaughtException() Returns the exception which is caught during the download.
int	getDownloadsCompleted() Returns the count of completed downloads this Download object encapsulates.
int	getDownloadsErroneous() Returns the count of erraneous downloads this Download object encapsulates.
int	getDownloadsTotal() Returns the count of downloads this Download object encapsulates.
JPanel	getExceptionPanel(Exception exception) Returns a JPanel which visualizes the given exception.
File	getFileToSaveTo() Returns a file object pointing to the download location of this download.
Download.State	getStatus() Returns the status of this download.
String	getTitle() Returns the title of the download.
int	hashCode()
abstract void	run()
static void	setParallelDownloads(int parallelDownloads) DOCUMENT ME!
void	startDownload() Starts a thread which starts the download by starting this Runnable.
protected void	stateChanged() Marks this observable as changed and notifies observers.
protected void	titleChanged() DOCUMENT ME!

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.tools.gui.downloadmanager.Download

addObserver, deleteObserver, getProgress

Field Detail

log

protected static final org.apache.log4j.Logger log

directory

protected String directory

fileToSaveTo

protected File fileToSaveTo

status

protected Download.State status

title

protected String title

downloadFuture

protected Future downloadFuture

started

protected boolean started

caughtException

protected Exception caughtException

Constructor Detail

AbstractDownload

public AbstractDownload()

Method Detail

getTitle

public String getTitle()

Returns the title of the download.

Specified by:

getTitle in interface Download

Returns:

The title.

getFileToSaveTo

public File getFileToSaveTo()

Returns a file object pointing to the download location of this download.

Specified by:

getFileToSaveTo in interface Download

Returns:

A file object pointing to the download location.

getStatus

public Download.State getStatus()

Returns the status of this download.

Specified by:

getStatus in interface Download

Returns:

The status of this download.

getCaughtException

public Exception getCaughtException()

Returns the exception which is caught during the download. If an exception occurs the download is aborted.

Specified by:

getCaughtException in interface Download

Returns:

The caught exception.

getDownloadsTotal

public int getDownloadsTotal()

Description copied from interface: Download

Returns the count of downloads this Download object encapsulates.

Specified by:

getDownloadsTotal in interface Download

Returns:

Total count of downloads.

getDownloadsCompleted

public int getDownloadsCompleted()

Description copied from interface: Download

Returns the count of completed downloads this Download object encapsulates.

Specified by:

getDownloadsCompleted in interface Download

Returns:

Count of completed downloads.

getDownloadsErroneous

public int getDownloadsErroneous()

Description copied from interface: Download

Returns the count of erraneous downloads this Download object encapsulates.

Specified by:

getDownloadsErroneous in interface Download

Returns:

Count of erraneous downloads.

error

protected void error(Exception exception)

Logs a caught exception and sets some members accordingly.

Parameters:

exception - The caught exception.

startDownload

public void startDownload()

Starts a thread which starts the download by starting this Runnable.

Specified by:

startDownload in interface Download

getExceptionPanel

public JPanel getExceptionPanel(Exception exception)

Description copied from interface: Download

Returns a JPanel which visualizes the given exception.

Specified by:

getExceptionPanel in interface Download

Parameters:

exception - The exception to visualize.

Returns:

A JPanel visualizing the given exception.

run

public abstract void run()

Specified by:

run in interface Runnable

determineDestinationFile

protected void determineDestinationFile(String filename,
                                        String extension)

Determines the destination file for this download. There exist given parameters like a download destination and a pattern for the file name. It's possible that a previous download with equal parameters still exists physically, therefore this method adds a counter (2..999) which is appended to the filename. This counter is surrounded by parentheses.

Parameters:

filename - The file name for this download.

extension - The extension for the downloaded file.

stateChanged

protected void stateChanged()

Marks this observable as changed and notifies observers.

titleChanged

protected void titleChanged()

DOCUMENT ME!

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

setParallelDownloads

public static void setParallelDownloads(int parallelDownloads)

DOCUMENT ME!

Parameters:

parallelDownloads - DOCUMENT ME!