com.luciad.ogc.sld.model

LuciadLightspeedClass TLcdSLDRule

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.sld.model.TLcdSLDRule

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdSLDRule
extends TLcdDataObject

A rule is used to attach property/scale conditions to and group the individual symbolizers used for rendering.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdSLDRule.Builder<T> A builder for SLD rules.

Constructor Summary

Constructors

Constructor and Description
TLcdSLDRule() Empty constructor.
TLcdSLDRule(String aName, TLcdSLDDescription aDescription, TLcdSLDGraphic aLegendGraphic, TLcdOGCFilter aOGCFilter, boolean aHasElseFilter, double aMinScaleDenominator, double aMaxScaleDenominator, ALcdSLDSymbolizer[] aSymbolizers) Constructor for given parameters.
TLcdSLDRule(TLcdDataType aDataType) Empty constructor.

Method Summary

Modifier and Type	Method and Description
void	addSymbolizer(ALcdSLDSymbolizer aSymbolizer) Adds a symbolizer.
TLcdSLDDescription	getDescription() Returns the value of the property that maps to the Description element.
TLcdSLDGraphic	getLegendGraphic() Returns the value of the property that maps to the LegendGraphic element.
double	getMaxScaleDenominator() Returns the value of the property that maps to the MaxScaleDenominator element.
double	getMinScaleDenominator() Returns the value of the property that maps to the MinScaleDenominator element.
String	getName() Returns the value of the property that maps to the Name element.
TLcdOGCFilter	getOGCFilter() Returns the filter that will be applied to select instances of the feature type to be rendered by the symbolizers in this rule.
List<ALcdSLDSymbolizer>	getSymbolizer() Returns the value of the property that maps to the Symbolizer element.
ALcdSLDSymbolizer	getSymbolizer(int aIndex) Gets the symbolizer at a given position.
int	getSymbolizerCount() Gets the symbolizers count.
void	insertSymbolizerAt(ALcdSLDSymbolizer aSymbolizer, int aIndex) Inserts a symbolizer in the list of symbolizers at the given index.
boolean	isElseFilter() Returns whether this rule should act as an else filter.
static TLcdSLDRule.Builder<TLcdSLDRule>	newBuilder() 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 the Description 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 the LegendGraphic element.
void	setMaxScaleDenominator(double aValue) Sets the value of the property that maps to the MaxScaleDenominator element.
void	setMinScaleDenominator(double aValue) Sets the value of the property that maps to the MinScaleDenominator element.
void	setName(String aValue) Sets the value of the property that maps to the Name 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.

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdSLDRule

public TLcdSLDRule()

Empty constructor.

See Also:

newBuilder()

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:

newBuilder()

TLcdSLDRule

public TLcdSLDRule(TLcdDataType aDataType)

Empty constructor.

Method Detail

setOGCFilter

public 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. If the filter passed is not null, hasElseFilter will be set to false.

See Also:

setElseFilter(boolean)

getOGCFilter

public TLcdOGCFilter 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:

setOGCFilter(com.luciad.ogc.filter.model.TLcdOGCFilter)

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

public ALcdSLDSymbolizer getSymbolizer(int aIndex)

Gets the symbolizer at a given position.

Parameters:

aIndex - the index of the given position.

Returns:

the symbolizer at a given position.

addSymbolizer

public void addSymbolizer(ALcdSLDSymbolizer aSymbolizer)

Adds a symbolizer.

Parameters:

aSymbolizer - the given symbolizer to be added.

removeSymbolizer

public void removeSymbolizer(ALcdSLDSymbolizer aSymbolizer)

Removes a symbolizer.

Parameters:

aSymbolizer - the given symbolizer to be removed.

insertSymbolizerAt

public void insertSymbolizerAt(ALcdSLDSymbolizer aSymbolizer,
                               int aIndex)

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 by getSymbolizerCount().

newBuilder

public static TLcdSLDRule.Builder<TLcdSLDRule> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

Since:

2012.1

getName

public String getName()

Returns the value of the property that maps to the Name element.

Returns:

the value of the NAME_PROPERTY property.

setName

public void setName(String aValue)

Sets the value of the property that maps to the Name element.

Parameters:

aValue - the value to set for the NAME_PROPERTY property.

getDescription

public TLcdSLDDescription getDescription()

Returns the value of the property that maps to the Description element.

A "Description" gives human-readable descriptive information for the object it is included within.

Returns:

the value of the DESCRIPTION_PROPERTY property.

setDescription

public void setDescription(TLcdSLDDescription aValue)

Sets the value of the property that maps to the Description element.

A "Description" gives human-readable descriptive information for the object it is included within.

Parameters:

aValue - the value to set for the DESCRIPTION_PROPERTY property.

getLegendGraphic

public TLcdSLDGraphic getLegendGraphic()

Returns the value of the property that maps to the LegendGraphic element.

A small pictorial representation of this rule.

Returns:

the value of the LEGEND_GRAPHIC_PROPERTY property.

setLegendGraphic

public void setLegendGraphic(TLcdSLDGraphic aValue)

Sets the value of the property that maps to the LegendGraphic element.

A small pictorial representation of this rule.

Parameters:

aValue - the value to set for the LEGEND_GRAPHIC_PROPERTY property.

getMinScaleDenominator

public double getMinScaleDenominator()

Returns the value of the property that maps to the MinScaleDenominator 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 the MinScaleDenominator 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 the MIN_SCALE_DENOMINATOR_PROPERTY property.

getMaxScaleDenominator

public double getMaxScaleDenominator()

Returns the value of the property that maps to the MaxScaleDenominator 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 the MaxScaleDenominator 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 the MAX_SCALE_DENOMINATOR_PROPERTY property.

getSymbolizer

public List<ALcdSLDSymbolizer> getSymbolizer()

Returns the value of the property that maps to the Symbolizer element.

Returns:

the value of the SYMBOLIZER_PROPERTY property.