Package org.opengis.style

Interface FeatureTypeStyle

All Known Subinterfaces:

FeatureTypeStyle

All Known Implementing Classes:

FeatureTypeStyleImpl

@XmlElement("FeatureTypeStyle")
@UML(identifier="PF_FeaturePortrayal",
     specification=ISO_19117)
public interface FeatureTypeStyle

Represents a style that applies to features or coverage.

Since:

GeoAPI 2.2

Author:

Open Geospatial Consortium, Johann Sorel (Geomatys), Chris Dillard (SYS Technologies)

Method Summary

Modifier and Type	Method	Description
Object	accept(StyleVisitor visitor, Object extraData)	calls the visit method of a StyleVisitor
Set<Name>	featureTypeNames()	Returns the names of the feature type that this style is meant to act upon.
Description	getDescription()	Returns the description of this style.
Id	getFeatureInstanceIDs()	Returns a collection of Object identifying features object.
String	getName()	Returns a name for this style.
OnLineResource	getOnlineResource()	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.
Expression	getTransformation()	gets the transformation as expression
List<? extends Rule>	rules()	Returns the list of rules contained by this style.
Set<SemanticType>	semanticTypeIdentifiers()	Returns a collection that identifies the more general "type" of geometry that this style is meant to act upon.

Method Detail

getName

@XmlElement("Name")
String getName()

Returns a name for this style. This can be any string that uniquely identifies this style within a given canvas. It is not meant to be human-friendly. (The "title" property is meant to be human friendly.)

Returns:

a name for this style.

getDescription

@XmlElement("Description")
@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19117)
Description getDescription()

Returns the description of this style.

Returns:

Description with usual informations used for user interfaces.

getFeatureInstanceIDs

@UML(identifier="definedForInst",
     obligation=OPTIONAL,
     specification=ISO_19117)
Id getFeatureInstanceIDs()

Returns a collection of Object identifying features object.

ISO 19117 extends FeatureTypeStyle be providing this method. This method enable the possibility to use a feature type style on a given list of features only, which is not possible in OGC SE.

Returns:

Collection

featureTypeNames

@XmlElement("FeatureTypeName")
@UML(identifier="definedFor",
     obligation=OPTIONAL,
     specification=ISO_19117)
Set<Name> featureTypeNames()

Returns the names of the feature type that this style is meant to act upon.

In OGC Symbology Encoding define this method to return a single String, and ISO 19117 use a Collection of String. We've choosen ISO because it is more logic that a featureTypeStyle can be applied to multiple featuretypes and not limited to a single one.

Returns:

the name of the feature type that this style is meant to act upon.

semanticTypeIdentifiers

@XmlElement("SemanticTypeIdentifier")
Set<SemanticType> semanticTypeIdentifiers()

Returns a collection that identifies the more general "type" of geometry that this style is meant to act upon. In the current OGC SE specifications, this is an experimental element and can take only one of the following values:

• generic:point
• generic:line
• generic:polygon
• generic:text
• generic:raster
• generic:any

rules

@XmlElement("Rule")
@UML(identifier="portrayalRule",
     obligation=MANDATORY,
     specification=ISO_19117)
List<? extends Rule> rules()

Returns the list of rules contained by this style.

Returns:

the list of rules. can not be null but can be empty.

getOnlineResource

@XmlElement("OnlineResource")
OnLineResource getOnlineResource()

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. OGC SLD specification can use this method to know if a style must be written completely or if writing the online resource path is enough.

Returns:

OnlineResource or null

getTransformation

@XmlElement("Transformation")
Expression getTransformation()

gets the transformation as expression

Returns:

Transformation or null

accept

@Extension
Object accept(StyleVisitor visitor,
              Object extraData)

calls the visit method of a StyleVisitor

Parameters:

visitor - the style visitor