de.cismet.cismap.commons.rasterservice

Class ImageRasterService

java.lang.Object

de.cismet.cismap.commons.retrieval.AbstractRetrievalService

de.cismet.cismap.commons.rasterservice.ImageRasterService

All Implemented Interfaces:

LayerInfoProvider, PNodeProvider, MapService, RasterMapService, RetrievalListener, RetrievalService, RetrievalServiceLayer, ServiceLayer

public class ImageRasterService
extends AbstractRetrievalService
implements MapService, RasterMapService, RetrievalServiceLayer, LayerInfoProvider, RetrievalListener, ServiceLayer

This service can be used like a wms, but its data sources are image files.

Version:

$Revision$, $Date$

Author:

therter

Field Summary

Fields inherited from class de.cismet.cismap.commons.retrieval.AbstractRetrievalService

DEBUG, errorObject, listeners, progress, PROGRESS_PROPERTY, PROGRESS_REFRESH, propertyChangeSupport, refreshNeeded

Fields inherited from interface de.cismet.cismap.commons.ServiceLayer

LAYER_DISABLED_INVISIBLE, LAYER_DISABLED_VISIBLE, LAYER_ENABLED_INVISIBLE, LAYER_ENABLED_VISIBLE

Constructor Summary

Constructors

Constructor and Description
ImageRasterService(org.jdom.Element object) Creates a new SimpleWMS object.
ImageRasterService(File imageFile, ImageFileUtils.Mode mode) Creates a new instance of SimpleWMS.
ImageRasterService(ImageRasterService s) Creates a new SimpleWMS object.

Method Summary

Modifier and Type	Method and Description
boolean	canBeDisabled() DOCUMENT ME!
Object	clone()
org.jdom.Element	getElement() DOCUMENT ME!
com.vividsolutions.jts.geom.Geometry	getEnvelope() DOCUMENT ME!
File	getImageFile() DOCUMENT ME!
de.cismet.commons.wms.capabilities.Layer	getLayerInformation() DOCUMENT ME!
int	getLayerPosition() DOCUMENT ME!
String	getLayerURI() DOCUMENT ME!
ImageFileUtils.Mode	getMode() DOCUMENT ME!
String	getName() DOCUMENT ME!
edu.umd.cs.piccolo.PNode	getPNode() DOCUMENT ME!
org.apache.commons.httpclient.HttpClient	getPreferredClient() DOCUMENT ME!
String	getServerURI() DOCUMENT ME!
float	getTranslucency() DOCUMENT ME!
boolean	isEnabled() DOCUMENT ME!
boolean	isLayerQuerySelected() DOCUMENT ME!
boolean	isQueryable() DOCUMENT ME!
boolean	isVisible() DOCUMENT ME!
void	retrievalAborted(RetrievalEvent e) DOCUMENT ME!
void	retrievalComplete(RetrievalEvent e) DOCUMENT ME!
void	retrievalError(RetrievalEvent e) DOCUMENT ME!
void	retrievalProgress(RetrievalEvent e) DOCUMENT ME!
void	retrievalStarted(RetrievalEvent e) DOCUMENT ME!
void	retrieve(boolean forced) DOCUMENT ME!
void	setBoundingBox(BoundingBox bb) DOCUMENT ME!
void	setEnabled(boolean enabled) DOCUMENT ME!
void	setImageFile(File imageFile) DOCUMENT ME!
void	setLayerPosition(int layerPosition) DOCUMENT ME!
void	setLayerQuerySelected(boolean selected) DOCUMENT ME!
void	setName(String name) DOCUMENT ME!
void	setPNode(edu.umd.cs.piccolo.PNode imageObject) DOCUMENT ME!
void	setPreferredClient(org.apache.commons.httpclient.HttpClient preferredClient) DOCUMENT ME!
void	setSize(int height, int width) DOCUMENT ME!
void	setTranslucency(float translucency) Setter for the translucency of this layer.
void	setVisible(boolean visible) DOCUMENT ME!
String	toString()

Methods inherited from class de.cismet.cismap.commons.retrieval.AbstractRetrievalService

addPropertyChangeListener, addRetrievalListener, cloneWithoutRetrievalListeners, fireRetrievalAborted, fireRetrievalComplete, fireRetrievalError, fireRetrievalProgress, fireRetrievalStarted, getErrorObject, getListeners, getProgress, hasErrors, isRefreshNeeded, removePropertyChangeListener, removeRetrievalListener, setErrorObject, setProgress, setRefreshNeeded

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.cismap.commons.RetrievalServiceLayer

getErrorObject, hasErrors, setErrorObject

Methods inherited from interface de.cismet.cismap.commons.retrieval.RetrievalService

addPropertyChangeListener, addRetrievalListener, getProgress, isRefreshNeeded, removePropertyChangeListener, removeRetrievalListener, setProgress, setRefreshNeeded

Constructor Detail

ImageRasterService

public ImageRasterService(ImageRasterService s)

Creates a new SimpleWMS object.

Parameters:

s - DOCUMENT ME!

ImageRasterService

public ImageRasterService(org.jdom.Element object)
                   throws Exception

Creates a new SimpleWMS object.

Parameters:

object - DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

ImageRasterService

public ImageRasterService(File imageFile,
                          ImageFileUtils.Mode mode)

Creates a new instance of SimpleWMS.

Parameters:

imageFile - gmUrl DOCUMENT ME!

mode - DOCUMENT ME!

Method Detail

getMode

public ImageFileUtils.Mode getMode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getElement

public org.jdom.Element getElement()

DOCUMENT ME!

Returns:

DOCUMENT ME!

retrieve

