de.cismet.cismap.commons.raster.wms

Class WMSServiceLayer

java.lang.Object

de.cismet.cismap.commons.retrieval.AbstractRetrievalService

de.cismet.cismap.commons.raster.wms.AbstractWMS

de.cismet.cismap.commons.raster.wms.AbstractWMSServiceLayer

de.cismet.cismap.commons.raster.wms.WMSServiceLayer

All Implemented Interfaces:

ChildrenProvider, LayerInfoProvider, PNodeProvider, MapService, RasterMapService, RetrievalListener, RetrievalService, RetrievalServiceLayer, ServiceLayer, de.cismet.tools.PropertyEqualsProvider

public final class WMSServiceLayer
extends AbstractWMSServiceLayer
implements RetrievalServiceLayer, RasterMapService, de.cismet.tools.PropertyEqualsProvider, LayerInfoProvider, ChildrenProvider

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATETOKEN_CUSTOMSTYLE_LAYERNAME
static String	TEMPLATETOKEN_CUSTOMSTYLE_TITLE

Fields inherited from class de.cismet.cismap.commons.raster.wms.AbstractWMS

bb, enabled, height, ir, layerPosition, name, translucency, visible, width

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
WMSServiceLayer() Creates a new WMSServiceLayer object.
WMSServiceLayer(org.jdom.Element wmsServiceLayerElement, HashMap<String,de.cismet.commons.wms.capabilities.WMSCapabilities> capabilities) Creates a new WMSServiceLayer object.
WMSServiceLayer(de.cismet.commons.wms.capabilities.Layer l) Creates a new WMSServiceLayer object.
WMSServiceLayer(List treePaths) Creates a new WMSServiceLayer object.
WMSServiceLayer(List treePaths, boolean reverseLayerOrder, boolean reverseSubLayerOrder) Creates a new WMSServiceLayer object.

Method Summary

Modifier and Type	Method and Description
protected void	addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer) DOCUMENT ME!
protected void	addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer, de.cismet.commons.wms.capabilities.Style selectedStyle) DOCUMENT ME!
protected void	addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer, de.cismet.commons.wms.capabilities.Style selectedStyle, boolean enabled, boolean info) DOCUMENT ME!
protected void	addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer, de.cismet.commons.wms.capabilities.Style selectedStyle, boolean enabled, boolean info, boolean addSubLayer) DOCUMENT ME!
protected void	addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer, de.cismet.commons.wms.capabilities.Style selectedStyle, boolean enabled, boolean info, boolean addSubLayer, boolean reverseSubLayerOrder) DOCUMENT ME!
protected void	addLayer(String name, String styleName, boolean enabled, boolean info) DOCUMENT ME!
Object	clone()
void	disableWhenChildrenDisabled() disables the layer, if all child layers are disabled.
String	getBackgroundColor() DOCUMENT ME!
String	getCapabilitiesUrl() DOCUMENT ME!
Collection	getChildren() DOCUMENT ME!
org.jdom.Element	getElement() DOCUMENT ME!
String	getExceptionsFormat() DOCUMENT ME!
String	getGetFeatureInfoUrl(int x, int y, WMSLayer l) DOCUMENT ME!
String	getGetFeatureInfoUrl(int x, int y, WMSLayer l, String format) DOCUMENT ME!
String	getImageFormat() DOCUMENT ME!
de.cismet.commons.wms.capabilities.Layer	getLayerInformation() DOCUMENT ME!
String	getLayerURI() DOCUMENT ME!
edu.umd.cs.piccolo.PNode	getPNode() DOCUMENT ME!
String	getServerURI() DOCUMENT ME!
String	getSrs() DOCUMENT ME!
String	getTitle() Returns the title of this layer.
de.cismet.commons.wms.capabilities.WMSCapabilities	getWmsCapabilities() DOCUMENT ME!
List	getWMSLayers() DOCUMENT ME!
boolean	isDummy() DOCUMENT ME!
boolean	isLayerQuerySelected() DOCUMENT ME!
boolean	isQueryable() DOCUMENT ME!
boolean	propertyEquals(Object obj)
void	removeLayer(WMSLayer layer) DOCUMENT ME!
void	retrieve(boolean forced) DOCUMENT ME!
void	setBackgroundColor(String backgroundColor) DOCUMENT ME!
void	setCapabilitiesUrl(String capabilitiesUrl) DOCUMENT ME!
void	setCustomSLD(String customSLD) DOCUMENT ME!
void	setEnabled(boolean enabled) DOCUMENT ME!
void	setExceptionsFormat(String exceptionsFormat) DOCUMENT ME!
void	setImageFormat(String imageFormat) DOCUMENT ME!
void	setLayerQuerySelected(boolean selected) DOCUMENT ME!
void	setPNode(edu.umd.cs.piccolo.PNode imageObject) DOCUMENT ME!
void	setSrs(String srs) DOCUMENT ME!
void	setTitle(String title) Sets the tile of this layer.
void	setWmsCapabilities(de.cismet.commons.wms.capabilities.WMSCapabilities wmsCapabilities) DOCUMENT ME!
String	toString()

