com.luciad.ogc.sld.model

LuciadFusionClass TLcdSLDFeatureTypeStyle

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.sld.model.TLcdSLDFeatureTypeStyle

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdSLDFeatureTypeStyle
extends TLcdDataObject

A FeatureTypeStyle contains styling information specific to one feature type. This is the SLD level that separates the 'layer' handling from the 'feature' handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdSLDFeatureTypeStyle.Builder<T> A builder for SLD Feature Type Styles.

Constructor Summary

Constructors

Constructor and Description
TLcdSLDFeatureTypeStyle() Empty constructor.
TLcdSLDFeatureTypeStyle(String aName, TLcdSLDDescription aDescription, String aFeatureTypeName, TLcdSLDRule[] aRules, String[] aSemanticTypeIdentifiers, String aVersion) Constructor for given parameters.
TLcdSLDFeatureTypeStyle(TLcdDataType aDataType) Empty constructor.

Method Summary

Modifier and Type	Method and Description
void	addRule(TLcdSLDRule aRule) Adds a rule.
void	addSemanticTypeIdentifier(String aSemanticTypeIdentifier) Adds a semantic type identifier.
TLcdSLDDescription	getDescription() Returns the value of the property that maps to the Description element.
String	getFeatureTypeName() Returns the feature type name.
String	getName() Returns the value of the property that maps to the Name element.
TLcdSLDRule	getRule(int aIndex) Gets the rule at a given position.
int	getRuleCount() Returns the number of rules.
List<String>	getSemanticTypeIdentifier() Returns the value of the property that maps to the SemanticTypeIdentifier element.
String	getSemanticTypeIdentifier(int aIndex) Gets the semantic type identifier at a given position.
int	getSemanticTypeIdentifierCount() Returns the semantic type identifier count.
String	getVersion() Returns the value of the property that maps to the version attribute.
void	insertRuleAt(TLcdSLDRule aRule, int aIndex) Inserts a rule in the list of rules at the given index.
boolean	isRuleInline(int aIndex) Returns whether the rule at the given index is given in line in the symbology encoding.
static TLcdSLDFeatureTypeStyle.Builder<TLcdSLDFeatureTypeStyle>	newBuilder() Creates a new builder with the default values.
static TLcdSLDFeatureTypeStyle.Builder<TLcdSLDFeatureTypeStyle>	newBuilder(TLcdDataType aDataType) Creates a new builder for the given data type with the default values.
void	removeRule(TLcdSLDRule aRule) Removes a rule.
void	removeSemanticTypeIdentifier(String aSemanticTypeIdentifier) Removes a given semantic type identifier.
void	setDescription(TLcdSLDDescription aValue) Sets the value of the property that maps to the Description element.
void	setFeatureTypeName(String aFeatureTypeName) Sets the feature type name.
void	setName(String aValue) Sets the value of the property that maps to the Name element.
void	setVersion(String aValue) Sets the value of the property that maps to the version attribute.
String	toString() Returns the description title if it exists.

Methods inherited from class com.luciad.datamodel.TLcdDataObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdSLDFeatureTypeStyle

public TLcdSLDFeatureTypeStyle()

Empty constructor. The version will be set to the default version used by LuciadLightspeed which is currently 1.1.0. If a specific, fixed version is needed, it should be set explicitly.

TLcdSLDFeatureTypeStyle

public TLcdSLDFeatureTypeStyle(String aName,
                               TLcdSLDDescription aDescription,
                               String aFeatureTypeName,
                               TLcdSLDRule[] aRules,
                               String[] aSemanticTypeIdentifiers,
                               String aVersion)

Constructor for given parameters.

Parameters:

aName - the given name of the style.

aDescription - the given description of the style.

aFeatureTypeName - the given feature type to which the style applies.

aRules - the given rules to be applied.

aSemanticTypeIdentifiers - the given semantic identifiers.

aVersion - the given version of the style.

TLcdSLDFeatureTypeStyle

