de.cismet.cismap.commons.raster.wms

Class SlidableWMSServiceLayerGroup

java.lang.Object

de.cismet.cismap.commons.retrieval.AbstractRetrievalService

de.cismet.cismap.commons.raster.wms.SlidableWMSServiceLayerGroup

All Implemented Interfaces:

ActiveLayerListener, LayerInfoProvider, PNodeProvider, MapService, RasterMapService, RetrievalService, RetrievalServiceLayer, ServiceLayer, EventListener, ChangeListener

public final class SlidableWMSServiceLayerGroup
extends AbstractRetrievalService
implements RetrievalServiceLayer, RasterMapService, ChangeListener, MapService, LayerInfoProvider, ActiveLayerListener

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlidableWMSServiceLayerGroup.LabelDirection DOCUMENT ME!

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAYERNAME_FROM_CONFIG_SUFFIX A suffix which makes it clear, if a layer name was loaded from the config file.
static String	XML_ELEMENT_NAME

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
SlidableWMSServiceLayerGroup(org.jdom.Element element, HashMap<String,de.cismet.commons.wms.capabilities.WMSCapabilities> capabilities) Creates a new SlidableWMSServiceLayerGroup object.
SlidableWMSServiceLayerGroup(List treePaths) Creates a new SlidableWMSServiceLayerGroup object.
SlidableWMSServiceLayerGroup(String name, String completePath, Collection<de.cismet.commons.wms.capabilities.Layer> layers, de.cismet.commons.wms.capabilities.WMSCapabilities wmsCapabilities, String capabilitiesUrl, Crs srs) Deprecated. DOCUMENT ME!

Method Summary

Modifier and Type	Method and Description
boolean	canBeDisabled() DOCUMENT ME!
Object	clone()
boolean	equals(Object obj)
XBoundingBox	getBoundingBox() Provides the bounding box of this layer.
String	getCustomSLD() DOCUMENT ME!
de.cismet.commons.wms.capabilities.Layer	getLayerInformation() DOCUMENT ME!
int	getLayerPosition() DOCUMENT ME!
List<WMSServiceLayer>	getLayers() DOCUMENT ME!
String	getLayerURI() DOCUMENT ME!
ActionListener	getLockListener() DOCUMENT ME!
String	getName() DOCUMENT ME!
String	getPath() Returns the path of this layer.
edu.umd.cs.piccolo.PNode	getPNode() DOCUMENT ME!
String	getServerURI() DOCUMENT ME!
float	getTranslucency() Getter for the translucency of this layer.
double	getVerticalLabelWidthThreshold() DOCUMENT ME!
int	hashCode()
boolean	isCrossfadeEnabled() DOCUMENT ME!
boolean	isEnabled() DOCUMENT ME!
boolean	isLayerQuerySelected() DOCUMENT ME!
boolean	isLocked() DOCUMENT ME!
boolean	isPrintMode() See setPrintMode().
boolean	isQueryable() DOCUMENT ME!
boolean	isResourceConserving() DOCUMENT ME!
boolean	isVisible() DOCUMENT ME!
void	layerAdded(ActiveLayerEvent e) DOCUMENT ME!
void	layerAvailabilityChanged(ActiveLayerEvent e) DOCUMENT ME!
void	layerInformationStatusChanged(ActiveLayerEvent e) DOCUMENT ME!
void	layerPositionChanged(ActiveLayerEvent e) DOCUMENT ME!
void	layerRemoved(ActiveLayerEvent e) DOCUMENT ME!
void	layerSelectionChanged(ActiveLayerEvent e) DOCUMENT ME!
void	layerVisibilityChanged(ActiveLayerEvent e) DOCUMENT ME!
void	retrieve(boolean forced) DOCUMENT ME!
void	setBoundingBox(BoundingBox bb) DOCUMENT ME!
void	setCapabilitiesUrl(String capabilitiesUrl) DOCUMENT ME!
void	setCustomSLD(String customSLD) DOCUMENT ME!
void	setEnabled(boolean enabled) DOCUMENT ME!
void	setLayerPosition(int layerPosition) DOCUMENT ME!
void	setLayerQuerySelected(boolean selected) DOCUMENT ME!
void	setLocked(boolean locked) Locks the SlidableWMSServiceLayerGroup, this is not possible if RESOURCE_CONSERVING is false.
void	setName(String name) DOCUMENT ME!
void	setPNode(edu.umd.cs.piccolo.PNode imageObject) DOCUMENT ME!
void	setPrintMode(boolean printMode) Print Mode has to be set true, if this class is used with the headlessMapProvider.
void	setSize(int height, int width) DOCUMENT ME!
void	setSrs(String srs) DOCUMENT ME!
void	setTranslucency(float t) Setter for the translucency of this layer.
void	setWmsCapabilities(de.cismet.commons.wms.capabilities.WMSCapabilities wmsCapabilities) DOCUMENT ME!
void	stateChanged(ChangeEvent e)
org.jdom.Element	toElement() 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

finalize, getClass, 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

Field Detail

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

See Also:

Constant Field Values

LAYERNAME_FROM_CONFIG_SUFFIX

public static final String LAYERNAME_FROM_CONFIG_SUFFIX

A suffix which makes it clear, if a layer name was loaded from the config file.

See Also:

Constant Field Values

Constructor Detail

SlidableWMSServiceLayerGroup

public SlidableWMSServiceLayerGroup(List treePaths)

Creates a new SlidableWMSServiceLayerGroup object.

Parameters:

treePaths - DOCUMENT ME!

SlidableWMSServiceLayerGroup

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

Creates a new SlidableWMSServiceLayerGroup object.

Parameters:

element - treePaths DOCUMENT ME!

capabilities - DOCUMENT ME!

SlidableWMSServiceLayerGroup

