org.geotools.styling
Interface NamedStyle

All Superinterfaces:
Style
All Known Implementing Classes:
NamedStyleImpl

public interface NamedStyle
extends Style

A NamedStyle is used to refer to a style that has a name in a WMS.

A NamedStyle is a Style that has only Name, so all setters other than setName will throw an UnsupportedOperationException

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

 <xsd:element name="NamedStyle">
   <xsd:annotation>
     <xsd:documentation>
       A NamedStyle is used to refer to a style that has a name in a WMS.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:Name"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>
 

Author:
James Macgill
Module:

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

Method Detail

getName

String getName()
Description copied from interface: Style
Style name (machine readable, don't show to users)

Specified by:
getName in interface Style

setName

void setName(String name)
Specified by:
setName in interface Style

getTitle

String getTitle()
Deprecated. Use getDescription().getTitle().toString()

Human readible title.

Specified by:
getTitle in interface Style
Returns:
getDescription().getTitle().toString()

setTitle

void setTitle(String title)
Deprecated. Use getDescription().setTitle()

Specified by:
setTitle in interface Style
Parameters:
title - Human readible title

getAbstract

String getAbstract()
Deprecated. Use getDescription().getAbstract()

Description copied from interface: Style
Description of this style

Specified by:
getAbstract in interface Style
Returns:
getDescription().getAbstract()

setAbstract

void setAbstract(String abstractStr)
Deprecated. Use getDescription().setAbstract()

Specified by:
setAbstract in interface Style
Parameters:
abstractStr - Description of this style

isDefault

boolean isDefault()
Description copied from interface: Style
Indicates that this is the default style.

Specified by:
isDefault in interface Style
Returns:
true if this is the default style to use

setDefault

void setDefault(boolean isDefault)
Description copied from interface: Style
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.

Specified by:
setDefault in interface Style

getFeatureTypeStyles

FeatureTypeStyle[] getFeatureTypeStyles()
Description copied from interface: Style
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.

Specified by:
getFeatureTypeStyles in interface Style

setFeatureTypeStyles

void setFeatureTypeStyles(FeatureTypeStyle[] types)
Specified by:
setFeatureTypeStyles in interface Style

addFeatureTypeStyle

void addFeatureTypeStyle(FeatureTypeStyle type)
Specified by:
addFeatureTypeStyle in interface Style

accept

void accept(StyleVisitor visitor)
Description copied from interface: Style
Used to navigate Style information during portrayal.

Specified by:
accept in interface Style


Copyright © 1996-2009 Geotools. All Rights Reserved.