public void retrieve(boolean forced)

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

retrieve in interface RetrievalService

Specified by:

retrieve in class AbstractRetrievalService

Parameters:

forced - DOCUMENT ME!

getImageFile

public File getImageFile()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setImageFile

public void setImageFile(File imageFile)

DOCUMENT ME!

Parameters:

imageFile - gmUrl DOCUMENT ME!

setPNode

public void setPNode(edu.umd.cs.piccolo.PNode imageObject)

Description copied from interface: PNodeProvider

DOCUMENT ME!

Specified by:

setPNode in interface PNodeProvider

Parameters:

imageObject - DOCUMENT ME!

getPNode

public edu.umd.cs.piccolo.PNode getPNode()

Description copied from interface: PNodeProvider

DOCUMENT ME!

Specified by:

getPNode in interface PNodeProvider

Returns:

DOCUMENT ME!

clone

public Object clone()

Specified by:

clone in class AbstractRetrievalService

getName

public String getName()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

getName in interface ServiceLayer

Returns:

DOCUMENT ME!

setName

public void setName(String name)

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

setName in interface ServiceLayer

Parameters:

name - DOCUMENT ME!

toString

public String toString()

Overrides:

toString in class Object

getPreferredClient

public org.apache.commons.httpclient.HttpClient getPreferredClient()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setPreferredClient

public void setPreferredClient(org.apache.commons.httpclient.HttpClient preferredClient)

DOCUMENT ME!

Parameters:

preferredClient - DOCUMENT ME!

getLayerURI

public String getLayerURI()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getLayerURI in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getServerURI

public String getServerURI()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getServerURI in interface LayerInfoProvider

Returns:

DOCUMENT ME!

isLayerQuerySelected

public boolean isLayerQuerySelected()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

isLayerQuerySelected in interface LayerInfoProvider

Returns:

DOCUMENT ME!

setLayerQuerySelected

public void setLayerQuerySelected(boolean selected)

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

setLayerQuerySelected in interface LayerInfoProvider

Parameters:

selected - DOCUMENT ME!

isQueryable

public boolean isQueryable()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

isQueryable in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getLayerInformation

public de.cismet.commons.wms.capabilities.Layer getLayerInformation()

Description copied from interface: LayerInfoProvider

DOCUMENT ME!

Specified by:

getLayerInformation in interface LayerInfoProvider

Returns:

DOCUMENT ME!

getEnvelope

public com.vividsolutions.jts.geom.Geometry getEnvelope()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setBoundingBox

public void setBoundingBox(BoundingBox bb)

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

setBoundingBox in interface MapService

Parameters:

bb - DOCUMENT ME!

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

setEnabled in interface ServiceLayer

Parameters:

enabled - DOCUMENT ME!

setSize

public void setSize(int height,
                    int width)

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

setSize in interface MapService

Parameters:

height - DOCUMENT ME!

width - DOCUMENT ME!

isEnabled

public boolean isEnabled()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

isEnabled in interface ServiceLayer

Returns:

DOCUMENT ME!

canBeDisabled

public boolean canBeDisabled()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

canBeDisabled in interface ServiceLayer

Returns:

DOCUMENT ME!

retrievalStarted

public void retrievalStarted(RetrievalEvent e)

Description copied from interface: RetrievalListener

DOCUMENT ME!

Specified by:

retrievalStarted in interface RetrievalListener

Parameters:

e - DOCUMENT ME!

retrievalProgress

public void retrievalProgress(RetrievalEvent e)

Description copied from interface: RetrievalListener

DOCUMENT ME!

Specified by:

retrievalProgress in interface RetrievalListener

Parameters:

e - DOCUMENT ME!

retrievalError

public void retrievalError(RetrievalEvent e)

Description copied from interface: RetrievalListener

DOCUMENT ME!

Specified by:

retrievalError in interface RetrievalListener

Parameters:

e - DOCUMENT ME!

retrievalComplete

public void retrievalComplete(RetrievalEvent e)

Description copied from interface: RetrievalListener

DOCUMENT ME!

Specified by:

retrievalComplete in interface RetrievalListener

Parameters:

e - DOCUMENT ME!

retrievalAborted

public void retrievalAborted(RetrievalEvent e)

Description copied from interface: RetrievalListener

DOCUMENT ME!

Specified by:

retrievalAborted in interface RetrievalListener

Parameters:

e - DOCUMENT ME!

getLayerPosition

public int getLayerPosition()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

getLayerPosition in interface ServiceLayer

Returns:

DOCUMENT ME!

setLayerPosition

public void setLayerPosition(int layerPosition)

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

setLayerPosition in interface ServiceLayer

Parameters:

layerPosition - DOCUMENT ME!

getTranslucency

public float getTranslucency()

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

getTranslucency in interface MapService

Specified by:

getTranslucency in interface ServiceLayer

Returns:

DOCUMENT ME!

setTranslucency

public void setTranslucency(float translucency)

Description copied from interface: ServiceLayer

Setter for the translucency of this layer. The value shall be between 0.0 and 1.0 (0.0 <= translucency <= 1.0) which represents the translucency percentage. However, this percentage effectively is interpreted as the opacity of the layer, e.g. if this operation receives 1.0 as a parameter the layer will become fully opaque and not transparent.

Specified by:

setTranslucency in interface ServiceLayer

Parameters:

translucency - the opacity percentage (0.0 <= translucency <= 1.0)

isVisible

public boolean isVisible()

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

isVisible in interface MapService

Returns:

DOCUMENT ME!

setVisible

public void setVisible(boolean visible)

DOCUMENT ME!

Parameters:

visible - DOCUMENT ME!