Methods inherited from class de.cismet.cismap.commons.raster.wms.AbstractWMS

canBeDisabled, getLayerPosition, getName, getTranslucency, isEnabled, isVisible, retrievalAborted, retrievalComplete, retrievalError, retrievalProgress, retrievalStarted, setBoundingBox, setLayerPosition, setName, setSize, setTranslucency, setVisible

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.ServiceLayer

canBeDisabled, getLayerPosition, getName, getTranslucency, isEnabled, setLayerPosition, setName, setTranslucency

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

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

Methods inherited from interface de.cismet.cismap.commons.rasterservice.MapService

getTranslucency, isVisible, setBoundingBox, setSize

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

retrievalAborted, retrievalComplete, retrievalError, retrievalProgress, retrievalStarted

Field Detail

TEMPLATETOKEN_CUSTOMSTYLE_LAYERNAME

public static final String TEMPLATETOKEN_CUSTOMSTYLE_LAYERNAME

See Also:

Constant Field Values

TEMPLATETOKEN_CUSTOMSTYLE_TITLE

public static final String TEMPLATETOKEN_CUSTOMSTYLE_TITLE

See Also:

Constant Field Values

Constructor Detail

WMSServiceLayer

public WMSServiceLayer()

Creates a new WMSServiceLayer object.

WMSServiceLayer

public WMSServiceLayer(List treePaths)

Creates a new WMSServiceLayer object.

Parameters:

treePaths - DOCUMENT ME!

WMSServiceLayer

public WMSServiceLayer(de.cismet.commons.wms.capabilities.Layer l)

Creates a new WMSServiceLayer object.

Parameters:

l - The layer from which to create a WMSServiceLayer.

WMSServiceLayer

public WMSServiceLayer(org.jdom.Element wmsServiceLayerElement,
                       HashMap<String,de.cismet.commons.wms.capabilities.WMSCapabilities> capabilities)

Creates a new WMSServiceLayer object.

Parameters:

wmsServiceLayerElement - DOCUMENT ME!

capabilities - DOCUMENT ME!

WMSServiceLayer

public WMSServiceLayer(List treePaths,
                       boolean reverseLayerOrder,
                       boolean reverseSubLayerOrder)

Creates a new WMSServiceLayer object.

Parameters:

treePaths - DOCUMENT ME!

reverseLayerOrder - DOCUMENT ME!

reverseSubLayerOrder - DOCUMENT ME!

Method Detail

setTitle

public void setTitle(String title)

Sets the tile of this layer. TODO: Move to upper class

Parameters:

title - The title.

getTitle

public String getTitle()

Returns the title of this layer.

Returns:

The title.

addLayer

protected void addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer,
                        de.cismet.commons.wms.capabilities.Style selectedStyle,
                        boolean enabled,
                        boolean info)

DOCUMENT ME!

Parameters:

nextLayer - DOCUMENT ME!

selectedStyle - DOCUMENT ME!

enabled - DOCUMENT ME!

info - DOCUMENT ME!

addLayer

protected void addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer,
                        de.cismet.commons.wms.capabilities.Style selectedStyle,
                        boolean enabled,
                        boolean info,
                        boolean addSubLayer)

DOCUMENT ME!

Parameters:

nextLayer - DOCUMENT ME!

selectedStyle - DOCUMENT ME!

enabled - DOCUMENT ME!

info - DOCUMENT ME!

addSubLayer - DOCUMENT ME!

addLayer

protected void addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer,
                        de.cismet.commons.wms.capabilities.Style selectedStyle,
                        boolean enabled,
                        boolean info,
                        boolean addSubLayer,
                        boolean reverseSubLayerOrder)

