public interface FeatureTypeStyle extends FeatureTypeStyle
The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:
<xsd:element name="FeatureTypeStyle">
<xsd:annotation>
<xsd:documentation>
A FeatureTypeStyle contains styling information specific to one
feature type. This is the SLD level that separates the 'layer'
handling from the 'feature' handling.
</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:FeatureTypeName" minOccurs="0"/>
<xsd:element ref="sld:SemanticTypeIdentifier" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element ref="sld:Rule" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Modifier and Type | Field and Description |
---|---|
static String |
COMPOSITE
Applies a color composition/blending operation at the feature type style level (that is,
blending the current FTS level against the map below it).
|
static String |
COMPOSITE_BASE
Boolean value, if true the current feature type style will be treated as a base for the
subsequent feature type styles in the rendering stack (including other layer ones) as opposed
to use the merged backdrop rendered so far.
|
static String |
KEY_EVALUATION_MODE
This option influences how multiple rules matching the same feature are evaluated
|
static String |
SORT_BY
String value controlling the order in which the features are loaded from the data source, and
thus painted, in this feature type style.
|
static String |
SORT_BY_GROUP
String value controlling cross layer z-ordering.
|
static String |
VALUE_EVALUATION_MODE_ALL
The standard behavior, all the matching rules are executed
|
static String |
VALUE_EVALUATION_MODE_FIRST
Only the first matching rule gets executed, all the others are skipped
|
Modifier and Type | Method and Description |
---|---|
void |
accept(StyleVisitor visitor) |
void |
addRule(Rule rule)
Deprecated.
Please use rules().add( rule )
|
String |
getAbstract()
Deprecated.
use getDescription().getAbstract().toString()
|
Description |
getDescription()
Description for this style.
|
String |
getFeatureTypeName()
Deprecated.
this method is replaced by a live set featureTypeNames()
|
Map<String,String> |
getOptions()
Map of vendor options for the symbolizer.
|
Rule[] |
getRules()
Deprecated.
use rules().toArray( new Rule[0] )
|
String[] |
getSemanticTypeIdentifiers()
Deprecated.
this method is replaced by a live set semanticIdentifiers()
|
String |
getTitle()
Deprecated.
use getDescription.getTitle().toString()
|
Expression |
getTransformation()
The eventual transformation to be applied before rendering the data (should be an expression
taking a feature collection or a grid coverage as the evaluation context and returns a
feature collection or a grid coverage as an output)
|
boolean |
hasOption(String key)
Determines if a vendor option with the specific key has been set on this symbolizer.
|
List<Rule> |
rules()
Rules govern the appearance of any given feature to be styled by this styler.
|
void |
setAbstract(String abstractStr)
Deprecated.
Please use getDescription().setAbstract( new SimpleInternationalString(
abstractStr ))
|
void |
setFeatureTypeName(String name)
Deprecated.
Use featureTypeNames().clear() and featureTypeNames.add( new NameImpl( name ))
|
void |
setName(String name) |
void |
setOnlineResource(OnLineResource online)
It is common to have a style coming from a external xml file, this method provide a way to
get the original source if there is one.
|
void |
setRules(Rule[] rules)
Deprecated.
Please use rules().clear(); rules.addAll( rules )
|
void |
setSemanticTypeIdentifiers(String[] types)
Deprecated.
Please use semanticIdentifiers().addAll()
|
void |
setTitle(String title)
Deprecated.
please use getDescription.setTitle( new SimpleInternationalString( title ))
|
void |
setTransformation(Expression transformation)
Sets the eventual transformation to be applied before rendering the data (should be an
expression taking a feature collection or a grid coverage as an input and returns a feature
collection or a grid coverage as an output)
|
accept, featureTypeNames, getFeatureInstanceIDs, getName, getOnlineResource, semanticTypeIdentifiers
static final String KEY_EVALUATION_MODE
static final String VALUE_EVALUATION_MODE_ALL
static final String VALUE_EVALUATION_MODE_FIRST
static final String COMPOSITE
The syntax for this key is {code}
The same vendor option can also be applied at the symbolizer level to achieve different effects (feature by feature composition as oppose to layer by layer one).
Important note: for most compositing operation to work properly, the graphics used for the rendering should be derived from an image that has an alpha channel and transparent background (as most of the operations consider the transparency of the target surface in their math)
static final String COMPOSITE_BASE
static final String SORT_BY
The syntax is Attribute1 {A|D},Attribute2 {A|D}...
, A
is
ascending, D
is descending. The sorting direction is optional and defaults to
ascending if not specified.
E.g., cat D,name
sorts data by cat
in descending order, and then
by ascending name
within all features having the same cat
value.
static final String SORT_BY_GROUP
void setName(String name)
String getTitle()
void setTitle(String title)
title
- Description getDescription()
getDescription
in interface FeatureTypeStyle
String getAbstract()
void setAbstract(String abstractStr)
abstractStr
- String getFeatureTypeName()
void setFeatureTypeName(String name)
name
- The TypeName of the features to be styled by this instance.String[] getSemanticTypeIdentifiers()
This method will be replaced by a live set semanticIdentifiers() in 2.6.x
void setSemanticTypeIdentifiers(String[] types)
types
- An array of strings representing systematic types which could be styled by this
instance.Rule[] getRules()
void setRules(Rule[] rules)
rules
- The set of rules to be set for this styler.void addRule(Rule rule)
List<Rule> rules()
This is *the* list being used to manage the rules!
rules
in interface FeatureTypeStyle
void setOnlineResource(OnLineResource online)
online
- location external file defining this style, or null if not availablevoid accept(StyleVisitor visitor)
Expression getTransformation()
getTransformation
in interface FeatureTypeStyle
void setTransformation(Expression transformation)
boolean hasOption(String key)
Map<String,String> getOptions()
Client code looking for the existence of a single option should use hasOption(String)
Copyright © 1996–2019 Geotools. All rights reserved.