Package org.geotools.renderer.style

Class StyleAttributeExtractor

Object

DefaultFilterVisitor

FilterAttributeExtractor

StyleAttributeExtractor

All Implemented Interfaces:

ExpressionVisitor, FilterVisitor, StyleVisitor

Direct Known Subclasses:

StyleAttributeExtractorTruncated

public class StyleAttributeExtractor
extends FilterAttributeExtractor
implements StyleVisitor

A simple visitor whose purpose is to extract the set of attributes used by a Style, that is, those that the Style expects to find in order to work properly

Author:

Andrea Aime - OpenGeo

Field Summary

Fields inherited from class FilterAttributeExtractor

attributeNames, featureType, propertyNames, usingDynamicProperties, usingVolatileFunctions

Constructor Summary

Constructors

Constructor	Description
StyleAttributeExtractor()	Default constructor, creates an empty extractor that does not check against a feature type
StyleAttributeExtractor(SimpleFeatureType featureType)	Creates an extractor that leverages the provided feature type for more accurate property name extraction (e.g., it will return the property name of the default geometry if the "geometry" function is used

Method Summary

Modifier and Type	Method	Description
Set<PropertyName>	getAttributes()	Returns PropertyNames rather than strings (includes namespace info)
boolean	getDefaultGeometryUsed()	reads the read-only-property.
boolean	isSymbolizerGeometriesVisitEnabled()
void	setSymbolizerGeometriesVisitEnabled(boolean symbolizerGeometriesVisitEnabled)	Enables/disables visit of the symbolizer geometry property (on by default)
Object	visit(Function expression, Object data)
void	visit(AnchorPoint ap)	Called when accept is called on an anchor point
void	visit(ChannelSelection cs)	Called when accept is called on a raster ChannelSelection element
void	visit(ColorMap map)	Called when accept is called on a raster color map
void	visit(ColorMapEntry entry)	Called when accept is called on a raster color map entry
void	visit(ContrastEnhancement contrastEnhancement)	Called when accept is called on a raster ContrastEnhancement element
void	visit(Displacement dis)	Called when accept is called on a displacement
void	visit(ExternalGraphic exgr)	Called when accept is called on an external graphic
void	visit(FeatureTypeConstraint ftc)	Called when accept is called on a FeatureTypeConstraint.
void	visit(FeatureTypeStyle fts)	Called when accept is called on a fetauretypestyle
void	visit(Fill fill)	Called when accept is called on a fill
void	visit(Graphic gr)	Called when accept is called on a graphic
void	visit(Halo halo)	Called when accept is called on a halo
void	visit(ImageOutline outline)	Called when accept is called on a raster ImageOutline element
void	visit(LinePlacement lp)	Called when accept is called on a Line Placement
void	visit(LineSymbolizer line)	Called when accept is called on a linesymbolizer
void	visit(Mark mark)	Called when accept is called on a mark
void	visit(NamedLayer layer)	Called when accept is called on a NamedLayer.
void	visit(OverlapBehavior ob)	Called when accept is called on a raster OverlapBehaviorEnum element
void	visit(PointPlacement pp)	Called when accept is called on a Point Placement
void	visit(PointSymbolizer ps)	Called when accept is called on a pointsymbolizer
void	visit(PolygonSymbolizer poly)	Called when accept is called on a polygon symbolizer
void	visit(RasterSymbolizer rs)	Called when accept is called on a rastersymbolizer
void	visit(Rule rule)	Called when accept is called on a rule
void	visit(SelectedChannelType sct)	Called when accept is called on a raster SelectedChannelType element
void	visit(ShadedRelief sr)	Called when accept is called on a raster ShadedRelief element
void	visit(Stroke stroke)	Called when accept is called on a stroke
void	visit(Style style)	Called when accept is called on a Style.
void	visit(StyledLayerDescriptor sld)	Called when accept is called on a StyledLayerDescriptor.
void	visit(Symbolizer sym)	since it is impossible to create a Symbolizer this method should generate an exception or warning.
void	visit(TextSymbolizer text)	Called when accept is called on a textsymbolizer
void	visit(UserLayer layer)	Called when accept is called on a UserLayer.

Methods inherited from class FilterAttributeExtractor

clear, getAttributeNames, getAttributeNameSet, getPropertyNameSet, isConstantExpression, isUsingDynamincProperties, visit

Methods inherited from class DefaultFilterVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitNullFilter

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StyleAttributeExtractor

public StyleAttributeExtractor()

Default constructor, creates an empty extractor that does not check against a feature type

StyleAttributeExtractor

public StyleAttributeExtractor(SimpleFeatureType featureType)

Creates an extractor that leverages the provided feature type for more accurate property name extraction (e.g., it will return the property name of the default geometry if the "geometry" function is used

Method Details

getAttributes

public Set<PropertyName> getAttributes()

Returns PropertyNames rather than strings (includes namespace info)

Returns:

an array of the attribute found so far during the visit

isSymbolizerGeometriesVisitEnabled

public boolean isSymbolizerGeometriesVisitEnabled()

setSymbolizerGeometriesVisitEnabled

public void setSymbolizerGeometriesVisitEnabled(boolean symbolizerGeometriesVisitEnabled)

Enables/disables visit of the symbolizer geometry property (on by default)

getDefaultGeometryUsed

public boolean getDefaultGeometryUsed()

reads the read-only-property. See GEOS-469

Returns:

true if any of the symbolizers visted use the default geometry.

visit

public void visit(Style style)

Description copied from interface: StyleVisitor

Called when accept is called on a Style.

Specified by:

visit in interface StyleVisitor

Parameters:

style - The style to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Style)

visit

public void visit(Rule rule)

Description copied from interface: StyleVisitor

Called when accept is called on a rule

Specified by:

visit in interface StyleVisitor

Parameters:

rule - the rule to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Rule)

