ilog.cpl.sdm.binding

Class IlpAlarmSeverityColorBinding

java.lang.Object

ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

ilog.cpl.sdm.binding.IlpAlarmSeverityColorBinding

public class IlpAlarmSeverityColorBinding
extends IlpAbstractAttributeBinding

This class defines a binding intended to convert a TGO alarm severity attribute (IltObject.NewAlarmHighestSeverityAttribute, NewImpactAlarmHighestSeverityAttribute, AlarmHighestSeverityAttribute, ImpactAlarmHighestSeverityAttribute, AckAlarmHighestSeverityAttribute and AckImpactAlarmHighestSeverityAttribute) into a SDM model property representing the severity color.

Since:

JViews 8.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlpAlarmSeverityColorBinding.SeverityColors Defines the different variations of the severity color

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
IlpAlarmSeverityColorBinding(IlpAlarmSeverityColorBinding.SeverityColors colorType, String attrName, String propName) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	convertToAttribute(Object newPropVal) This method throws IlpAbstractAttributeBinding.ConversionFailedException as the binding is READ_ONLY.
Object	convertToProperty(Object severity) This method converts the TGO objectState attribute into a severity color according to the default color mapping.
boolean	validate(Object value) Validates a given TGO attribute value.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpAlarmSeverityColorBinding

public IlpAlarmSeverityColorBinding(IlpAlarmSeverityColorBinding.SeverityColors colorType,
                                    String attrName,
                                    String propName)

Constructor.

Parameters:

colorType - Specifies the color variation to be used

attrName - The TGO attribute name of type IltAlarmSeverity

propName - The SDM model property name

Method Detail

convertToAttribute

public Object convertToAttribute(Object newPropVal)

This method throws IlpAbstractAttributeBinding.ConversionFailedException as the binding is READ_ONLY.

Specified by:

convertToAttribute in class IlpAbstractAttributeBinding

Parameters:

newPropVal - The target value

Returns:

The converted source value

convertToProperty

public Object convertToProperty(Object severity)

This method converts the TGO objectState attribute into a severity color according to the default color mapping.

Specified by:

convertToProperty in class IlpAbstractAttributeBinding

Parameters:

severity - The TGO alarm severity attribute value

Returns:

The corresponding color

validate

public boolean validate(Object value)

Description copied from class: IlpAbstractAttributeBinding

Validates a given TGO attribute value.

This method may throw IllegalArgumentException or IlpAbstractAttributeBinding.ConversionFailedException with descriptive detail of the error. The attribute binding mechanism will log the exception.

Overrides:

validate in class IlpAbstractAttributeBinding

Parameters:

value - The attribute value to be validated.

Returns:

true for valid values; false otherwise