Package com.luciad.ogc.sld.model

Class TLcdSLDMark

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.sld.model.TLcdSLDMark

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdSLDMark
extends TLcdDataObject

A Mark specifies a geometric shape and applies coloring to it. The shape can be either a predefined constant, which is referred to as a 'well known name', or it can be an arbitrary vector graphic that is included inline or loaded from a file, such as an SVG.

In case you want to use a bitmap graphic, you should use TLcdSLDExternalGraphic instead.

See Also:

• TLcdSLDExternalGraphic

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKSLASH	Well-known name for a backward diagonal line
static final String	CIRCLE	Well-known name for a circle mark
static final String	CROSS	Well-known name for a cross mark
static final String	HORIZONTAL_LINE	Well-known name for a horizontal line
static final String	PLUS	Well-known name for a plus mark
static final String	SLASH	Well-known name for a forward diagonal line
static final String	SQUARE	Well-known name for a square mark
static final String	STAR	Well-known name for a star mark
static final String	TIMES	Well-known name for a times mark
static final String	TRIANGLE	Well-known name for a triangle mark
static final String	VERTICAL_LINE	Well-known name for a vertical line
static final String	X	Well-known name for a x mark

Constructor Summary

Constructors

Constructor	Description
TLcdSLDMark()	Creates a new TLcdSLDMark.
TLcdSLDMark(TLcdDataType aDataType)	Empty constructor.
TLcdSLDMark(String aWellKnownName, TLcdSLDFill aFill, TLcdSLDStroke aStroke)	Creates a new TLcdSLDMark for the given well-known mark name, fill and stroke.

Method Summary

Modifier and Type	Method	Description
TLcdSLDFill	getFill()	Returns the value of the property that maps to the Fill element.
String	getFormat()	Returns the value of the property that maps to the Format element.
TLcdSLDParameterValue	getOnlineResourceURI()	Returns a parameter value that can be evaluated to a URI to a resource.
TLcdSLDStroke	getStroke()	Returns the value of the property that maps to the Stroke element.
String	getWellKnownName()	Returns the value of the property that maps to the WellKnownName element.
void	setFill(TLcdSLDFill aValue)	Sets the value of the property that maps to the Fill element.
void	setFormat(String aValue)	Sets the value of the property that maps to the Format element.
void	setOnlineResourceURI(TLcdSLDParameterValue aURI)	Sets the URI to an online resource that resolves to a simple graphic.
void	setStroke(TLcdSLDStroke aValue)	Sets the value of the property that maps to the Stroke element.
void	setWellKnownName(String aValue)	Sets the value of the property that maps to the WellKnownName element.

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

Field Details

SQUARE

public static final String SQUARE

Well-known name for a square mark

See Also:

• Constant Field Values

CIRCLE

public static final String CIRCLE

Well-known name for a circle mark

See Also:

• Constant Field Values

TRIANGLE

public static final String TRIANGLE

Well-known name for a triangle mark

See Also:

• Constant Field Values

STAR

public static final String STAR

Well-known name for a star mark

See Also:

• Constant Field Values

CROSS

public static final String CROSS

Well-known name for a cross mark

See Also:

• Constant Field Values

X

public static final String X

Well-known name for a x mark

See Also:

• Constant Field Values

HORIZONTAL_LINE

public static final String HORIZONTAL_LINE

Well-known name for a horizontal line

Since:

2023.1

See Also:

• Constant Field Values

VERTICAL_LINE

public static final String VERTICAL_LINE

Well-known name for a vertical line

Since:

2023.1

See Also:

• Constant Field Values

SLASH

public static final String SLASH

Well-known name for a forward diagonal line

Since:

2023.1

See Also:

• Constant Field Values

BACKSLASH

public static final String BACKSLASH

Well-known name for a backward diagonal line

Since:

2023.1

See Also:

• Constant Field Values

PLUS

public static final String PLUS

Well-known name for a plus mark

Since:

2023.1

See Also:

• Constant Field Values

TIMES

public static final String TIMES

Well-known name for a times mark

Since:

2023.1

See Also:

• Constant Field Values

Constructor Details

TLcdSLDMark

public TLcdSLDMark()

Creates a new TLcdSLDMark. By default, the mark name is set to SQUARE; the fill and stroke are respectively set to default instances of TLcdSLDFill and TLcdSLDStroke.

TLcdSLDMark

public TLcdSLDMark(String aWellKnownName,
 TLcdSLDFill aFill,
 TLcdSLDStroke aStroke)

Creates a new TLcdSLDMark for the given well-known mark name, fill and stroke.

Parameters:

aWellKnownName - the given well-known name of the mark. See constants defined in this class.

aFill - the given fill.

aStroke - the given stroke.

TLcdSLDMark

public TLcdSLDMark(TLcdDataType aDataType)

Empty constructor.

Method Details

getOnlineResourceURI

public TLcdSLDParameterValue getOnlineResourceURI()

Returns a parameter value that can be evaluated to a URI to a resource. Usually this is a filename, or a URL. The URI should resolve to an image of the format returned by getFormat().

This value is mutually exclusive with the value returned by getWellKnownName(), so this method will return null if a well known name is set.

Returns:

A parameter value that evaluates to a URI of a resource, or null.

Since:

2012.1

See Also:

• getFormat()

setOnlineResourceURI

public void setOnlineResourceURI(TLcdSLDParameterValue aURI)

Sets the URI to an online resource that resolves to a simple graphic. This URI can be a filename, or a URL. The URI is specified as an SLD parameter value that can be evaluated for a given feature.

This property is mutually exclusive with the well known name, so setting it removes anything that is previously set with setWellKnownName(String).

Parameters:

aURI - A parameter value that evaluates to a URI of a simple graphic.

Since:

2012.1

getWellKnownName

public String getWellKnownName()

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

Returns:

the value of the WELL_KNOWN_NAME_PROPERTY property.

setWellKnownName

public void setWellKnownName(String aValue)

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

Parameters:

aValue - the value to set for the WELL_KNOWN_NAME_PROPERTY property.

getFormat

public String getFormat()

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

Returns:

the value of the FORMAT_PROPERTY property.

setFormat

public void setFormat(String aValue)

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

Parameters:

aValue - the value to set for the FORMAT_PROPERTY property.

getFill

public TLcdSLDFill getFill()

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

A "Fill" specifies the pattern for filling an area geometry. The allowed CssParameters are: "fill" (color) and "fill-opacity".

Returns:

the value of the FILL_PROPERTY property.

setFill

public void setFill(TLcdSLDFill aValue)

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

A "Fill" specifies the pattern for filling an area geometry. The allowed CssParameters are: "fill" (color) and "fill-opacity".

Parameters:

aValue - the value to set for the FILL_PROPERTY property.

getStroke

public TLcdSLDStroke getStroke()

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

The stroke is optional and may thus be null.

Returns:

the value of the STROKE_PROPERTY property.

setStroke

public void setStroke(TLcdSLDStroke aValue)

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

The stroke is optional and may thus be null.

Parameters:

aValue - the value to set for the STROKE_PROPERTY property.