visit

public void visit(FeatureTypeStyle fts)

Description copied from interface: StyleVisitor

Called when accept is called on a fetauretypestyle

Specified by:

visit in interface StyleVisitor

Parameters:

fts - the feature type styler to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.FeatureTypeStyle)

visit

public void visit(Fill fill)

Description copied from interface: StyleVisitor

Called when accept is called on a fill

Specified by:

visit in interface StyleVisitor

Parameters:

fill - the fill to be visited

See Also:

• StyleVisitor.visit(org.geotools.api.style.Fill)

visit

public void visit(Stroke stroke)

Description copied from interface: StyleVisitor

Called when accept is called on a stroke

Specified by:

visit in interface StyleVisitor

Parameters:

stroke - the stroke to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Stroke)

visit

public void visit(Symbolizer sym)

Description copied from interface: StyleVisitor

since it is impossible to create a Symbolizer this method should generate an exception or warning.

Specified by:

visit in interface StyleVisitor

Parameters:

sym - the symbolizer to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Symbolizer)

visit

public void visit(RasterSymbolizer rs)

Description copied from interface: StyleVisitor

Called when accept is called on a rastersymbolizer

Specified by:

visit in interface StyleVisitor

Parameters:

rs - the raster symbolizer to visit

visit

public void visit(PointSymbolizer ps)

Description copied from interface: StyleVisitor

Called when accept is called on a pointsymbolizer

Specified by:

visit in interface StyleVisitor

Parameters:

ps - the point symbolizer to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.PointSymbolizer)

visit

public void visit(LineSymbolizer line)

Description copied from interface: StyleVisitor

Called when accept is called on a linesymbolizer

Specified by:

visit in interface StyleVisitor

Parameters:

line - the line symbolizer to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.LineSymbolizer)

visit

public void visit(PolygonSymbolizer poly)

Description copied from interface: StyleVisitor

Called when accept is called on a polygon symbolizer

Specified by:

visit in interface StyleVisitor

Parameters:

poly - the polygon symbolizer to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.PolygonSymbolizer)

visit

public void visit(TextSymbolizer text)

Description copied from interface: StyleVisitor

Called when accept is called on a textsymbolizer

Specified by:

visit in interface StyleVisitor

Parameters:

text - the text symbolizer to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.TextSymbolizer)

visit

public void visit(Graphic gr)

Description copied from interface: StyleVisitor

Called when accept is called on a graphic

Specified by:

visit in interface StyleVisitor

Parameters:

gr - the graphic to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Graphic)

visit

public void visit(Mark mark)

Description copied from interface: StyleVisitor

Called when accept is called on a mark

Specified by:

visit in interface StyleVisitor

Parameters:

mark - the mark to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Mark)

visit

public void visit(ExternalGraphic exgr)

Description copied from interface: StyleVisitor

