ilog.views.symbol.util

Class IlvSymbolProperties

java.lang.Object

ilog.views.symbol.util.IlvSymbolProperties

public class IlvSymbolProperties
extends Object

Property holder of compiled symbols. This class is not intended to be accessed directly by a user application.

Since:

JViews 8.5

Constructor Summary

Constructors

Constructor and Description
IlvSymbolProperties(IlvSymbolParameterAccessor[] params) Constructs an IlvSymbolProperties object.

Method Summary

Modifier and Type	Method and Description
void	addParameterAccessors(IlvSymbolParameterAccessor[] params) Adds symbol parameter accessors to this property holder.
Iterator<String>	getMappings() Returns the names of the properties mapped to the symbol parameters.
String	getParameterMapping(String paramID) Returns the name of a mapped property of a given parameter.
Object	getParameterValue(String paramID) Returns a parameter value.
Object	getProperty(String key) Returns a symbol property value.
void	setMapping(String paramID, String propertyName) Maps a parameter to a symbol property.
void	setParameterValue(String paramID, Object value) Sets a parameter value.
void	setProperty(String key, Object value) Sets a symbol property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSymbolProperties

public IlvSymbolProperties(IlvSymbolParameterAccessor[] params)

Constructs an IlvSymbolProperties object.

Parameters:

params - The symbol parameter accessors.

Method Detail

addParameterAccessors

public void addParameterAccessors(IlvSymbolParameterAccessor[] params)

Adds symbol parameter accessors to this property holder.

Parameters:

params - The additional parameter accessors.

getParameterValue

public Object getParameterValue(String paramID)

Returns a parameter value.

Parameters:

paramID - The ID of the parameter.

Returns:

The value of the parameter.

setParameterValue

public void setParameterValue(String paramID,
                              Object value)

Sets a parameter value. If the parameter is mapped to a property, the mapped property is set.

Parameters:

paramID - The ID of the parameter.

value - The new value to be set to the parameter.

getParameterMapping

public String getParameterMapping(String paramID)

Returns the name of a mapped property of a given parameter.

Parameters:

paramID - The ID of the parameter.

Returns:

The name of the mapped symbol property, or null if the parameter is not mapped.

setMapping

public void setMapping(String paramID,
                       String propertyName)

Maps a parameter to a symbol property.

Parameters:

paramID - The ID of the mapped parameter.

propertyName - The name of the mapped symbol property.

setProperty

public void setProperty(String key,
                        Object value)

Sets a symbol property value. If one or more symbol parameter is mapped to this property, the mapped parameters are set to the given value.

Parameters:

key - The symbol property.

value - The symbol property value.

getProperty

public Object getProperty(String key)

Returns a symbol property value.

Parameters:

key - The property name.

Returns:

The value of the symbol property.

getMappings

public Iterator<String> getMappings()

Returns the names of the properties mapped to the symbol parameters.

Returns:

The names of the properties mapped to the symbol parameters.