DOCUMENT ME!

Parameters:

nextLayer - DOCUMENT ME!

selectedStyle - DOCUMENT ME!

enabled - DOCUMENT ME!

info - DOCUMENT ME!

addSubLayer - DOCUMENT ME!

reverseSubLayerOrder - DOCUMENT ME!

addLayer

protected void addLayer(String name,
                        String styleName,
                        boolean enabled,
                        boolean info)

DOCUMENT ME!

Parameters:

name - nextLayer DOCUMENT ME!

styleName - DOCUMENT ME!

enabled - DOCUMENT ME!

info - DOCUMENT ME!

addLayer

protected void addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer,
                        de.cismet.commons.wms.capabilities.Style selectedStyle)

DOCUMENT ME!

Parameters:

nextLayer - DOCUMENT ME!

selectedStyle - DOCUMENT ME!

addLayer

protected void addLayer(de.cismet.commons.wms.capabilities.Layer nextLayer)

DOCUMENT ME!

Parameters:

nextLayer - DOCUMENT ME!

removeLayer

public void removeLayer(WMSLayer layer)

DOCUMENT ME!

Parameters:

layer - DOCUMENT ME!

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

setEnabled in interface ServiceLayer

Overrides:

setEnabled in class AbstractWMS

Parameters:

enabled - DOCUMENT ME!

disableWhenChildrenDisabled

public void disableWhenChildrenDisabled()

disables the layer, if all child layers are disabled.

toString

public String toString()

Overrides:

toString in class Object

getWMSLayers

public List getWMSLayers()

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!

getImageFormat

public String getImageFormat()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setImageFormat

public void setImageFormat(String imageFormat)

DOCUMENT ME!

Parameters:

imageFormat - DOCUMENT ME!

getBackgroundColor

public String getBackgroundColor()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

DOCUMENT ME!

Parameters:

backgroundColor - DOCUMENT ME!

getExceptionsFormat

public String getExceptionsFormat()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setExceptionsFormat

public void setExceptionsFormat(String exceptionsFormat)

DOCUMENT ME!

Parameters:

exceptionsFormat - DOCUMENT ME!

getSrs

public String getSrs()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setSrs

public void setSrs(String srs)

DOCUMENT ME!

Parameters:

srs - DOCUMENT ME!

getGetFeatureInfoUrl

public String getGetFeatureInfoUrl(int x,
                                   int y,
                                   WMSLayer l)

DOCUMENT ME!

Parameters:

x - DOCUMENT ME!

y - DOCUMENT ME!

l - DOCUMENT ME!

Returns:

DOCUMENT ME!

getGetFeatureInfoUrl

public String getGetFeatureInfoUrl(int x,
                                   int y,
                                   WMSLayer l,
                                   String format)

DOCUMENT ME!

Parameters:

x - DOCUMENT ME!

y - DOCUMENT ME!

l - DOCUMENT ME!

format - DOCUMENT ME!

Returns:

DOCUMENT ME!

getWmsCapabilities

public de.cismet.commons.wms.capabilities.WMSCapabilities getWmsCapabilities()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setWmsCapabilities

public void setWmsCapabilities(de.cismet.commons.wms.capabilities.WMSCapabilities wmsCapabilities)

DOCUMENT ME!

Parameters:

wmsCapabilities - 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!

getCapabilitiesUrl

public String getCapabilitiesUrl()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setCapabilitiesUrl

public void setCapabilitiesUrl(String capabilitiesUrl)

DOCUMENT ME!

Parameters:

capabilitiesUrl - DOCUMENT ME!

setCustomSLD

public void setCustomSLD(String customSLD)

DOCUMENT ME!

Parameters:

customSLD - DOCUMENT ME!

getElement

public org.jdom.Element getElement()

DOCUMENT ME!

Returns:

DOCUMENT ME!

clone

public Object clone()

Specified by:

clone in class AbstractRetrievalService

propertyEquals

public boolean propertyEquals(Object obj)

Specified by:

propertyEquals in interface de.cismet.tools.PropertyEqualsProvider

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!

getChildren

public Collection getChildren()

Description copied from interface: ChildrenProvider

DOCUMENT ME!

Specified by:

getChildren in interface ChildrenProvider

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!

isDummy

public boolean isDummy()

DOCUMENT ME!

Returns:

DOCUMENT ME!