com.luciad.ogc.sld.model

LuciadLightspeedClass TLcdSLDFeatureTypeStyle.Builder<T>

java.lang.Object

com.luciad.ogc.sld.model.TLcdSLDFeatureTypeStyle.Builder<T>

Enclosing class:

TLcdSLDFeatureTypeStyle

public static class TLcdSLDFeatureTypeStyle.Builder<T>
extends Object

A builder for SLD Feature Type Styles.

Since:

2012.1

Method Summary

Modifier and Type	Method and Description
TLcdSLDRule.Builder<TLcdSLDFeatureTypeStyle.Builder<T>>	addRule() Starts a new rule.
TLcdSLDFeatureTypeStyle.Builder<T>	addRule(TLcdSLDRule aRule) Adds a rule to the feature type style under construction.
T	buildStyle() Builds the feature type style with the set parameters.
TLcdSLDFeatureTypeStyle.Builder<T>	description(TLcdSLDDescription aDescription) Sets the description of the style.
TLcdSLDFeatureTypeStyle.Builder<T>	descriptionAbstract(String aAbstract) Sets the abstract of the description of the style.
TLcdSLDFeatureTypeStyle.Builder<T>	descriptionTitle(String aTitle) Sets the title of the description of the style.
TLcdSLDFeatureTypeStyle.Builder<T>	featureTypeName(String aTypeName) Sets the feature type name of the style.
TLcdSLDFeatureTypeStyle.Builder<T>	name(String aName) Sets the name of the style.

Methods inherited from class java.lang.Object

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

Method Detail

name

public TLcdSLDFeatureTypeStyle.Builder<T> name(String aName)

Sets the name of the style.

Parameters:

aName - A name. Must not be null

Returns:

this builder

See Also:

ALcdSLDFeatureTypeStyle.getName()

descriptionTitle

public TLcdSLDFeatureTypeStyle.Builder<T> descriptionTitle(String aTitle)

Sets the title of the description of the style.

It is not allowed to call this method if you already called description(TLcdSLDDescription).

Parameters:

aTitle - The title of the description. Must not be null

Returns:

this builder.

See Also:

descriptionAbstract(String), description(TLcdSLDDescription)

descriptionAbstract

public TLcdSLDFeatureTypeStyle.Builder<T> descriptionAbstract(String aAbstract)

Sets the abstract of the description of the style.

It is not allowed to call this method if you already called description(TLcdSLDDescription).

Parameters:

aAbstract - The abstract of the description. Must not be null

Returns:

this builder.

See Also:

descriptionTitle(String), description(TLcdSLDDescription)

description

public TLcdSLDFeatureTypeStyle.Builder<T> description(TLcdSLDDescription aDescription)

Sets the description of the style.

It is not allowed to call this method if you already called descriptionTitle(String) or descriptionAbstract(String).

Parameters:

aDescription - The description. Must not be null

Returns:

this builder.

See Also:

descriptionTitle(String), descriptionAbstract(String)

featureTypeName

public TLcdSLDFeatureTypeStyle.Builder<T> featureTypeName(String aTypeName)

Sets the feature type name of the style. This type name overrides the type name of the data type to use this filter. If there is no TLcdDataType, nor a typeName, than the 'FeatureTypeName' will not be set.

Parameters:

aTypeName - A valid type name.

Returns:

this builder

addRule

public TLcdSLDRule.Builder<TLcdSLDFeatureTypeStyle.Builder<T>> addRule()

Starts a new rule. Each feature type style should contain at least one rule. When the rule is done, calling TLcdSLDRule.Builder.buildRule() will return this builder.

Returns:

a TLcdSLDRule builder.

See Also:

addRule()

addRule

public TLcdSLDFeatureTypeStyle.Builder<T> addRule(TLcdSLDRule aRule)

Adds a rule to the feature type style under construction.

Parameters:

aRule - The rule. Should not be null

Returns:

This builder

See Also:

addRule()

buildStyle

public T buildStyle()

Builds the feature type style with the set parameters.

This method can only be called once. When you used the builder to build an instance, the builder is no longer valid and should be thrown away.

Returns:

the resulting style