AbstractRetrievalService (cismap Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.cismap.commons.retrieval.AbstractRetrievalService

All Implemented Interfaces:

RetrievalService

Direct Known Subclasses:

AbstractFeatureService, AbstractWMS, ImageRasterService, SlidableWMSServiceLayerGroup, UniversalRetrieval
```
public abstract class AbstractRetrievalService
extends Object
implements RetrievalService
```
DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`DEBUG`
`protected Object`	`errorObject`
`protected List<RetrievalListener>`	`listeners`
`protected int`	`progress`
`static String`	`PROGRESS_PROPERTY`
`static String`	`PROGRESS_REFRESH`
`protected PropertyChangeSupport`	`propertyChangeSupport`
`protected boolean`	`refreshNeeded`

Constructor Summary

Constructors
Constructor and Description

AbstractRetrievalService()
Creates a new instance of AbstractRetrievalService.

Constructors
Constructor and Description
`AbstractRetrievalService()` Creates a new instance of AbstractRetrievalService.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener l)` DOCUMENT ME!
`void`	`addRetrievalListener(RetrievalListener irl)` DOCUMENT ME!
`abstract Object`	`clone()`
`AbstractRetrievalService`	`cloneWithoutRetrievalListeners()` DOCUMENT ME!
`void`	`fireRetrievalAborted(RetrievalEvent e)` DOCUMENT ME!
`void`	`fireRetrievalComplete(RetrievalEvent e)` DOCUMENT ME!
`void`	`fireRetrievalError(RetrievalEvent e)` DOCUMENT ME!
`void`	`fireRetrievalProgress(RetrievalEvent e)` DOCUMENT ME!
`void`	`fireRetrievalStarted(RetrievalEvent e)` DOCUMENT ME!
`Object`	`getErrorObject()` DOCUMENT ME!
`List<RetrievalListener>`	`getListeners()` DOCUMENT ME!
`int`	`getProgress()` DOCUMENT ME!
`boolean`	`hasErrors()` DOCUMENT ME!
`boolean`	`isRefreshNeeded()` DOCUMENT ME!
`void`	`removePropertyChangeListener(PropertyChangeListener l)` DOCUMENT ME!
`void`	`removeRetrievalListener(RetrievalListener irl)` DOCUMENT ME!
`abstract void`	`retrieve(boolean forced)` DOCUMENT ME!
`void`	`setErrorObject(Object errorObject)` DOCUMENT ME!
`void`	`setProgress(int progress)` DOCUMENT ME!
`void`	`setRefreshNeeded(boolean refreshNeeded)` DOCUMENT ME!

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROGRESS_PROPERTY
```
public static final String PROGRESS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PROGRESS_REFRESH
```
public static final String PROGRESS_REFRESH
```
    See Also:
    
    Constant Field Values
  - DEBUG
```
protected static final boolean DEBUG
```
    See Also:
    
    Constant Field Values
  - progress
```
protected int progress
```
  - refreshNeeded
```
protected boolean refreshNeeded
```
  - listeners
```
protected List<RetrievalListener> listeners
```
  - propertyChangeSupport
```
protected PropertyChangeSupport propertyChangeSupport
```
  - errorObject
```
protected Object errorObject
```
- Constructor Detail
  - AbstractRetrievalService
```
public AbstractRetrievalService()
```
    Creates a new instance of AbstractRetrievalService.
- Method Detail
  - removeRetrievalListener
```
public void removeRetrievalListener(RetrievalListener irl)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    removeRetrievalListener in interface RetrievalService
    
    Parameters:
    
    irl - DOCUMENT ME!
  - addRetrievalListener
```
public void addRetrievalListener(RetrievalListener irl)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    addRetrievalListener in interface RetrievalService
    
    Parameters:
    
    irl - DOCUMENT ME!
  - fireRetrievalStarted
```
public void fireRetrievalStarted(RetrievalEvent e)
```
    DOCUMENT ME!
    
    Parameters:
    
    e - DOCUMENT ME!
  - fireRetrievalProgress
```
public void fireRetrievalProgress(RetrievalEvent e)
```
    DOCUMENT ME!
    
    Parameters:
    
    e - DOCUMENT ME!
  - fireRetrievalComplete
```
public void fireRetrievalComplete(RetrievalEvent e)
```
    DOCUMENT ME!
    
    Parameters:
    
    e - DOCUMENT ME!
  - fireRetrievalAborted
```
public void fireRetrievalAborted(RetrievalEvent e)
```
    DOCUMENT ME!
    
    Parameters:
    
    e - DOCUMENT ME!
  - fireRetrievalError
```
public void fireRetrievalError(RetrievalEvent e)
```
    DOCUMENT ME!
    
    Parameters:
    
    e - DOCUMENT ME!
  - retrieve
```
public abstract void retrieve(boolean forced)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    retrieve in interface RetrievalService
    
    Parameters:
    
    forced - DOCUMENT ME!
  - clone
```
public abstract Object clone()
```
    Overrides:
    
    clone in class Object
  - cloneWithoutRetrievalListeners
```
public AbstractRetrievalService cloneWithoutRetrievalListeners()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getListeners
```
public List<RetrievalListener> getListeners()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getProgress
```
public int getProgress()
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    getProgress in interface RetrievalService
    
    Returns:
    
    DOCUMENT ME!
  - setProgress
```
public void setProgress(int progress)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    setProgress in interface RetrievalService
    
    Parameters:
    
    progress - DOCUMENT ME!
  - getErrorObject
```
public Object getErrorObject()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - setErrorObject
```
public void setErrorObject(Object errorObject)
```
    DOCUMENT ME!
    
    Parameters:
    
    errorObject - DOCUMENT ME!
  - isRefreshNeeded
```
public boolean isRefreshNeeded()
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    isRefreshNeeded in interface RetrievalService
    
    Returns:
    
    DOCUMENT ME!
  - setRefreshNeeded
```
public void setRefreshNeeded(boolean refreshNeeded)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    setRefreshNeeded in interface RetrievalService
    
    Parameters:
    
    refreshNeeded - DOCUMENT ME!
  - hasErrors
```
public boolean hasErrors()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener l)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    removePropertyChangeListener in interface RetrievalService
    
    Parameters:
    
    l - DOCUMENT ME!
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener l)
```
    Description copied from interface: RetrievalService
    
    DOCUMENT ME!
    
    Specified by:
    
    addPropertyChangeListener in interface RetrievalService
    
    Parameters:
    
    l - DOCUMENT ME!

Class AbstractRetrievalService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROGRESS_PROPERTY

PROGRESS_REFRESH

DEBUG

progress

refreshNeeded

listeners

propertyChangeSupport

errorObject

Constructor Detail

AbstractRetrievalService

Method Detail

removeRetrievalListener

addRetrievalListener

fireRetrievalStarted

fireRetrievalProgress

fireRetrievalComplete

fireRetrievalAborted

fireRetrievalError

retrieve

clone

cloneWithoutRetrievalListeners

getListeners

getProgress

setProgress

getErrorObject

setErrorObject

isRefreshNeeded

setRefreshNeeded

hasErrors

removePropertyChangeListener

addPropertyChangeListener