org.opengis.go.display.style

Interface Symbology

public interface Symbology

The Symbology interface is used to expose a number of properties for a given type of symbology. Each symbology type has a well defined list of properties that can exist for a symbol graphic. This interface allows you to get or set the values of those properties on the graphic.

Method Summary

Modifier and Type	Method and Description
SymbologyInfo	getActiveSymbology() Gets the active symbology name that is being used to render this graphic symbol.
java.lang.Object	getSymbologyProperty(SymbologyInfo info, java.lang.String propertyName) Gets the property value defined by the given property name
int	getSymbologyPropertyCount(SymbologyInfo info) Gets the number of properties that exist for the graphic that uses this symbology.
java.lang.String[]	getSymbologyPropertyNames(SymbologyInfo info) Gets the list of all the property names that exist for the graphic that uses this symbology.
java.lang.Class	getSymbologyPropertyType(SymbologyInfo info, java.lang.String propertyName) Gets the java class type for the property value defined by the property name.
void	setActiveSymbology(SymbologyInfo info) Sets the active symbology name that is being used to render this graphic symbol.
void	setSymbologyProperty(SymbologyInfo info, java.lang.String propertyName, java.lang.Object value) Sets the value of a property for the given property name

Method Detail

getSymbologyPropertyCount

int getSymbologyPropertyCount(SymbologyInfo info)

Gets the number of properties that exist for the graphic that uses this symbology.

Returns:

the number of properties for the graphic

getSymbologyPropertyNames

java.lang.String[] getSymbologyPropertyNames(SymbologyInfo info)

Gets the list of all the property names that exist for the graphic that uses this symbology.

Returns:

the list of property names

getSymbologyPropertyType

java.lang.Class getSymbologyPropertyType(SymbologyInfo info,
                                         java.lang.String propertyName)

Gets the java class type for the property value defined by the property name.

Parameters:

propertyName - the name of the property in question

Returns:

the java class of the property value

getSymbologyProperty

java.lang.Object getSymbologyProperty(SymbologyInfo info,
                                      java.lang.String propertyName)
                               throws java.lang.IllegalArgumentException

Gets the property value defined by the given property name

Parameters:

propertyName - the name of the property to look up

Returns:

the value of the property

Throws:

java.lang.IllegalArgumentException - if the property name isn't a valid one

setSymbologyProperty

void setSymbologyProperty(SymbologyInfo info,
                          java.lang.String propertyName,
                          java.lang.Object value)
                   throws java.lang.IllegalArgumentException

Sets the value of a property for the given property name

Parameters:

propertyName - the property to set

value - the value of the property

Throws:

java.lang.IllegalArgumentException - if the property name isn't valid or if the value is of the wrong java class type

getActiveSymbology

SymbologyInfo getActiveSymbology()

Gets the active symbology name that is being used to render this graphic symbol. An active symbology will use the settings that were set on the Symbology object that will define how the graphic is displayed

Returns:

the active symbology name

setActiveSymbology

void setActiveSymbology(SymbologyInfo info)
                 throws java.lang.IllegalArgumentException

Sets the active symbology name that is being used to render this graphic symbol.

Parameters:

info - the new active symbology

Throws:

java.lang.IllegalArgumentException - if the symbology isn't supported