ilog.cpl.sdm.binding

Class IlpEnumBinding

java.lang.Object

ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

ilog.cpl.sdm.binding.IlpEnumBinding

public class IlpEnumBinding
extends IlpAbstractAttributeBinding

This class defines a binding between a TGO attributes (IlpAttribute) of type IlEnum and a SDM model properties of type String.

It relies on the IlEnum.metainfo to convert from SDM property to TGO attribute, and on IlEnum.getName() to convert from TGO attribute to SDM property.

Since:

JViews 8.7

Nested Class Summary

Nested classes/interfaces inherited from class ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

IlpAbstractAttributeBinding.ConversionFailedException, IlpAbstractAttributeBinding.PropertyAlreadySetException, IlpAbstractAttributeBinding.Type

Field Summary

Fields inherited from class ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

_attributeName, _attributeType, _bindingContext, _propertyName, _propertyType, _type

Constructor Summary

Constructors

Constructor and Description
IlpEnumBinding(IlpAbstractAttributeBinding.Type bindingType, IlpAttribute attribute) Constructor.
IlpEnumBinding(IlpAbstractAttributeBinding.Type bindingType, IlpAttribute attribute, String propName) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	convertToAttribute(Object newPropVal) Converts a value from the SDM model property target type to the TGO attribute source type.
Object	convertToProperty(Object newAttrVal) Converts a value from the TGO attribute source type to the SDM model property target type.

Methods inherited from class ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

equals, getAttributeName, getAttributeType, getBindingContext, getPropertyName, getPropertyType, getType, setAttributeName, setAttributeType, setBindingContext, setPropertyName, setPropertyType, setType, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpEnumBinding

public IlpEnumBinding(IlpAbstractAttributeBinding.Type bindingType,
                      IlpAttribute attribute,
                      String propName)

Constructor.

Parameters:

bindingType - Whether this binding is READ_ONLY or WRITE_ONLY, according to IlpAbstractAttributeBinding.Type.

attribute - The TGO attribute being bound, it must be an attribute whose value is an IlEnum

propName - The corresponding SDM property name

IlpEnumBinding

public IlpEnumBinding(IlpAbstractAttributeBinding.Type bindingType,
                      IlpAttribute attribute)

Constructor.

It assumes that the TGO attribute name and SDM property name are the same.

Parameters:

bindingType - Whether this binding is READ_ONLY or WRITE_ONLY, according to IlpAbstractAttributeBinding.Type.

attribute - The TGO attribute being bound, it must be an attribute whose value is an IlEnum

Method Detail

convertToAttribute

public Object convertToAttribute(Object newPropVal)

Description copied from class: IlpAbstractAttributeBinding

Converts a value from the SDM model property target type to the TGO attribute source type.

It can throw RuntimeException if the conversion fails.

Specified by:

convertToAttribute in class IlpAbstractAttributeBinding

Parameters:

newPropVal - The target value

Returns:

The converted source value

convertToProperty

public Object convertToProperty(Object newAttrVal)

Description copied from class: IlpAbstractAttributeBinding

Converts a value from the TGO attribute source type to the SDM model property target type.

It can throw RuntimeException if the conversion fails.

Specified by:

convertToProperty in class IlpAbstractAttributeBinding

Parameters:

newAttrVal - The TGO attribute value

Returns:

The converted target value