org.geotools.styling
Interface Style

All Superinterfaces:

GTComponent

All Known Subinterfaces:

NamedStyle

All Known Implementing Classes:

BasicLineStyle, BasicPolygonStyle, NamedStyleImpl, StyleImpl

public interface Style

extends GTComponent

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>
 

Version:

$Id: Style.java 17702 2006-01-23 00:08:55Z desruisseaux $

Author:

James Macgill

Method Summary

void	accept(StyleVisitor visitor) Used to navigate Style information during portrayal.
void	addFeatureTypeStyle(FeatureTypeStyle type)
java.lang.String	getAbstract() Description of this style
FeatureTypeStyle[]	getFeatureTypeStyles() Array of FeatureTypeStyles in portrayal order.
java.lang.String	getName() Style name (machine readable, don't show to users)
java.lang.String	getTitle()
boolean	isDefault() Indicates that this is the default style.
void	setAbstract(java.lang.String abstractStr)
void	setDefault(boolean isDefault) Indicates that this is the default style.
void	setFeatureTypeStyles(FeatureTypeStyle[] types)
void	setName(java.lang.String name)
void	setTitle(java.lang.String title)

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

getName

public java.lang.String getName()

Style name (machine readable, don't show to users)

setName

public void setName(java.lang.String name)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getAbstract

public java.lang.String getAbstract()

Description of this style

setAbstract

public void setAbstract(java.lang.String abstractStr)

isDefault

public boolean isDefault()

Indicates that this is the default style.

setDefault

public 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 -

getFeatureTypeStyles

public FeatureTypeStyle[] getFeatureTypeStyles()

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

public void setFeatureTypeStyles(FeatureTypeStyle[] types)

addFeatureTypeStyle

public void addFeatureTypeStyle(FeatureTypeStyle type)

accept

public void accept(StyleVisitor visitor)

Used to navigate Style information during portrayal.

Parameters:

visitor -