Package com.luciad.wms.client.model

Class ALcdWMSNamedLayerStyle

java.lang.Object

com.luciad.wms.client.model.ALcdWMSNamedLayerStyle

public abstract class ALcdWMSNamedLayerStyle
extends Object

A style object for a named layer. It is uniquely identified by a name and has a human readable title and an abstract.

This class corresponds to the WMS Style concept from [WMS 1.1.1], pages 24-31.

Constructor Summary

Constructors

Constructor	Description
ALcdWMSNamedLayerStyle()

Method Summary

Modifier and Type	Method	Description
TLcdOGCWMSURL	getLegendURL(int aIndex)	Returns the TLcdOGCWMSURL representing a LegendURL at the given index.
int	getLegendURLCount()	Returns the number of TLcdOGCWMSURL objects representing LegendURLs.
abstract String	getStyleAbstract()	Returns an abstract of this named layer style.
abstract String	getStyleName()	Returns the name of this named layer style.
TLcdOGCWMSURL	getStyleSheetURL()	Returns the TLcdOGCWMSURL representing a StyleSheetURL.
abstract String	getStyleTitle()	Returns the title of this named layer style.
TLcdOGCWMSURL	getStyleURL()	Returns the TLcdOGCWMSURL representing a StyleURL.

Methods inherited from class java.lang.Object

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

Constructor Details

ALcdWMSNamedLayerStyle

public ALcdWMSNamedLayerStyle()

Method Details

getStyleName

public abstract String getStyleName()

Returns the name of this named layer style. The name is a unique identifier for the named layer style.

Returns:

the name of this named layer style.

getStyleTitle

public abstract String getStyleTitle()

Returns the title of this named layer style. It is a human readable string representation for use in a menu.

Returns:

the title of this named layer style.

getStyleAbstract

public abstract String getStyleAbstract()

Returns an abstract of this named layer style. It provides a narrative description of what this layer style represents. As this is optional null may be returned.

Returns:

an abstract of this named layer style.

getLegendURLCount

public int getLegendURLCount()

Returns the number of TLcdOGCWMSURL objects representing LegendURLs.

By default, 0 is returned.

Returns:

the number of TLcdOGCWMSURL objects representing LegendURLs.

getLegendURL

public TLcdOGCWMSURL getLegendURL(int aIndex)
                           throws IndexOutOfBoundsException

Returns the TLcdOGCWMSURL representing a LegendURL at the given index.

By default, no LegendURLs are available and an IndexOutOfBoundsException will be thrown.

Parameters:

aIndex - the index of the TLcdOGCWMSURL representing a LegendURL.

Returns:

the TLcdOGCWMSURL representing a LegendURL at the given index.

Throws:

IndexOutOfBoundsException - if the index value is invalid.

getStyleSheetURL

public TLcdOGCWMSURL getStyleSheetURL()

Returns the TLcdOGCWMSURL representing a StyleSheetURL.

By default, no StyleSheetURL is available and null is returned.

Returns:

the TLcdOGCWMSURL representing a StyleSheetURL.

getStyleURL

public TLcdOGCWMSURL getStyleURL()

Returns the TLcdOGCWMSURL representing a StyleURL.

By default, no StyleURL is available and null is returned.

Returns:

the TLcdOGCWMSURL representing a StyleURL.