org.geotools.styling

Interface Style

All Superinterfaces:

Style

All Known Subinterfaces:

NamedStyle

All Known Implementing Classes:

NamedStyleImpl

public interface Style
extends Style

Indicates how geographical content should be displayed (we call this a style for simplicity; in the spec it is called a UserStyle (user-defined style)).

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:

 <xsd:element name="UserStyle">
   <xsd:annotation>
     <xsd:documentation>
       A UserStyle allows user-defined styling and is semantically
       equivalent to a WMS named style.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:Name" minOccurs="0"/>
       <xsd:element ref="sld:Title" minOccurs="0"/>
       <xsd:element ref="sld:Abstract" minOccurs="0"/>
       <xsd:element ref="sld:IsDefault" minOccurs="0"/>
       <xsd:element ref="sld:FeatureTypeStyle" maxOccurs="unbounded"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>
 

Author:

James Macgill

Method Summary

Modifier and Type	Method and Description
void	accept(StyleVisitor visitor) Used to navigate Style information during portrayal.
void	addFeatureTypeStyle(FeatureTypeStyle type) Deprecated. Use featureTypeStyles().add( type )
List<FeatureTypeStyle>	featureTypeStyles() FeatureTypeStyles rendered in order of appearance in this list.
String	getAbstract() Deprecated. use getDesciption().getAbstract().toString()
Symbolizer	getDefaultSpecification() This functionality is from an ISO specificaiton; and conflicts with the idea of an else rule presented by SLD.
Description	getDescription() Description for this style.
FeatureTypeStyle[]	getFeatureTypeStyles() Deprecated. use featureTypeStyles().toArray( new FeatureTypeStyle[0] )
String	getTitle() Deprecated. use getDescription().getTitle().toString()
void	setAbstract(String abstractStr) Deprecated. use getDescription().setAbstract( new SimpleInternationalString( text ) );
void	setDefault(boolean isDefault) Indicates that this is the default style.
void	setDefaultSpecification(Symbolizer defaultSymbolizer)
void	setFeatureTypeStyles(FeatureTypeStyle[] types) Deprecated. Use featureTypeStyles().clear(); featureTypeStyles.addAll( ... )
void	setName(String name)
void	setTitle(String title) Deprecated. please use getDescription().setTitle( new SimpleInternationalString( text ) );

Methods inherited from interface Style

accept, getName, isDefault

Method Detail

setName

void setName(String name)

getDescription

Description getDescription()

Description for this style.

Specified by:

getDescription in interface Style

Returns:

Human readable description for use in user interfaces

Since:

2.5.x

getTitle

String getTitle()

Deprecated. use getDescription().getTitle().toString()

Style Title (human readable name for user interfaces)

setTitle

void setTitle(String title)

Deprecated. please use getDescription().setTitle( new SimpleInternationalString( text ) );

Parameters:

title -

getAbstract

String getAbstract()

Deprecated. use getDesciption().getAbstract().toString()

Description of this style

setAbstract

void setAbstract(String abstractStr)

Deprecated. use getDescription().setAbstract( new SimpleInternationalString( text ) );

setDefault

void setDefault(boolean isDefault)

Indicates that this is the default style.

Assume this is kept for GeoServer enabling a WMS to track which style is considered the default. May consider providing a clientProperties mechanism similar to Swing JComponent allowing applications to mark up the Style content for custom uses.

Parameters:

isDefault -

featureTypeStyles

List<FeatureTypeStyle> featureTypeStyles()

FeatureTypeStyles rendered in order of appearance in this list.

Specified by:

featureTypeStyles in interface Style

getDefaultSpecification

Symbolizer getDefaultSpecification()

This functionality is from an ISO specificaiton; and conflicts with the idea of an else rule presented by SLD.

Implementations may choose to look up the first symbolizer of an elseFilter or allow this to be provided?

Specified by:

getDefaultSpecification in interface Style

Returns:

Symbolizer to use if no rules work out.

setDefaultSpecification

void setDefaultSpecification(Symbolizer defaultSymbolizer)

Parameters:

defaultSymbolizer - To be used if a feature is not rendered by any of the rules

getFeatureTypeStyles

FeatureTypeStyle[] getFeatureTypeStyles()

Deprecated. use featureTypeStyles().toArray( new FeatureTypeStyle[0] )

Array of FeatureTypeStyles in portrayal order.

FeatureTypeStyle entries are rendered in order of appearance in this list.

Note: We are using a Array here to continue with Java 1.4 deployment.

setFeatureTypeStyles

void setFeatureTypeStyles(FeatureTypeStyle[] types)

Deprecated. Use featureTypeStyles().clear(); featureTypeStyles.addAll( ... )

addFeatureTypeStyle

void addFeatureTypeStyle(FeatureTypeStyle type)

Deprecated. Use featureTypeStyles().add( type )

accept

void accept(StyleVisitor visitor)

Used to navigate Style information during portrayal.

Parameters:

visitor -