Package com.luciad.wms.server.model

Class ALcdWMSLayerStyle

java.lang.Object

com.luciad.wms.server.model.ALcdWMSLayerStyle

Direct Known Subclasses:

TLcdWMSLayerStyle

public abstract class ALcdWMSLayerStyle
extends Object

Defines a WMS layer style.

This class is a direct representation of the layer style concept introduced in the OGC WMS specification. A layer style is identified by a name and represents an available style for a layer. To describe the style, a number of optional metadata properties are available such as title, and abstract. A client can find this information in the XML capabilities and use the style name to request the layer in the corresponding style.

To render the layer with the requested style is the responsibility of the layer factories available in the WMS, represented by the interface ILcdWMSGXYLayerFactory.

Constructor Summary

Constructors

Constructor	Description
ALcdWMSLayerStyle()

Method Summary

Modifier and Type	Method	Description
abstract String	getAbstract()	Returns an abstract for this layer style.
TLcdWMSURL	getLegendURL(int aIndex)	Returns the TLcdWMSURL representing a LegendURL at the given index.
int	getLegendURLCount()	Returns the number of TLcdWMSURL objects representing LegendURLs.
abstract String	getName()	Returns the name of the layer style (required to be not null).
TLcdWMSURL	getStyleSheetURL()	Returns the TLcdWMSURL representing a StyleSheetURL.
TLcdWMSURL	getStyleURL()	Returns the TLcdWMSURL representing a StyleURL.
abstract String	getTitle()	Returns the title of the layer style.

Methods inherited from class java.lang.Object

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

Constructor Details

ALcdWMSLayerStyle

public ALcdWMSLayerStyle()

Method Details

getName

public abstract String getName()

Returns the name of the layer style (required to be not null).

Returns:

the name of the layer style (required to be not null).

getTitle

public abstract String getTitle()

Returns the title of the layer style.

Returns:

the title of the layer style.

getAbstract

public abstract String getAbstract()

Returns an abstract for this layer style.

Returns:

an abstract for this layer style. Value may be null if no abstract is available.

getLegendURLCount

public int getLegendURLCount()

Returns the number of TLcdWMSURL objects representing LegendURLs.

By default, 0 is returned.

Returns:

the number of TLcdWMSURL objects representing LegendURLs.

getLegendURL

public TLcdWMSURL getLegendURL(int aIndex)
                        throws IndexOutOfBoundsException

Returns the TLcdWMSURL 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 TLcdWMSURL representing a LegendURL.

Returns:

the TLcdWMSURL representing a LegendURL at the given index.

Throws:

IndexOutOfBoundsException - if the index value is invalid.

getStyleSheetURL

public TLcdWMSURL getStyleSheetURL()

Returns the TLcdWMSURL representing a StyleSheetURL.

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

Returns:

the TLcdWMSURL representing a StyleSheetURL.

getStyleURL

public TLcdWMSURL getStyleURL()

Returns the TLcdWMSURL representing a StyleURL.

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

Returns:

the TLcdWMSURL representing a StyleURL.