public TLcdSLDFeatureTypeStyle(TLcdDataType aDataType)

Empty constructor.

Method Detail

setFeatureTypeName

public void setFeatureTypeName(String aFeatureTypeName)

Sets the feature type name.

Parameters:

aFeatureTypeName - the feature type name.

See Also:

getFeatureTypeName

getFeatureTypeName

public String getFeatureTypeName()

Returns the feature type name. The FeatureTypeName identifies the specific feature type that the feature-type style is for. It is allowed to be optional.

Returns:

the feature type name.

getRuleCount

public int getRuleCount()

Returns the number of rules.

Returns:

the number of rules.

getRule

public TLcdSLDRule getRule(int aIndex)

Gets the rule at a given position.

Parameters:

aIndex - the index of the given position.

Returns:

the rule at a given position.

addRule

public void addRule(TLcdSLDRule aRule)

Adds a rule.

Parameters:

aRule - the given rule.

insertRuleAt

public void insertRuleAt(TLcdSLDRule aRule,
                         int aIndex)

Inserts a rule in the list of rules at the given index. All rules which had an index higher than or equal to the index passed will be moved back one position.

Parameters:

aRule - the rule to insert.

aIndex - the index at which to enter the rule. The index should be less than or equal to the value returned by getRuleCount().

isRuleInline

public boolean isRuleInline(int aIndex)

Returns whether the rule at the given index is given in line in the symbology encoding. If it is in line, the rule at that position will be a TLcdSLDRule. This is always the case for SLD 1.0.0.

Parameters:

aIndex - the index of the rule to check.

Returns:

whether the rule at the given index is given in line in the symbology encoding.

removeRule

public void removeRule(TLcdSLDRule aRule)

Removes a rule.

Parameters:

aRule - the rule to be removed.

addSemanticTypeIdentifier

public void addSemanticTypeIdentifier(String aSemanticTypeIdentifier)

Adds a semantic type identifier.

Parameters:

aSemanticTypeIdentifier - the given semantic type identifier.

removeSemanticTypeIdentifier

public void removeSemanticTypeIdentifier(String aSemanticTypeIdentifier)

Removes a given semantic type identifier.

Parameters:

aSemanticTypeIdentifier - the semantic type identifier to be removed.

getSemanticTypeIdentifierCount

public int getSemanticTypeIdentifierCount()

Returns the semantic type identifier count.

Returns:

the semantic type identifier count.

getSemanticTypeIdentifier

public String getSemanticTypeIdentifier(int aIndex)

Gets the semantic type identifier at a given position.

Parameters:

aIndex - the index of the given position.

Returns:

the semantic type identifier at a given position.

toString

public String toString()

Returns the description title if it exists.

Overrides:

toString in class TLcdDataObject

Returns:

the description title if it exists.

newBuilder

public static TLcdSLDFeatureTypeStyle.Builder<TLcdSLDFeatureTypeStyle> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

Since:

2012.1

newBuilder

public static TLcdSLDFeatureTypeStyle.Builder<TLcdSLDFeatureTypeStyle> newBuilder(TLcdDataType aDataType)

Creates a new builder for the given data type with the default values.

Parameters:

aDataType - The feature type for which this style is created. This type is used to construct XPath expressions.

Returns:

the new builder.

Since:

2012.1

getVersion

public String getVersion()

Returns the value of the property that maps to the version attribute.

The version identifies the Symbology Encoding number this feature type style corresponds to. Depending on the version some properties may not need to be defined.

Returns:

the value of the VERSION_PROPERTY property.

setVersion

public void setVersion(String aValue)

Sets the value of the property that maps to the version attribute.

The version identifies the Symbology Encoding number this feature type style corresponds to. Depending on the version some properties may not need to be defined.

Parameters:

aValue - the value to set for the VERSION_PROPERTY property.

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.

getSemanticTypeIdentifier

public List<String> getSemanticTypeIdentifier()

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

Returns:

the value of the SEMANTIC_TYPE_IDENTIFIER_PROPERTY property.