com.moximedia.ows
Class LayerGroup

java.lang.Object
  com.moximedia.ows.LayerGroup

All Implemented Interfaces:

java.io.Serializable

public class LayerGroup

extends java.lang.Object

implements java.io.Serializable

Author:

jdc

See Also:

Serialized Form

Constructor Summary

LayerGroup()
Creates new LayerGroup

Method Summary

void	addLayer(Layer layer) Adds a layer to the layer group.
Layer	getActiveLayer(double scale) Gets the active layer, or null if no layer is active.
boolean	getCanIdentify() Returns an indicator of whether the user can identify the layer group.
boolean	getCanSetVisibility() Returns an indicator of whether the user can control the visibility of the layer group on the layer list page of the IMF interface.
boolean	getImmediateRefresh() Returns whether the map should immediately refresh when the layer group visibility is changed.
LayerListLegends	getLayerListLegends() Gets the layer list legends object for this layer, or null if there are no layer list legends.
Layers	getLayers() Gets the layers object containing the layers in this layer group.
double	getMaxScale() Gets the maximum scale at which the layer group can be displayed.
java.lang.String	getMetadataUrl() Gets the metadata url for the layer group, if there is one.
double	getMinScale() Gets the minimum scale at which the layer group can be displayed.
java.lang.String	getName() Get the name of the layer group to be displayed to the user.
int	getObjectId() Gets the IMF assigned object id for this layer group.
boolean	getVisible() Gets whether the layer group visibility is on.
void	setImmediateRefresh(boolean immediateRefresh) sets whether the map should immediately refresh when the layer group visibility is changed.
void	setLayerListLegends(LayerListLegends legends) Sets the layer list legends object for this layer.
void	setName(java.lang.String name) Sets the name of the layer group to be displayed to the user.
void	setVisible(boolean isVisible) Sets whether the layer group visibility is on.
void	setXmlAttribute(Map map, java.lang.String tag, java.lang.String name, java.lang.String value, java.lang.String frameworkPath, java.lang.String mapConfigPath) Sets one of the attributes of this object using a string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerGroup

public LayerGroup()

Creates new LayerGroup

Method Detail

addLayer

public void addLayer(Layer layer)

Adds a layer to the layer group.

Parameters:

layer - The layer to add.

getActiveLayer

public Layer getActiveLayer(double scale)

Gets the active layer, or null if no layer is active. If a layer is active but not visible or not visible at the specified scale, this method doesn't return a layer.

Parameters:

scale - The map scale.

Returns:

The layer, or null.

getCanSetVisibility

public boolean getCanSetVisibility()

Returns an indicator of whether the user can control the visibility of the layer group on the layer list page of the IMF interface.

Returns:

True if the user can set the visibility, otherwise false.

getCanIdentify

public boolean getCanIdentify()

Returns an indicator of whether the user can identify the layer group.

Returns:

True if the layer group can be identified, otherwise false.

getImmediateRefresh

public boolean getImmediateRefresh()

Returns whether the map should immediately refresh when the layer group visibility is changed.

Returns:

True if the map should immediately refresh, otherwise false.

setImmediateRefresh

public void setImmediateRefresh(boolean immediateRefresh)

sets whether the map should immediately refresh when the layer group visibility is changed.

Parameters:

immediateRefresh - True if the map should immediately refresh, otherwise false.

getLayerListLegends

public LayerListLegends getLayerListLegends()

Gets the layer list legends object for this layer, or null if there are no layer list legends.

Returns:

The layer list legends object for this layer.

setLayerListLegends

public void setLayerListLegends(LayerListLegends legends)

Sets the layer list legends object for this layer.

Parameters:

legends - The layer list legends object to set for this layer.

getObjectId

public int getObjectId()

Gets the IMF assigned object id for this layer group.

Returns:

The object id.

getLayers

public Layers getLayers()

Gets the layers object containing the layers in this layer group.

Returns:

The Layers object containing the layers.

getMaxScale

public double getMaxScale()

Gets the maximum scale at which the layer group can be displayed.

Returns:

The maximum scale.

getMetadataUrl

public java.lang.String getMetadataUrl()

Gets the metadata url for the layer group, if there is one.

Returns:

The metadata URL, or null if there isn't one.

getMinScale

public double getMinScale()

Gets the minimum scale at which the layer group can be displayed.

Returns:

The minimum scale.

getName

public java.lang.String getName()

Get the name of the layer group to be displayed to the user.

Returns:

The layer group's name.

setName

public void setName(java.lang.String name)

Sets the name of the layer group to be displayed to the user.

Parameters:

name - The layer group's name.

getVisible

public boolean getVisible()

Gets whether the layer group visibility is on.

Returns:

True if the layer group's visibility is set to on, otherwise false.

setVisible

public void setVisible(boolean isVisible)

Sets whether the layer group visibility is on.

Parameters:

isVisible - True if the layer group's visibility is set to on, otherwise false.

setXmlAttribute

public void setXmlAttribute(Map map,
                            java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value,
                            java.lang.String frameworkPath,
                            java.lang.String mapConfigPath)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

map - The map object containing this layer group.

frameworkPath - The path to the IMF installation.

mapConfigPath - The path to the map configuration file.

tag - The XML element tag containing this attribute (not used).

name - The XML attribute name.

value - The XML attribute value.