de.cismet.cismap.commons

Class ModeLayer

java.lang.Object

de.cismet.cismap.commons.ModeLayer

All Implemented Interfaces:

ActiveLayerModelStore, PNodeProvider, MapService, RetrievalService, RetrievalServiceLayer, ServiceLayer

public class ModeLayer
extends Object
implements RetrievalServiceLayer, MapService, ActiveLayerModelStore

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,RetrievalServiceLayer>	modeLayers

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
ModeLayer() Creates a new ModeLayer object.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) DOCUMENT ME!
void	addRetrievalListener(RetrievalListener rl) DOCUMENT ME!
boolean	canBeDisabled() DOCUMENT ME!
void	forceMode(String mode) DOCUMENT ME!
ActiveLayerModel	getActiveLayerModel() DOCUMENT ME!
RetrievalServiceLayer	getCurrentLayer() DOCUMENT ME!
String	getCurrentMode() DOCUMENT ME!
Object	getErrorObject() DOCUMENT ME!
String	getLayerKey() DOCUMENT ME!
int	getLayerPosition() DOCUMENT ME!
RetrievalServiceLayer	getModeLayer(String mode) DOCUMENT ME!
Set<String>	getModes() DOCUMENT ME!
String	getName() DOCUMENT ME!
edu.umd.cs.piccolo.PNode	getPNode() DOCUMENT ME!
int	getProgress() DOCUMENT ME!
float	getTranslucency() Getter for the translucency of this layer.
boolean	hasErrors() DOCUMENT ME!
boolean	isEnabled() DOCUMENT ME!
boolean	isRefreshNeeded() DOCUMENT ME!
boolean	isVisible() DOCUMENT ME!
RetrievalServiceLayer	putModeLayer(String mode, RetrievalServiceLayer layer) DOCUMENT ME!
void	removePropertyChangeListener(PropertyChangeListener l) DOCUMENT ME!
void	removeRetrievalListener(RetrievalListener irl) DOCUMENT ME!
void	retrieve(boolean forced) DOCUMENT ME!
void	setActiveLayerModel(ActiveLayerModel alm) DOCUMENT ME!
void	setBoundingBox(BoundingBox bb) DOCUMENT ME!
void	setCrs(Crs crs) DOCUMENT ME!
void	setEnabled(boolean enabled) DOCUMENT ME!
void	setErrorObject(Object error) DOCUMENT ME!
void	setLayerKey(String layerKey) DOCUMENT ME!
void	setLayerPosition(int layerPosition) DOCUMENT ME!
void	setMode(String mode) DOCUMENT ME!
void	setMode(String mode, boolean forced) DOCUMENT ME!
void	setName(String name) DOCUMENT ME!
void	setPNode(edu.umd.cs.piccolo.PNode pNode) DOCUMENT ME!
void	setProgress(int progress) DOCUMENT ME!
void	setRefreshNeeded(boolean refreshNeeded) DOCUMENT ME!
void	setSize(int height, int width) DOCUMENT ME!
void	setTranslucency(float translucency) Setter for the translucency of this layer.
void	setVisible(boolean b) DOCUMENT ME!
org.jdom.Element	toElement() DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

modeLayers

protected HashMap<String,RetrievalServiceLayer> modeLayers

Constructor Detail

ModeLayer

public ModeLayer()

Creates a new ModeLayer object.

Method Detail

setActiveLayerModel

public void setActiveLayerModel(ActiveLayerModel alm)

Description copied from interface: ActiveLayerModelStore

DOCUMENT ME!

Specified by:

setActiveLayerModel in interface ActiveLayerModelStore

Parameters:

alm - DOCUMENT ME!

getActiveLayerModel

public ActiveLayerModel getActiveLayerModel()

Description copied from interface: ActiveLayerModelStore

DOCUMENT ME!

Specified by:

getActiveLayerModel in interface ActiveLayerModelStore

Returns:

DOCUMENT ME!

putModeLayer

public RetrievalServiceLayer putModeLayer(String mode,
                                          RetrievalServiceLayer layer)

DOCUMENT ME!

Parameters:

mode - DOCUMENT ME!

layer - DOCUMENT ME!

Returns:

DOCUMENT ME!

getModeLayer

public RetrievalServiceLayer getModeLayer(String mode)

DOCUMENT ME!

Parameters:

mode - DOCUMENT ME!

Returns:

DOCUMENT ME!

getModes

public Set<String> getModes()

DOCUMENT ME!

Returns:

DOCUMENT ME!

forceMode

public void forceMode(String mode)

DOCUMENT ME!

Parameters:

mode - DOCUMENT ME!

setMode

public void setMode(String mode)

DOCUMENT ME!

Parameters:

mode - DOCUMENT ME!

setVisible

public void setVisible(boolean b)

DOCUMENT ME!

Parameters:

b - DOCUMENT ME!

setMode

public void setMode(String mode,
                    boolean forced)

DOCUMENT ME!

Parameters:

mode - DOCUMENT ME!

forced - DOCUMENT ME!

setErrorObject

public void setErrorObject(Object error)

Description copied from interface: RetrievalServiceLayer

DOCUMENT ME!

Specified by:

setErrorObject in interface RetrievalServiceLayer

Parameters:

error - DOCUMENT ME!

getErrorObject

public Object getErrorObject()

Description copied from interface: RetrievalServiceLayer

DOCUMENT ME!

Specified by:

getErrorObject in interface RetrievalServiceLayer

Returns:

DOCUMENT ME!

hasErrors

public boolean hasErrors()

Description copied from interface: RetrievalServiceLayer

DOCUMENT ME!

Specified by:

hasErrors in interface RetrievalServiceLayer

Returns:

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!

setPNode

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

Description copied from interface: PNodeProvider

DOCUMENT ME!

Specified by:

setPNode in interface PNodeProvider

Parameters:

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

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!

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: 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 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)

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!

addRetrievalListener

public void addRetrievalListener(RetrievalListener rl)

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

addRetrievalListener in interface RetrievalService

Parameters:

rl - DOCUMENT ME!

removeRetrievalListener

public void removeRetrievalListener(RetrievalListener irl)

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

removeRetrievalListener in interface RetrievalService

Parameters:

irl - DOCUMENT ME!

retrieve

public void retrieve(boolean forced)

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

retrieve in interface RetrievalService

Parameters:

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

setCrs

public void setCrs(Crs crs)

DOCUMENT ME!

Parameters:

crs - DOCUMENT ME!

isRefreshNeeded

public boolean isRefreshNeeded()

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

isRefreshNeeded in interface RetrievalService

Returns:

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!

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: RetrievalService

DOCUMENT ME!

Specified by:

removePropertyChangeListener in interface RetrievalService

Parameters:

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

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!

getCurrentLayer

public RetrievalServiceLayer getCurrentLayer()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getCurrentMode

public String getCurrentMode()

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!

isVisible

public boolean isVisible()

Description copied from interface: MapService

DOCUMENT ME!

Specified by:

isVisible in interface MapService

Returns:

DOCUMENT ME!

toElement

public org.jdom.Element toElement()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLayerKey

public String getLayerKey()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setLayerKey

public void setLayerKey(String layerKey)

DOCUMENT ME!

Parameters:

layerKey - DOCUMENT ME!