Class TLcdSLDRule
- All Implemented Interfaces:
ILcdDataObject
,ILcdCloneable
,ILcdDeepCloneable
,Cloneable
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionEmpty constructor.TLcdSLDRule
(TLcdDataType aDataType) Empty constructor.TLcdSLDRule
(String aName, TLcdSLDDescription aDescription, TLcdSLDGraphic aLegendGraphic, TLcdOGCFilter aOGCFilter, boolean aHasElseFilter, double aMinScaleDenominator, double aMaxScaleDenominator, ALcdSLDSymbolizer[] aSymbolizers) Constructor for given parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSymbolizer
(ALcdSLDSymbolizer aSymbolizer) Adds a symbolizer.Returns the value of the property that maps to theDescription
element.Returns the value of the property that maps to theLegendGraphic
element.double
Returns the value of the property that maps to theMaxScaleDenominator
element.double
Returns the value of the property that maps to theMinScaleDenominator
element.getName()
Returns the value of the property that maps to theName
element.Returns the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule.Returns the value of the property that maps to theSymbolizer
element.getSymbolizer
(int aIndex) Gets the symbolizer at a given position.int
Gets the symbolizers count.void
insertSymbolizerAt
(ALcdSLDSymbolizer aSymbolizer, int aIndex) Inserts a symbolizer in the list of symbolizers at the given index.boolean
Returns whether this rule should act as an else filter.static TLcdSLDRule.Builder
<TLcdSLDRule> Creates a new builder with the default values.void
removeSymbolizer
(ALcdSLDSymbolizer aSymbolizer) Removes a symbolizer.void
setDescription
(TLcdSLDDescription aValue) Sets the value of the property that maps to theDescription
element.void
setElseFilter
(boolean aHasElseFilter) Sets whether this rule has an else filter.void
setLegendGraphic
(TLcdSLDGraphic aValue) Sets the value of the property that maps to theLegendGraphic
element.void
setMaxScaleDenominator
(double aValue) Sets the value of the property that maps to theMaxScaleDenominator
element.void
setMinScaleDenominator
(double aValue) Sets the value of the property that maps to theMinScaleDenominator
element.void
Sets the value of the property that maps to theName
element.void
setOGCFilter
(TLcdOGCFilter aOGCFilter) Sets the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule.
-
Constructor Details
-
TLcdSLDRule
public TLcdSLDRule()Empty constructor.- See Also:
-
TLcdSLDRule
public TLcdSLDRule(String aName, TLcdSLDDescription aDescription, TLcdSLDGraphic aLegendGraphic, TLcdOGCFilter aOGCFilter, boolean aHasElseFilter, double aMinScaleDenominator, double aMaxScaleDenominator, ALcdSLDSymbolizer[] aSymbolizers) Constructor for given parameters.- Parameters:
aName
- the given rule name.aDescription
- the given rule description.aLegendGraphic
- the given graphic for the legend.aOGCFilter
- the given OGC filter.aHasElseFilter
- the flag indicating an else filter. If true, the given OGC filter should then be null.aMinScaleDenominator
- the given min scale denominator.aMaxScaleDenominator
- the given max scale denominator.aSymbolizers
- the given symbolizers that will be applied for this rule.- See Also:
-
TLcdSLDRule
Empty constructor.
-
-
Method Details
-
setOGCFilter
Sets the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule. If the filter passed is not null, hasElseFilter will be set to false.- See Also:
-
getOGCFilter
Returns the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule. The filter can be null.- Returns:
- the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule.
-
setElseFilter
public void setElseFilter(boolean aHasElseFilter) Sets whether this rule has an else filter. If set to true the OGCFilter will be nulled.- See Also:
-
isElseFilter
public boolean isElseFilter()Returns whether this rule should act as an else filter. -
getSymbolizerCount
public int getSymbolizerCount()Gets the symbolizers count.- Returns:
- the symbolizers count.
-
getSymbolizer
Gets the symbolizer at a given position.- Parameters:
aIndex
- the index of the given position.- Returns:
- the symbolizer at a given position.
-
addSymbolizer
Adds a symbolizer.- Parameters:
aSymbolizer
- the given symbolizer to be added.
-
removeSymbolizer
Removes a symbolizer.- Parameters:
aSymbolizer
- the given symbolizer to be removed.
-
insertSymbolizerAt
Inserts a symbolizer in the list of symbolizers at the given index. All symbolizers which had an index higher than or equal to the index passed will be moved back one position.- Parameters:
aSymbolizer
- the symbolizer to insert.aIndex
- the index at which to enter the symbolizer. The index should be less than or equal to the value returned bygetSymbolizerCount()
.
-
newBuilder
Creates a new builder with the default values.- Returns:
- the new builder.
- Since:
- 2012.1
-
getName
Returns the value of the property that maps to theName
element.- Returns:
- the value of the
NAME_PROPERTY
property.
-
setName
Sets the value of the property that maps to theName
element.- Parameters:
aValue
- the value to set for theNAME_PROPERTY
property.
-
getDescription
Returns the value of the property that maps to theDescription
element.A "Description" gives human-readable descriptive information for the object it is included within.
- Returns:
- the value of the
DESCRIPTION_PROPERTY
property.
-
setDescription
Sets the value of the property that maps to theDescription
element.A "Description" gives human-readable descriptive information for the object it is included within.
- Parameters:
aValue
- the value to set for theDESCRIPTION_PROPERTY
property.
-
getLegendGraphic
Returns the value of the property that maps to theLegendGraphic
element.A small pictorial representation of this rule.
- Returns:
- the value of the
LEGEND_GRAPHIC_PROPERTY
property.
-
setLegendGraphic
Sets the value of the property that maps to theLegendGraphic
element.A small pictorial representation of this rule.
- Parameters:
aValue
- the value to set for theLEGEND_GRAPHIC_PROPERTY
property.
-
getMinScaleDenominator
public double getMinScaleDenominator()Returns the value of the property that maps to theMinScaleDenominator
element.The denominator for the maximum scale at which the rule should be applied. A min scale denominator of 10000 indicates that this rule should be applied for every scale for which the denominator is greater than 10000, i.e. for every scale smaller than 1:10000. This is an optional property. If it is not specified, this value defaults to `0.0`.
- Returns:
- the value of the
MIN_SCALE_DENOMINATOR_PROPERTY
property.
-
setMinScaleDenominator
public void setMinScaleDenominator(double aValue) Sets the value of the property that maps to theMinScaleDenominator
element.The denominator for the maximum scale at which the rule should be applied. A min scale denominator of 10000 indicates that this rule should be applied for every scale for which the denominator is greater than 10000, i.e. for every scale smaller than 1:10000. This is an optional property. If it is not specified, this value defaults to `0.0`.
- Parameters:
aValue
- the value to set for theMIN_SCALE_DENOMINATOR_PROPERTY
property.
-
getMaxScaleDenominator
public double getMaxScaleDenominator()Returns the value of the property that maps to theMaxScaleDenominator
element.The denominator for the minimum scale at which the rule should be applied. A max scale denominator of 1E6 indicates that this rule should be applied for every scale for which the denominator is less than 1E6, i.e. for every scale greater than 1:1E6. This is an optional property. If it is not specified, this value defaults to `Infinity`.
- Returns:
- the value of the
MAX_SCALE_DENOMINATOR_PROPERTY
property.
-
setMaxScaleDenominator
public void setMaxScaleDenominator(double aValue) Sets the value of the property that maps to theMaxScaleDenominator
element.The denominator for the minimum scale at which the rule should be applied. A max scale denominator of 1E6 indicates that this rule should be applied for every scale for which the denominator is less than 1E6, i.e. for every scale greater than 1:1E6. This is an optional property. If it is not specified, this value defaults to `Infinity`.
- Parameters:
aValue
- the value to set for theMAX_SCALE_DENOMINATOR_PROPERTY
property.
-
getSymbolizer
Returns the value of the property that maps to theSymbolizer
element.- Returns:
- the value of the
SYMBOLIZER_PROPERTY
property.
-