Called when accept is called on an external graphic

Specified by:

visit in interface StyleVisitor

Parameters:

exgr - the external graphic to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.ExternalGraphic)

visit

public void visit(PointPlacement pp)

Description copied from interface: StyleVisitor

Called when accept is called on a Point Placement

Specified by:

visit in interface StyleVisitor

Parameters:

pp - the point placement to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.PointPlacement)

visit

public void visit(AnchorPoint ap)

Description copied from interface: StyleVisitor

Called when accept is called on an anchor point

Specified by:

visit in interface StyleVisitor

Parameters:

ap - the anchor point to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.AnchorPoint)

visit

public void visit(Displacement dis)

Description copied from interface: StyleVisitor

Called when accept is called on a displacement

Specified by:

visit in interface StyleVisitor

Parameters:

dis - the displacement to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Displacement)

visit

public void visit(LinePlacement lp)

Description copied from interface: StyleVisitor

Called when accept is called on a Line Placement

Specified by:

visit in interface StyleVisitor

Parameters:

lp - the line placement to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.LinePlacement)

visit

public void visit(Halo halo)

Description copied from interface: StyleVisitor

Called when accept is called on a halo

Specified by:

visit in interface StyleVisitor

Parameters:

halo - the halo to visit

See Also:

• StyleVisitor.visit(org.geotools.api.style.Halo)

visit

public void visit(StyledLayerDescriptor sld)

Description copied from interface: StyleVisitor

Called when accept is called on a StyledLayerDescriptor.

Specified by:

visit in interface StyleVisitor

Parameters:

sld - The StyledLayerDescriptor to visit

visit

public void visit(NamedLayer layer)

Description copied from interface: StyleVisitor

Called when accept is called on a NamedLayer.

Specified by:

visit in interface StyleVisitor

Parameters:

layer - The NamedLayer to visit

visit

public void visit(UserLayer layer)

Description copied from interface: StyleVisitor

Called when accept is called on a UserLayer.

Specified by:

visit in interface StyleVisitor

Parameters:

layer - The UserLayer to visit

visit

public void visit(FeatureTypeConstraint ftc)

Description copied from interface: StyleVisitor

Called when accept is called on a FeatureTypeConstraint.

Specified by:

visit in interface StyleVisitor

Parameters:

ftc - The FeatureTypeConstraint to visit

visit

public void visit(ColorMap map)

Description copied from interface: StyleVisitor

Called when accept is called on a raster color map

Specified by:

visit in interface StyleVisitor

Parameters:

map - the color map to visit

visit

public void visit(ColorMapEntry entry)

Description copied from interface: StyleVisitor

Called when accept is called on a raster color map entry

Specified by:

visit in interface StyleVisitor

Parameters:

entry - the color map to visit

visit

public void visit(ContrastEnhancement contrastEnhancement)

Description copied from interface: StyleVisitor

Called when accept is called on a raster ContrastEnhancement element

Specified by:

visit in interface StyleVisitor

Parameters:

contrastEnhancement - the ContrastEnhancement to visit.

visit

public void visit(ImageOutline outline)

Description copied from interface: StyleVisitor

Called when accept is called on a raster ImageOutline element

Specified by:

visit in interface StyleVisitor

Parameters:

outline - the ImageOutline to visit.

visit

public void visit(ChannelSelection cs)

Description copied from interface: StyleVisitor

Called when accept is called on a raster ChannelSelection element

Specified by:

visit in interface StyleVisitor

Parameters:

cs - the ChannelSelection to visit.

visit

public void visit(OverlapBehavior ob)

Description copied from interface: StyleVisitor

Called when accept is called on a raster OverlapBehaviorEnum element

Specified by:

visit in interface StyleVisitor

Parameters:

ob - the OverlapBehaviorEnum to visit.

visit

public void visit(SelectedChannelType sct)

Description copied from interface: StyleVisitor

Called when accept is called on a raster SelectedChannelType element

Specified by:

visit in interface StyleVisitor

Parameters:

sct - the SelectedChannelType to visit.

visit

public void visit(ShadedRelief sr)

Description copied from interface: StyleVisitor

Called when accept is called on a raster ShadedRelief element

Specified by:

visit in interface StyleVisitor

Parameters:

sr - the ShadedRelief to visit.

visit

public Object visit(Function expression,
 Object data)

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class FilterAttributeExtractor