public SlidableWMSServiceLayerGroup(String name,
                                    String completePath,
                                    Collection<de.cismet.commons.wms.capabilities.Layer> layers,
                                    de.cismet.commons.wms.capabilities.WMSCapabilities wmsCapabilities,
                                    String capabilitiesUrl,
                                    Crs srs)

Deprecated. DOCUMENT ME!

Creates a new SlidableWMSServiceLayerGroup object.

Note: Deprecated - please test before using this constructor. If everything works as expected, the deprecated tag can be removed.

Parameters:

name - DOCUMENT ME!

completePath - DOCUMENT ME!

layers - DOCUMENT ME!

wmsCapabilities - DOCUMENT ME!

capabilitiesUrl - DOCUMENT ME!

srs - DOCUMENT ME!

Method Detail

setPrintMode

public void setPrintMode(boolean printMode)

Print Mode has to be set true, if this class is used with the headlessMapProvider. If it is not set, the needed retrievalCompleteEvent will not be fired. On the other side if the retrievalCompleteEvent is fired, the sliding functionality will be destroyed, for some reason. Therefore the print mode has to be considered as a hack.

Parameters:

printMode - DOCUMENT ME!

isPrintMode

public boolean isPrintMode()

See setPrintMode().

Returns:

DOCUMENT ME!

setWmsCapabilities

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

DOCUMENT ME!

Parameters:

wmsCapabilities - DOCUMENT ME!

setCapabilitiesUrl

public void setCapabilitiesUrl(String capabilitiesUrl)

DOCUMENT ME!

Parameters:

capabilitiesUrl - DOCUMENT ME!

setSrs

public void setSrs(String srs)

DOCUMENT ME!

Parameters:

srs - DOCUMENT ME!

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

getPNode

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

Description copied from interface: PNodeProvider

DOCUMENT ME!

Specified by:

getPNode in interface PNodeProvider

Returns:

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!

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!

canBeDisabled

public boolean canBeDisabled()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

canBeDisabled in interface ServiceLayer

Returns:

DOCUMENT ME!

getLayerPosition

public int getLayerPosition()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

getLayerPosition in interface ServiceLayer

Returns:

DOCUMENT ME!

getName

public String getName()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

getName in interface ServiceLayer

Returns:

DOCUMENT ME!

getBoundingBox

public XBoundingBox getBoundingBox()

Provides the bounding box of this layer. The bounding box represents the extent of the children's bounding boxes.

Returns:

Extent of this layer.

getPath

public String getPath()

Returns the path of this layer. It's formatted by concatenating the names of parent layers with '/' as delimiter. /[<...>/]<Name of grand parent>/<Name of parent>/<Name of this layer>

Returns:

Extent of this layer.

setCustomSLD

public void setCustomSLD(String customSLD)

DOCUMENT ME!

Parameters:

customSLD - DOCUMENT ME!

getCustomSLD

public String getCustomSLD()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isEnabled

public boolean isEnabled()

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

isEnabled in interface ServiceLayer

Returns:

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!

setLayerPosition

public void setLayerPosition(int layerPosition)

Description copied from interface: ServiceLayer

DOCUMENT ME!

Specified by:

setLayerPosition in interface ServiceLayer

Parameters:

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

getTranslucency

public float getTranslucency()

Description copied from interface: ServiceLayer

Getter for the translucency of this layer. It returns a value between 0.0 and 1.0 (0.0 <= translucency <= 1.0) which represents the translucency percentage. However, this percentage effectively represents the opacity of the layer, e.g. if this operation returns 1.0 the layer is fully opaque and not transparent.

Specified by:

getTranslucency in interface MapService

Specified by:

getTranslucency in interface ServiceLayer

Returns:

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

setTranslucency

public void setTranslucency(float t)

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:

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

clone

public Object clone()

Specified by:

clone in class AbstractRetrievalService

isVisible

public boolean isVisible()

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

isVisible in interface MapService

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!

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!

toString

public String toString()

Overrides:

toString in class Object

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!

getVerticalLabelWidthThreshold

public double getVerticalLabelWidthThreshold()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isCrossfadeEnabled

public boolean isCrossfadeEnabled()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isResourceConserving

public boolean isResourceConserving()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLayerInformation

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

DOCUMENT ME!

Specified by:

getLayerInformation in interface LayerInfoProvider

Returns:

the layer capabilities object of the current layer

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isLocked

public boolean isLocked()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setLocked

public void setLocked(boolean locked)

Locks the SlidableWMSServiceLayerGroup, this is not possible if RESOURCE_CONSERVING is false. Locked means that the slider is disabled (generally) and that only the currently selected layer gets loaded. Otherwise all the layers get loaded every time.

Parameters:

locked - DOCUMENT ME!

getLockListener

public ActionListener getLockListener()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLayers

public List<WMSServiceLayer> getLayers()

DOCUMENT ME!

Returns:

DOCUMENT ME!

toElement

public org.jdom.Element toElement()

DOCUMENT ME!

Returns:

DOCUMENT ME!

layerAdded

public void layerAdded(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerAdded in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerRemoved

public void layerRemoved(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerRemoved in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerPositionChanged

public void layerPositionChanged(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerPositionChanged in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerVisibilityChanged

public void layerVisibilityChanged(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerVisibilityChanged in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerAvailabilityChanged

public void layerAvailabilityChanged(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerAvailabilityChanged in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerInformationStatusChanged

public void layerInformationStatusChanged(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerInformationStatusChanged in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!

layerSelectionChanged

public void layerSelectionChanged(ActiveLayerEvent e)

Description copied from interface: ActiveLayerListener

DOCUMENT ME!

Specified by:

layerSelectionChanged in interface ActiveLayerListener

Parameters:

e - DOCUMENT ME!