com.mousebird.maply.sld.sldstyleset

Class SLDStyleSet

java.lang.Object

com.mousebird.maply.sld.sldstyleset.SLDStyleSet

All Implemented Interfaces:

VectorStyleInterface

public class SLDStyleSet
extends java.lang.Object
implements VectorStyleInterface

A Styled Layer Descriptor (SLD) is an XML document that describes the appearance of map layers. And SLD is made of rules. Each rule specifies a condition that must be met by a vector feature for the rule to apply to it, and how to display the vector feature if the rule applies. The sld:StyledLayerDescriptor element is the root element of the Styled Layer Descriptor document. Implements the VectorStyleInterface interface for matching and applying styles to vector objects.

See Also:

for SLD v1.1.0, for SLD v1.0.0, VectorStyleInterface

Constructor Summary

Constructors

Constructor and Description
SLDStyleSet(RenderControllerInterface viewC, AssetWrapper assetWrapper, java.lang.String sldFileName, android.util.DisplayMetrics displayMetrics, boolean useLayerNames, int relativeDrawPriority) Constructs a SLDStyleSet object.

Method Summary

Modifier and Type	Method and Description
VectorStyle[]	allStyles() Return the full list of styles.
int	backgroundColorForZoom(double zoom) Return a color for the background (clear color).
boolean	layerShouldDisplay(java.lang.String layerName, TileID tileID) Returns true if the given layer (by name) should be displayed at all.
void	loadSldInputStream() Parses the desired SLD document tree and create the corresponding symbolizers.
VectorStyle	styleForUUID(long uuid, RenderControllerInterface controller) Returns a vector style corresponding to the given unique ID.
VectorStyle[]	stylesForFeature(AttrDictionary attrs, TileID tileID, java.lang.String layerName, RenderControllerInterface controller) Return the styles that match to the given list of attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SLDStyleSet

public SLDStyleSet(RenderControllerInterface viewC,
                   AssetWrapper assetWrapper,
                   java.lang.String sldFileName,
                   android.util.DisplayMetrics displayMetrics,
                   boolean useLayerNames,
                   int relativeDrawPriority)
            throws org.xmlpull.v1.XmlPullParserException,
                   java.io.IOException

Constructs a SLDStyleSet object. This does not load the data in the SLD file. Use loadSldInputStream() for that.

Parameters:

viewC - The map or globe view controller

assetWrapper - Wrapper around the asset manager.

sldFileName - The file name of the SLD document

displayMetrics - The DisplayMetrics instance

useLayerNames - Whether to use names of NamedLayer elements as a criteria in matching styles.

relativeDrawPriority - The z-order relative to other vector features. This will be incremented internally for each style rule, so if you have multiple SLDStyleSets, leave some space between the relativeDrawPriority of each.

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

Method Detail

loadSldInputStream

public void loadSldInputStream()
                        throws org.xmlpull.v1.XmlPullParserException,
                               java.io.IOException

Parses the desired SLD document tree and create the corresponding symbolizers.

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

stylesForFeature

public VectorStyle[] stylesForFeature(AttrDictionary attrs,
                                      TileID tileID,
                                      java.lang.String layerName,
                                      RenderControllerInterface controller)

Description copied from interface: VectorStyleInterface

Return the styles that match to the given list of attributes. Each of these styles will be called to generate visible geometry. Order is not important.

Specified by:

stylesForFeature in interface VectorStyleInterface

Parameters:

attrs - The attribute dictionary from the vector feature.

tileID - The tileID if we're building from a tile source. null if not.

layerName - The layer name if the data is coming from vector tiles.

controller - Maply base controller where the

Returns:

A list of vector styles that apply to the vector data with the given attributes.

layerShouldDisplay

public boolean layerShouldDisplay(java.lang.String layerName,
                                  TileID tileID)

Description copied from interface: VectorStyleInterface

Returns true if the given layer (by name) should be displayed at all. If you return false, then those vector objects will not be displayed and potentially not even parsed.

Specified by:

layerShouldDisplay in interface VectorStyleInterface

Parameters:

layerName - Name of the layer to be displayed (or not)

tileID - If we're using a tile source, this is the tile ID. If not, it will be null.

styleForUUID

public VectorStyle styleForUUID(long uuid,
                                RenderControllerInterface controller)

Description copied from interface: VectorStyleInterface

Returns a vector style corresponding to the given unique ID. Each vector style has to have a unique ID which we'll use for sorting things.

Specified by:

styleForUUID in interface VectorStyleInterface

Parameters:

uuid - Unique ID

controller - Base controller used for the geometry.

Returns:

Vector Style to be used in displaying geometry.

allStyles

public VectorStyle[] allStyles()

Description copied from interface: VectorStyleInterface

Return the full list of styles.

Specified by:

allStyles in interface VectorStyleInterface

backgroundColorForZoom

public int backgroundColorForZoom(double zoom)

Description copied from interface: VectorStyleInterface

Return a color for the background (clear color).

Specified by:

backgroundColorForZoom in interface VectorStyleInterface