ilog.views.symbology

Class IlvSymbolDescriptor

java.lang.Object

ilog.views.symbology.IlvSymbolDescriptor

public class IlvSymbolDescriptor
extends Object

A descriptor of a graphic that is used as symbol. Not every graphic is used as symbol. Typically, composite graphic objects are used as symbols inside SDM, but this class is designed generic so that it can be used for any graphic. In order to retrieve the symbol descriptor of a graphic, use the static method get(IlvGraphic):

 IlvSymbolDescriptor descriptor = IlvSymbolDescriptor.get(graphic);
 if (descriptor != null) {
     ... do something ...
 }
 

Since:

JViews 8.0

Constructor Summary

Constructors

Constructor and Description
IlvSymbolDescriptor() Constructor.

Method Summary

Modifier and Type	Method and Description
static IlvSymbolDescriptor	get(IlvGraphic g) Returns the symbol descriptor of a graphic object.
static IlvSymbolDescriptor	get(IlvGraphic g, boolean allocate) Returns the symbol descriptor of a graphic object.
String	getClassName() Returns the symbol class name of the descriptor.
String	getCSSResourceName() Returns the resource access string of the symbol's CSS.
String	getFullID() Returns the full symbol id of the descriptor.
IlvPalette	getPalette() Returns the palette this object belongs to.
ClassLoader	getPaletteLoader() Returns the palette class loader of the descriptor.
String	getPaletteResourceName() Returns the palette path of the descriptor.
IlvPaletteSymbol	getPaletteSymbol() Returns the palette symbol this object was originated from.
String	getParameterCSSValue(String parameterName) Returns the value of a formal symbol parameter as CSS expression.
String[]	getParameters() Returns all formal parameter names stored in this descriptor.
Object	getParameterValue(String parameterName) Returns the current value of a formal symbol parameter.
void	init(ilog.views.util.cssbeans.IlvCSSBeans css, Object externalBeanModel, String symbolFullID, String symbolCSSResourceName, String symbolClassName, String paletteResourceName, ClassLoader paletteLoader, Map params) Initializes the descriptor.
void	init(String symbolFullID, String symbolCSSResourceName, String symbolClassName, String paletteResourceName, ClassLoader paletteLoader, Map params) Initializes the descriptor.
boolean	isParameterDefined(String parameterName) Tests whether the parameter name is stored in this descriptor.
void	setParameterValue(String parameterName, Object parameterValue) Stores the value of a formal symbol parameter in the descriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSymbolDescriptor

public IlvSymbolDescriptor()

Constructor.

Method Detail

get

public static IlvSymbolDescriptor get(IlvGraphic g)

Returns the symbol descriptor of a graphic object.

get

public static IlvSymbolDescriptor get(IlvGraphic g,
                                      boolean allocate)

Returns the symbol descriptor of a graphic object.

Parameters:

g - The graphic object

allocate - If true and no symbol descriptor exists yet for the graphic object, a new one is allocated and returned.

init

public void init(String symbolFullID,
                 String symbolCSSResourceName,
                 String symbolClassName,
                 String paletteResourceName,
                 ClassLoader paletteLoader,
                 Map params)

Initializes the descriptor.

Since:

JViews 8.1

Internal: do not use!

init

public void init(ilog.views.util.cssbeans.IlvCSSBeans css,
                 Object externalBeanModel,
                 String symbolFullID,
                 String symbolCSSResourceName,
                 String symbolClassName,
                 String paletteResourceName,
                 ClassLoader paletteLoader,
                 Map params)

Initializes the descriptor.

Since:

JViews 8.8

Internal: do not use!

getFullID

public String getFullID()

Returns the full symbol id of the descriptor.

See Also:

IlvPaletteBaseObject.getFullID()

getCSSResourceName

public String getCSSResourceName()

Returns the resource access string of the symbol's CSS.

See Also:

IlvPaletteSymbol.getCSSResourceName()

getClassName

public String getClassName()

Returns the symbol class name of the descriptor.

See Also:

IlvPaletteSymbol.getClassName()

getPaletteResourceName

public String getPaletteResourceName()

Returns the palette path of the descriptor.

See Also:

IlvPalette.getPaletteResourceName()

getPaletteLoader

public ClassLoader getPaletteLoader()

Returns the palette class loader of the descriptor. This is the class loader that was able to find the definition of the symbol.

getParameters

public String[] getParameters()

Returns all formal parameter names stored in this descriptor.

isParameterDefined

public boolean isParameterDefined(String parameterName)

Tests whether the parameter name is stored in this descriptor.

Parameters:

parameterName - The name of the formal symbol parameter

Returns:

true if the parameter was set via setParameterValue(String,Object).

getPalette

public IlvPalette getPalette()

Returns the palette this object belongs to. The descriptor is attached to a graphic that was created through CSS from the definition of a symbol. This method returns the palette that contains the definition of the symbol. This method may return null if the descriptor does not contain enough information to retrieve the palette.

getPaletteSymbol

public IlvPaletteSymbol getPaletteSymbol()

Returns the palette symbol this object was originated from. The descriptor is attached to a graphic that was created through CSS from the definition of a symbol. This method returns the palette symbol which is essentially the definition of the symbol. This method may return null if the descriptor does not contain enough information to retrieve the palette symbol.

getParameterValue

public Object getParameterValue(String parameterName)

Returns the current value of a formal symbol parameter. The value is obtained by evaluating the CSS expression obtained from getParameterCSSValue(String). Returns null if the parameter name is not stored in this descriptor. Note that it also returns null if a formal symbol parameter was explicitly set to null. Use isParameterDefined(String) to distinguish these two cases.

Parameters:

parameterName - The name of the formal symbol parameter

Returns:

The current value of the formal symbol parameter

See Also:

getParameterCSSValue(java.lang.String)

getParameterCSSValue

public String getParameterCSSValue(String parameterName)

Returns the value of a formal symbol parameter as CSS expression. Returns null if the parameter name is not stored in this descriptor. Note that it also returns null if a formal symbol parameter was explicitly set to null. Use isParameterDefined(String) to distinguish these two cases.

The difference with getParameterValue(String) is that this methods returns the string in the style sheet (e.g. "@name") instead of its computed value (the value of the model attribute "@name").

Parameters:

parameterName - The name of the formal symbol parameter

Returns:

The current CSS expression of the formal symbol parameter.

See Also:

getParameterValue(java.lang.String)

setParameterValue

public void setParameterValue(String parameterName,
                              Object parameterValue)

Stores the value of a formal symbol parameter in the descriptor. It does not affect the CSS parameter value of the formal symbol parameter, only the Object parameter value. You should not call this method.

Parameters:

parameterName - The name of the formal symbol parameter

parameterValue - The value of the formal symbol parameter