Package org.geotools.api.style
Interface StyleFactory
-
- All Known Implementing Classes:
AbstractStyleFactory
,StyleFactoryImpl
public interface StyleFactory
Factory used in the production of style objects.This factory is responsible for the production of style objects; where noted these create methods are in agreement with the Symbology Encoding 1.1 specification.
- Since:
- GeoAPI 2.2
- Author:
- Open Geospatial Consortium, Johann Sorel (Geomatys)
-
-
Method Summary
-
-
-
Method Detail
-
createTextSymbolizer
TextSymbolizer createTextSymbolizer(Fill fill, Font[] fonts, Halo halo, Expression label, LabelPlacement labelPlacement, String geometryPropertyName)
-
createExternalGraphic
ExternalGraphic createExternalGraphic(URL url, String format)
-
createExternalGraphic
ExternalGraphic createExternalGraphic(String uri, String format)
-
createExternalGraphic
ExternalGraphic createExternalGraphic(Icon inlineContent, String format)
-
createAnchorPoint
AnchorPoint createAnchorPoint(Expression x, Expression y)
-
createDisplacement
Displacement createDisplacement(Expression x, Expression y)
-
createPointSymbolizer
PointSymbolizer createPointSymbolizer()
-
createMark
Mark createMark(Expression wellKnownName, Stroke stroke, Fill fill, Expression size, Expression rotation)
-
getCircleMark
Mark getCircleMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
getXMark
Mark getXMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
getStarMark
Mark getStarMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
getSquareMark
Mark getSquareMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
getCrossMark
Mark getCrossMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
getTriangleMark
Mark getTriangleMark()
Convinence method for obtaining a mark of a fixed shape- Returns:
- a Mark that matches the name in this method.
-
createExtent
Extent createExtent(String name, String value)
Creates a new extent.- Parameters:
name
- The name of the extent.value
- The value of the extent.- Returns:
- The new extent.
-
createFeatureTypeConstraint
FeatureTypeConstraint createFeatureTypeConstraint(String featureTypeName, Filter filter, Extent... extents)
Creates a new feature type constraint.- Parameters:
featureTypeName
- The feature type name.filter
- The filter.extents
- The extents.- Returns:
- The new feature type constaint.
-
createLayerFeatureConstraints
LayerFeatureConstraints createLayerFeatureConstraints(FeatureTypeConstraint... featureTypeConstraints)
-
createFeatureTypeStyle
FeatureTypeStyle createFeatureTypeStyle(Rule... rules)
-
createImageOutline
ImageOutline createImageOutline(Symbolizer symbolizer)
Creates a new ImageOutline.- Parameters:
symbolizer
- A line or polygon symbolizer.- Returns:
- The new image outline.
-
createLinePlacement
LinePlacement createLinePlacement(Expression offset)
-
createPolygonSymbolizer
PolygonSymbolizer createPolygonSymbolizer()
-
createHalo
Halo createHalo(Fill fill, Expression radius)
-
createFill
Fill createFill(Expression color, Expression backgroundColor, Expression opacity, Graphic graphicFill)
-
createLineSymbolizer
LineSymbolizer createLineSymbolizer()
Create default line symbolizer
-
createPointSymbolizer
PointSymbolizer createPointSymbolizer(Graphic graphic, String geometryPropertyName)
-
createStyle
Style createStyle()
-
createNamedStyle
NamedStyle createNamedStyle()
-
createFill
Fill createFill(Expression color, Expression opacity)
-
createFill
Fill createFill(Expression color)
-
createTextSymbolizer
TextSymbolizer createTextSymbolizer()
-
createPointPlacement
PointPlacement createPointPlacement(AnchorPoint anchorPoint, Displacement displacement, Expression rotation)
-
createStroke
Stroke createStroke(Expression color, Expression width)
A convienice method to make a simple stroke- Parameters:
color
- the color of the linewidth
- the width of the line- Returns:
- the stroke object
-
createStroke
Stroke createStroke(Expression color, Expression width, Expression opacity)
A convienice method to make a simple stroke- Parameters:
color
- the color of the linewidth
- The width of the lineopacity
- The opacity of the line- Returns:
- The stroke
-
createStroke
Stroke createStroke(Expression color, Expression width, Expression opacity, Expression lineJoin, Expression lineCap, float[] dashArray, Expression dashOffset, Graphic graphicFill, Graphic graphicStroke)
creates a stroke- Parameters:
color
- The color of the linewidth
- The width of the lineopacity
- The opacity of the linelineJoin
- - the type of Line jointlineCap
- - the type of line capdashArray
- - an array of floats describing the dashes in the linedashOffset
- - where in the dash array to start drawing fromgraphicFill
- - a graphic object to fill the line withgraphicStroke
- - a graphic object to draw the line with- Returns:
- The completed stroke.
-
createRule
Rule createRule()
-
createLineSymbolizer
LineSymbolizer createLineSymbolizer(Stroke stroke, String geometryPropertyName)
-
createFeatureTypeStyle
FeatureTypeStyle createFeatureTypeStyle()
-
createGraphic
Graphic createGraphic(ExternalGraphic[] externalGraphics, Mark[] marks, Symbol[] symbols, Expression opacity, Expression size, Expression rotation)
-
createFont
Font createFont(Expression fontFamily, Expression fontStyle, Expression fontWeight, Expression fontSize)
-
createMark
Mark createMark()
-
createPolygonSymbolizer
PolygonSymbolizer createPolygonSymbolizer(Stroke stroke, Fill fill, String geometryPropertyName)
-
createRasterSymbolizer
RasterSymbolizer createRasterSymbolizer()
-
createRasterSymbolizer
RasterSymbolizer createRasterSymbolizer(String geometryPropertyName, Expression opacity, ChannelSelection channel, Expression overlap, ColorMap colorMap, ContrastEnhancement ce, ShadedRelief relief, Symbolizer outline)
-
getDefaultRasterSymbolizer
RasterSymbolizer getDefaultRasterSymbolizer()
-
createChannelSelection
ChannelSelection createChannelSelection(SelectedChannelType... channels)
-
createContrastEnhancement
ContrastEnhancement createContrastEnhancement()
-
createContrastEnhancement
ContrastEnhancement createContrastEnhancement(Expression gammaValue)
-
createSelectedChannelType
SelectedChannelType createSelectedChannelType(Expression name, ContrastEnhancement enhancement)
-
createSelectedChannelType
SelectedChannelType createSelectedChannelType(String name, ContrastEnhancement enhancement)
-
createSelectedChannelType
SelectedChannelType createSelectedChannelType(Expression name, Expression gammaValue)
-
createColorMap
ColorMap createColorMap()
-
createColorMapEntry
ColorMapEntry createColorMapEntry()
-
getDefaultStyle
Style getDefaultStyle()
-
getDefaultStroke
Stroke getDefaultStroke()
-
getDefaultFill
Fill getDefaultFill()
-
getDefaultMark
Mark getDefaultMark()
-
getDefaultPointSymbolizer
PointSymbolizer getDefaultPointSymbolizer()
-
getDefaultPolygonSymbolizer
PolygonSymbolizer getDefaultPolygonSymbolizer()
-
getDefaultLineSymbolizer
LineSymbolizer getDefaultLineSymbolizer()
-
getDefaultTextSymbolizer
TextSymbolizer getDefaultTextSymbolizer()
Creates a default Text Symbolizer, using the defaultFill, defaultFont and defaultPointPlacement, Sets the geometry attribute name to be geometry:text. No Halo is set. The label is not set- Returns:
- A default TextSymbolizer
-
createDefaultGraphic
Graphic createDefaultGraphic()
-
getDefaultGraphic
Graphic getDefaultGraphic()
-
getDefaultFont
Font getDefaultFont()
-
getDefaultPointPlacement
PointPlacement getDefaultPointPlacement()
-
createStyledLayerDescriptor
StyledLayerDescriptor createStyledLayerDescriptor()
-
createUserLayer
UserLayer createUserLayer()
-
createNamedLayer
NamedLayer createNamedLayer()
-
createShadedRelief
ShadedRelief createShadedRelief(Expression reliefFactor)
-
anchorPoint
AnchorPoint anchorPoint(Expression x, Expression y)
-
channelSelection
ChannelSelection channelSelection(SelectedChannelType gray)
-
channelSelection
ChannelSelection channelSelection(SelectedChannelType red, SelectedChannelType green, SelectedChannelType blue)
-
colorMap
ColorMap colorMap(Expression propertyName, Expression... mapping)
Wrap up a "Categorize" function using the provided expressions.The function will be created based on:
- PropertyName; use "Rasterdata" to indicate this is a color map
- Literal: lookup value
- Literal: threshold 1
- Literal: value 1
- Literal: threshold 2
- Literal: value 2
- Literal: (Optional) succeeding or preceding
- Parameters:
propertyName
- Property name to categorize, or use "Raster"mapping
- Defined as a series of Expressions- Returns:
- ColorMap wrapped around the "Cateogize" function
-
colorReplacement
ColorReplacement colorReplacement(Expression propertyName, Expression... mapping)
Wrap up a replacement function using the provided expressions.- Parameters:
propertyName
- Property name to categorize, or use "Raster"mapping
- Defined as a series of Expressions- Returns:
- ColorReplacement wrapped around a Function
-
contrastEnhancement
ContrastEnhancement contrastEnhancement(Expression gamma, ContrastMethod method)
-
contrastEnhancement
ContrastEnhancement contrastEnhancement(Expression gamma, String method)
-
description
Description description(InternationalString title, InternationalString description)
-
displacement
Displacement displacement(Expression dx, Expression dy)
Create Displacement
-
externalGraphic
ExternalGraphic externalGraphic(OnLineResource resource, String format, Collection<ColorReplacement> replacements)
Create externalGraphic
-
externalGraphic
ExternalGraphic externalGraphic(Icon inline, Collection<ColorReplacement> replacements)
Create ExternalGraphic using a Java Icon.This is used to produce high quality output by allowing you to directly draw each symbol by supplying your own Icon implementation.
-
externalMark
ExternalMark externalMark(OnLineResource resource, String format, int markIndex)
-
externalMark
ExternalMark externalMark(Icon inline)
-
featureTypeStyle
FeatureTypeStyle featureTypeStyle(String name, Description description, Id definedFor, Set<Name> featureTypeNames, Set<SemanticType> types, List<Rule> rules)
- Parameters:
rules
- May not be null or empty
-
fill
Fill fill(GraphicFill fill, Expression color, Expression opacity)
Create fill.
-
font
Font font(List<Expression> family, Expression style, Expression weight, Expression size)
Create font entry; note this captures a list of font families in the preferred order, with the rendering engine choosing the first entry in the list available to the runtime environment.If fonts are not showing up as you expect please review the list of fonts installed into your JRE.
- Returns:
- Font
-
graphic
Graphic graphic(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchor, Displacement disp)
Create a graphic.
-
graphicFill
GraphicFill graphicFill(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement)
-
graphicLegend
GraphicLegend graphicLegend(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement)
-
graphicStroke
GraphicStroke graphicStroke(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement, Expression initialGap, Expression gap)
-
halo
Halo halo(Fill fill, Expression radius)
-
linePlacement
LinePlacement linePlacement(Expression offset, Expression initialGap, Expression gap, boolean repeated, boolean aligned, boolean generalizedLine)
-
lineSymbolizer
LineSymbolizer lineSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Stroke stroke, Expression offset)
- Parameters:
name
- handle used to refer to this symbolizer (machine readible)geometry
- Expression used to produce the Geometry to renderer; often a PropertyNameunit
- Unit of measure used to define this symbolizerstroke
- Definition of how to stroke lineworkoffset
- Offset used to position line relative to origional- Returns:
- Newly created Line Symbolizer
-
mark
Mark mark(Expression wellKnownName, Fill fill, Stroke stroke)
-
mark
Mark mark(ExternalMark externalMark, Fill fill, Stroke stroke)
-
pointPlacement
PointPlacement pointPlacement(AnchorPoint anchor, Displacement displacement, Expression rotation)
-
pointSymbolizer
PointSymbolizer pointSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Graphic graphic)
Creation of a PointSymbolizer to describe how geometry can be rendered as a point.- Parameters:
name
- handle used to refer to this symbolizer (machine readable)geometry
- Expression used to extract the Geometry rendered; usually a PropertyNamedescription
- Human readable description of symboizerunit
- Unit of Measure used to interpret symbolizer distancesgraphic
- Graphic used to represent the geometry when rendering- Returns:
- Newly created PointSymbolizer
-
polygonSymbolizer
PolygonSymbolizer polygonSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Stroke stroke, Fill fill, Displacement displacement, Expression offset)
- Parameters:
name
- handle used to refer to this symbolizer (machine readable)geometry
- Expression used to extract the Geometry rendered; usually a PropertyNamedescription
- Human readable description of symboizerunit
- Unit of Measure used to interpret symbolizer distances
-
rasterSymbolizer
RasterSymbolizer rasterSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Expression opacity, ChannelSelection channelSelection, OverlapBehaviorEnum overlapsBehaviour, ColorMap colorMap, ContrastEnhancement contrast, ShadedRelief shaded, Symbolizer outline)
- Parameters:
name
- handle used to refer to this symbolizer (machine readable)geometry
- Expression used to extract the Geometry rendered; usually a PropertyNamedescription
- Human readable description of symboizerunit
- Unit of Measure used to interpret symbolizer distances- Returns:
- RasterSymbolizer
-
extensionSymbolizer
ExtensionSymbolizer extensionSymbolizer(String name, String geometry, Description description, Unit<?> unit, String extensionName, Map<String,Expression> parameters)
Used to represent a symbolizer intended for a vendor specific rendering process. This facility should be used to control subject matter that is beyond the scope of the traditional symbology encoding data structure (subject matter like wind barbs or extra deegrees of freedom like temporal symbolizers are good examples of the use of this facility).- Parameters:
name
- handle used to refer to this symbolizer (machine readible)geometry
- Geometry expression to renderer; formally a PropertyNamedescription
- Description of this symbolizer; human readableunit
- Unit of measure to use when interpretting this symbolizerextensionName
- Extension name used to identify the vendor specific extension being controlledparameters
- Named expressions used to configure the vendor specific rendering process- Returns:
- newly created ExtensionSymbolizer
-
rule
Rule rule(String name, Description description, GraphicLegend legend, double min, double max, List<Symbolizer> symbolizers, Filter filter)
Create a rule from the provided definition.- Parameters:
name
- handle used to refer to this rule (machine readable)description
- Human readable description of this rulelegend
- Graphic used to indicate this rule in a legend or user interfacemin
- minimum scale denominator used to control when this rule is appliedmax
- maximum scale denominator used to control when this rule is applied- Returns:
- Newly created Rule
-
selectedChannelType
SelectedChannelType selectedChannelType(Expression channelName, ContrastEnhancement contrastEnhancement)
- Returns:
- SelectedChannelType
-
selectedChannelType
SelectedChannelType selectedChannelType(String channelName, ContrastEnhancement contrastEnhancement)
- Returns:
- SelectedChannelType
-
shadedRelief
ShadedRelief shadedRelief(Expression reliefFactor, boolean brightnessOnly)
- Returns:
- ShadedRelief
-
stroke
Stroke stroke(Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
-
stroke
Stroke stroke(GraphicFill fill, Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
-
stroke
Stroke stroke(GraphicStroke stroke, Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
-
style
Style style(String name, Description description, boolean isDefault, List<FeatureTypeStyle> featureTypeStyles, Symbolizer defaultSymbolizer)
-
textSymbolizer
TextSymbolizer textSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Expression label, Font font, LabelPlacement placement, Halo halo, Fill fill)
Creation of a TextSymbolizer defining how labels are portrayed.- Parameters:
name
- Handle used to refer to this symbolizer (machine readable)geometry
- Geometry to be rendereddescription
- Human readable descriptionunit
- Unit of measure used to interpret symbolizer sizeslabel
- Text displayed for this symbolizerfont
- Font selected to renderer this symbolizerplacement
- Placement information relative to orgiginal geometryhalo
- definition of a halo or outline surrounding the symbolizerfill
- definition of fill used- Returns:
- newly created TextSymbolizer
-
createContrastMethod
ContrastMethod createContrastMethod(ContrastMethod method)
- Returns:
- a deep copy of the method
-
createTextSymbolizer
TextSymbolizer createTextSymbolizer(Fill fill, Font[] fonts, Halo halo, Expression label, LabelPlacement labelPlacement, String geometryPropertyName, Graphic graphic)
Label Shield hack, non SLD 1.1- Parameters:
fill
- Fillfonts
- Font information (CSS)halo
- Describes Halolabel
- Expression for labellabelPlacement
- Captures label positiongeometryPropertyName
- With respect to this geometrygraphic
- Used to draw a backdrop behind label- Returns:
- TextSymbolizer2 allowing for a backdrop behind text label
-
getImplementationHints
Map<RenderingHints.Key,?> getImplementationHints()
-
-