com.moximedia.ows
Interface Layer

All Known Implementing Classes:

AcetateLayer, WfsLayer, WmsLayer

public interface Layer

Author:

jdc

Method Summary

boolean	getCanDrillIdentify() Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.
boolean	getCanIdentify() Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.
boolean	getCanSetVisibility() Gets a boolean value indicating whether the layer can be turned on and off by the user.
int	getGeometryType() Gets the geometry type enumerator, if one is set for this layer.
java.lang.String	getId() Gets the user defined id for this layer.
java.lang.String	getIdentifyHandler() Gets the identify handler script used for this layer.
java.lang.String	getIdentifySuffix() Gets the suffix used in the append type of identify handler.
int	getIdentifyType() Gets the identify type enumerator.
boolean	getIdentifyWindow() Returns whether the identify report should open in a popup window.
boolean	getImmediateRefresh() Returns an indicator of whether the map should immediately refresh when the layer's visibility is changed.
LayerListLegends	getLayerListLegends() Gets the layer list legends object for this layer, or null if there are no layer list legends.
int	getLayerType() Get the layer type enumerator.
java.lang.String	getLegendUrl() Gets the URL to the legend for this layer.
double	getMaxScale() Gets the maximum scale at which the layer will be displayed.
java.lang.String	getMetadataUrl() Gets the URL for metadata associated with this layer.
double	getMinScale() Gets the minimum scale at which the layer will be displayed.
java.lang.String	getName() Gets the name of this layer.
int	getObjectId() Returns the IMF internal id for this layer.
java.lang.Object	getObjectTag() Gets the object tag.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <PROPERTY> element.
Recordset	getRecordset() Gets this layer's recordset containing query results.
Service	getService() Gets the service supporting this layer,
java.lang.String	getTitle() Gets the user displayed title for this layer.
int	getTransparency() Gets the transparency of this layer, as a percentage.
boolean	getTransparent() Reports whether the layer should be drawn transparent.
boolean	getVisible() Returns an indicator of whether this layer is visible.
boolean	isNamed(java.lang.String name) Checks to see if the name of this layer is that specified.
boolean	isObjectId(int id) Checks to see if the object id of this layer is that specified.
boolean	isTitled(java.lang.String title) Checks to see if the title of this layer is that specified.
boolean	isWithinScaleThreshold(double scale) Returns whether this layer is within threshold tolerance.
void	removeProperty(java.lang.String name) Removes the specified property.
void	setId(java.lang.String id) Sets the user defined id for this layer.
void	setLayerListLegends(LayerListLegends legends) Sets the layer list legends object for this layer.
void	setMaxScale(double scale) Sets the maximum scale that this layer is visible.
void	setMinScale(double scale) Sets the minimum scale that this layer is visible.
void	setObjectTag(java.lang.Object tag) Sets an object tag for this object.
void	setProjection(Projection projection) Sets the projection for this layer.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setSrs(java.lang.String srs) Sets the spatial reference system SRS of this layer.
void	setTransparency(int percentTransparent) Sets the transparency of this layer, as a percentage.
void	setVisible(boolean isVisible) Sets whether this layer is visible.
void	setXmlAttribute(Map map, java.lang.String element, 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.

Method Detail

getCanSetVisibility

public boolean getCanSetVisibility()

Gets a boolean value indicating whether the layer can be turned on and off by the user.

Returns:

True if the layer can be controlled, otherwise false.

getCanDrillIdentify

public boolean getCanDrillIdentify()

Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.

Returns:

True if the layer can be identified using the drill down identify tool, otherwise false.

getCanIdentify

public boolean getCanIdentify()

Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.

Returns:

True if the layer can be identified using the drill down identify tool, otherwise false.

getGeometryType

public int getGeometryType()

Gets the geometry type enumerator, if one is set for this layer.

Returns:

The geometry type enumerator.

getIdentifyHandler

public java.lang.String getIdentifyHandler()

Gets the identify handler script used for this layer.

Returns:

The URL of the handler script.

getIdentifySuffix

public java.lang.String getIdentifySuffix()

Gets the suffix used in the append type of identify handler. The suffix is added to the URL created.

Returns:

The suffix, if any.

getIdentifyType

public int getIdentifyType()

Gets the identify type enumerator. See com.moximedia.ows.types.LayerIdentifyType.

Returns:

The identify type enumerator.

getIdentifyWindow

public boolean getIdentifyWindow()

Returns whether the identify report should open in a popup window.

Returns:

True if it should open in a popup, otherwise false.

getImmediateRefresh

public boolean getImmediateRefresh()

Returns an indicator of whether the map should immediately refresh when the layer's visibility is changed.

Returns:

True if it should refresh immediately, otherwise false.

getId

public java.lang.String getId()

Gets the user defined id for this layer.

Returns:

The user defined id.

setId

public void setId(java.lang.String id)

Sets the user defined id for this layer.

Parameters:

id - The user defined id.

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.

getLayerType

public int getLayerType()

Get the layer type enumerator.

Returns:

An enumerator of com.moximedia.ows.types.LayerType.

getLegendUrl

public java.lang.String getLegendUrl()

Gets the URL to the legend for this layer.

Returns:

The URL of the legend, if any.

getMaxScale

public double getMaxScale()

Gets the maximum scale at which the layer will be displayed.

Returns:

The maximum scale at which the layer will be displayed.

getMinScale

public double getMinScale()

Gets the minimum scale at which the layer will be displayed.

Returns:

The minimum scale at which the layer will be displayed.

getMetadataUrl

public java.lang.String getMetadataUrl()

Gets the URL for metadata associated with this layer.

Returns:

The URL of the metadata, or null.

getName

public java.lang.String getName()

Gets the name of this layer.

Returns:

The name of the layer.

getObjectId

public int getObjectId()

Returns the IMF internal id for this layer.

Returns:

The internal id for the layer.

getRecordset

public Recordset getRecordset()

Gets this layer's recordset containing query results.

Returns:

The recordset object.

getService

public Service getService()

Gets the service supporting this layer,

Returns:

The service.

getTitle

public java.lang.String getTitle()

Gets the user displayed title for this layer. Use getName() for the internal name used in the service requests.

Returns:

The title.

getVisible

public boolean getVisible()

Returns an indicator of whether this layer is visible.

Returns:

True if it is visible, otherwise false.

isNamed

public boolean isNamed(java.lang.String name)

Checks to see if the name of this layer is that specified.

Parameters:

name - The name to check.

Returns:

True if the name matches, otherwise false.

isObjectId

public boolean isObjectId(int id)

Checks to see if the object id of this layer is that specified.

Parameters:

id - The id to check.

Returns:

True if the object id matches, otherwise false.

setProjection

public void setProjection(Projection projection)

Sets the projection for this layer. Does not set the SRS.

Parameters:

projection - The projection.

setSrs

public void setSrs(java.lang.String srs)

Sets the spatial reference system SRS of this layer. Does not set the projection.

Parameters:

srs - The SRS code.

isTitled

public boolean isTitled(java.lang.String title)

Checks to see if the title of this layer is that specified.

Parameters:

title - The title to check.

Returns:

True if the title matches, otherwise false.

getTransparent

public boolean getTransparent()

Reports whether the layer should be drawn transparent.

Returns:

True if the layer is drawn transparent, otherwise false.

isWithinScaleThreshold

public boolean isWithinScaleThreshold(double scale)

Returns whether this layer is within threshold tolerance.

Parameters:

scale - The scale to test.

Returns:

True if the layer is shown at the present scale, otherwise false.

setMaxScale

public void setMaxScale(double scale)

Sets the maximum scale that this layer is visible.

Parameters:

scale - The maximum scale.

setMinScale

public void setMinScale(double scale)

Sets the minimum scale that this layer is visible.

Parameters:

scale - The minimum scale.

setVisible

public void setVisible(boolean isVisible)

Sets whether this layer is visible.

Parameters:

isVisible - True if the layer should be shown, otherwise false.

setXmlAttribute

public void setXmlAttribute(Map map,
                            java.lang.String element,
                            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 that contains this layer.

element - The XML element tag containing this attribute.

name - The XML attribute name.

value - The XML attribute value.

frameworkPath - The URL path to the IMF.

mapConfigPath - The URL path to the location of the map configuration file.

setObjectTag

public void setObjectTag(java.lang.Object tag)

Sets an object tag for this object.

Parameters:

tag - A programmer defined element to associate with this object.

getObjectTag

public java.lang.Object getObjectTag()

Gets the object tag.

Returns:

The object tag, or null if there isn't one set.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property set in the configuration XML using a <PROPERTY> element.

Parameters:

name - The property name

Returns:

The property value, or null.

removeProperty

public void removeProperty(java.lang.String name)

Removes the specified property.

Parameters:

name - The name of the property.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Parameters:

name - The property name

value - The property value.

setTransparency

public void setTransparency(int percentTransparent)

Sets the transparency of this layer, as a percentage. Zero is fully opaque, one hundred is fully transparent.

getTransparency

public int getTransparency()

Gets the transparency of this layer, as a percentage. Zero is fully opaque, one hundred is fully transparent.

Returns:

The transparency percent.