org.geomajas.configuration

Class NamedStyleInfo

java.lang.Object

org.geomajas.configuration.NamedStyleInfo

All Implemented Interfaces:

Serializable, IsInfo, CacheableObject

@Api(allMethods=true)
public class NamedStyleInfo
extends Object
implements IsInfo, CacheableObject

A named layer style for vector layers. The layer style consists of a list of feature styles. Each style has a unique name. Can hold both SLD and simple FeatureStyleInfo configuration.

Since:

1.6.0

Author:

Jan De Moerloose

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME Name of the default style.

Constructor Summary

Constructors

Constructor and Description
NamedStyleInfo()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDefaults() Applies default values to all properties that have not been set.
boolean	equals(Object o) Are the two objects equal?
String	getCacheId() String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result.
List<FeatureStyleInfo>	getFeatureStyles() Get possible styles for features.
LabelStyleInfo	getLabelStyle() Get label style.
String	getName() Name for style info.
String	getSldLayerName() Get the name of the SLD NamedLayer/UserLayer that contains this style.
String	getSldLocation() Get the SLD file location (Spring resource format).
String	getSldStyleName() Get the name of the SLD UserStyle that corresponds to this style.
org.geomajas.sld.UserStyleInfo	getUserStyle() Get the SLD UserStyle info for this layer.
int	hashCode() Calculate object hash code.
void	setFeatureStyles(List<FeatureStyleInfo> featureStyles) Set list of possible styles for features.
void	setLabelStyle(LabelStyleInfo labelStyleInfo) Set label style.
void	setName(String name) Set name for style info.
void	setSldLayerName(String sldLayerName) Set the name of the SLD NamedLayer/UserLayer that contains this style.
void	setSldLocation(String sldLocation) Set the SLD file location (Spring resource format).
void	setSldStyleName(String sldStyleName) Set the name of the SLD UserStyle that contains this style.
void	setUserStyle(org.geomajas.sld.UserStyleInfo userStyle) Set SLD UserStyle info, the style configuration for this layer.
String	toString() String representation of object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

Name of the default style.

Since:

1.10.0

See Also:

Constant Field Values

Constructor Detail

NamedStyleInfo

public NamedStyleInfo()

Method Detail

applyDefaults

public void applyDefaults()

Applies default values to all properties that have not been set.

Since:

1.10.0

getUserStyle

public org.geomajas.sld.UserStyleInfo getUserStyle()

Get the SLD UserStyle info for this layer.

Returns:

SLD info

Since:

1.10.0

setUserStyle

public void setUserStyle(org.geomajas.sld.UserStyleInfo userStyle)

Set SLD UserStyle info, the style configuration for this layer.

Parameters:

userStyle - SLD UserStyle info

Since:

1.10.0

getSldLocation

public String getSldLocation()

Get the SLD file location (Spring resource format).

Returns:

the location of the SLD file

Since:

1.10.0

setSldLocation

public void setSldLocation(String sldLocation)

Set the SLD file location (Spring resource format).

Parameters:

sldLocation - the SLD location

Since:

1.10.0

getSldLayerName

public String getSldLayerName()

Get the name of the SLD NamedLayer/UserLayer that contains this style. If null the first NamedLayer should be chosen.

Returns:

the name of the NamedLayer/UserLayer

Since:

1.10.0

setSldLayerName

public void setSldLayerName(String sldLayerName)

Set the name of the SLD NamedLayer/UserLayer that contains this style.

Parameters:

sldLayerName - the name of the NamedLayer/UserLayer

Since:

1.10.0

getSldStyleName

public String getSldStyleName()

Get the name of the SLD UserStyle that corresponds to this style. If null the first UserStyle should be chosen.

Returns:

the name of the UserStyle

Since:

1.10.0

setSldStyleName

public void setSldStyleName(String sldStyleName)

Set the name of the SLD UserStyle that contains this style.

Parameters:

sldStyleName - the name of the UserStyle

Since:

1.10.0

getFeatureStyles

public List<FeatureStyleInfo> getFeatureStyles()

Get possible styles for features. These are traversed from the beginning, the first style for which the formula evaluates successfully is applied.

Returns:

list of feature styles

setFeatureStyles

public void setFeatureStyles(List<FeatureStyleInfo> featureStyles)

Set list of possible styles for features. These are traversed from the beginning, the first style for which the formula evaluates successfully is applied.

Parameters:

featureStyles - list of feature styles

getName

public String getName()

Name for style info.

Returns:

name

setName

public void setName(String name)

Set name for style info.

Parameters:

name - name

getLabelStyle

public LabelStyleInfo getLabelStyle()

Get label style.

Returns:

label style

setLabelStyle

public void setLabelStyle(LabelStyleInfo labelStyleInfo)

Set label style.

Parameters:

labelStyleInfo - label style

getCacheId

public String getCacheId()

String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result. It is typically used as basis for calculation of hash codes (like MD5, SHA1, SHA2 etc) of (collections of) objects.

Specified by:

getCacheId in interface CacheableObject

Returns:

cacheId

Since:

1.8.0

toString

public String toString()

String representation of object.

Overrides:

toString in class Object

Returns:

string representation of object

Since:

1.8.0

equals

public boolean equals(Object o)

Are the two objects equal?

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

true when objects are equal

Since:

1.8.0

hashCode

public int hashCode()

Calculate object hash code.

Overrides:

hashCode in class Object

Returns:

hash code

Since:

1.8.0