IlpAbstractAttributeBinding (Perforce JViews 10.0 API)

java.lang.Object
- ilog.cpl.sdm.binding.IlpAbstractAttributeBinding

Direct Known Subclasses:

IlpAbstractPositionBinding, IlpAlarmSeverityColorBinding, IlpDefaultAttributeBinding, IlpEnumBinding, IlpSlotSizesBinding
```
public abstract class IlpAbstractAttributeBinding
extends Object
```
This class defines a binding between a TGO attribute (IlpAttribute) of a given IlpClass and a SDM model property (IlvSDMModel).

An attribute binding is defined by a source TGO attribute and a target SDM Model property and their corresponding types. It can be defined as READ_ONLY (the SDM model property is only readable) or READ_WRITE (the SDM model property can be modified, which will update the TGO attribute value accordingly).

The binding is also responsible for converting from TGO attribute to SDM model property and vice-versa, the default behavior is to just cast one type to another (which may throw casting exceptions). Subclasses can customize the conversion behavior as needed.

When converting from a SDM model property to a TGO attribute, the binding will also validate the converted value, to ensure that it is a valid TGO attribute value.

Note: The binding conversion methods are automatically accessed by the IlpAbstractSDMAdapter holding the binding. Directly invoking these methods may result in unpredictable behavior.

Since:

JViews 8.7

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlpAbstractAttributeBinding.ConversionFailedException` This exception indicates that an attribute or property conversion failed.
`static class`	`IlpAbstractAttributeBinding.PropertyAlreadySetException` This exception indicates that a binding property has been already set and cannot be updated.
`static class`	`IlpAbstractAttributeBinding.Type` Enumeration defining the different types of binding, which are: `READ_ONLY` The SDM model property can only be read `READ_WRITE` The SDM model property can be updated

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_attributeName` The TGO attribute name property
`protected Class<?>`	`_attributeType` The TGO attribute type property
`protected IlpAttributeBindingContext`	`_bindingContext` Reference to the attribute binding support
`protected String`	`_propertyName` The SDM model property name
`protected Class<?>`	`_propertyType` The SDM model property type
`protected IlpAbstractAttributeBinding.Type`	`_type` The binding type

Constructor Summary

Constructors
Constructor and Description
`IlpAbstractAttributeBinding(IlpAbstractAttributeBinding.Type bindingType, String attrName, Class<?> attrType, String propName, Class<?> propType)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Object`	`convertToAttribute(Object newPropVal)` Converts a value from the SDM model property target type to the TGO attribute source type.
`abstract Object`	`convertToProperty(Object newAttrVal)` Converts a value from the TGO attribute source type to the SDM model property target type.
`boolean`	`equals(Object obj)` Two attribute bindings are considered equal if: this.getAttributeName().equals(other.getAttributeName()) && this.getPropertyName().equals(other.getPropertyName()) Other parameters are not considered.
`String`	`getAttributeName()` Access the TGO attribute name of this binding.
`Class<?>`	`getAttributeType()` Access the TGO attribute type of this binding.
`protected IlpAttributeBindingContext`	`getBindingContext()` Access the binding context.
`String`	`getPropertyName()` Access the SDM model property name of this binding.
`Class<?>`	`getPropertyType()` Access the SDM model property type of this binding.
`IlpAbstractAttributeBinding.Type`	`getType()` Access the binding type.
`void`	`setAttributeName(String name)` Sets the TGO attribute name of this binding.
`void`	`setAttributeType(Class<?> type)` Sets the TGO attribute type of this binding.
`void`	`setBindingContext(IlpAttributeBindingContext bindingContext)` Method invoked internally by `IlpAbstractSDMAdapter` to set the binding context into this binding.
`void`	`setPropertyName(String name)` Sets the SDM model property name of this binding.
`void`	`setPropertyType(Class<?> type)` Sets the SDM model property type of this binding.
`void`	`setType(IlpAbstractAttributeBinding.Type type)` Sets the binding type.
`boolean`	`validate(Object value)` Validates a given TGO attribute value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _bindingContext
```
protected IlpAttributeBindingContext _bindingContext
```
    Reference to the attribute binding support
  - _attributeName
```
protected String _attributeName
```
    The TGO attribute name property
  - _attributeType
```
protected Class<?> _attributeType
```
    The TGO attribute type property
  - _propertyName
```
protected String _propertyName
```
    The SDM model property name
  - _propertyType
```
protected Class<?> _propertyType
```
    The SDM model property type
  - _type
```
protected IlpAbstractAttributeBinding.Type _type
```
    The binding type
- Constructor Detail
  - IlpAbstractAttributeBinding
```
public IlpAbstractAttributeBinding(IlpAbstractAttributeBinding.Type bindingType,
                                   String attrName,
                                   Class<?> attrType,
                                   String propName,
                                   Class<?> propType)
```
    Constructor.
    
    Parameters:
    
    bindingType - The binding type
    
    attrName - The TGO attribute name
    
    attrType - The TGO attribute value type
    
    propName - The SDM model property name
    
    propType - The SDM model property value type
- Method Detail
  - getAttributeName
```
public String getAttributeName()
```
    Access the TGO attribute name of this binding.
    
    Returns:
    
    The attribute name
  - setAttributeName
```
public void setAttributeName(String name)
                      throws IlpAbstractAttributeBinding.PropertyAlreadySetException
```
    Sets the TGO attribute name of this binding.
    
    Note that this method can only be invoked once, when the binding has been constructed as a bean.
    
    Parameters:
    
    name - The TGO attribute name
    
    Throws:
    
    IlpAbstractAttributeBinding.PropertyAlreadySetException - If the property has already been set
  - getAttributeType
```
public Class<?> getAttributeType()
```
    Access the TGO attribute type of this binding.
    
    Returns:
    
    The attribute type
  - setAttributeType
```
public void setAttributeType(Class<?> type)
```
    Sets the TGO attribute type of this binding.
    
    Note that this method can only be invoked once, when the binding has been constructed as a bean.
    
    Parameters:
    
    type - The TGO attribute type
    
    Throws:
    
    IlpAbstractAttributeBinding.PropertyAlreadySetException - If the property has already been set
  - getPropertyName
```
public String getPropertyName()
```
    Access the SDM model property name of this binding.
    
    Returns:
    
    The property name
  - setPropertyName
```
public void setPropertyName(String name)
```
    Sets the SDM model property name of this binding.
    
    Note that this method can only be invoked once, when the binding has been constructed as a bean.
    
    Parameters:
    
    name - The SDM model property name
    
    Throws:
    
    IlpAbstractAttributeBinding.PropertyAlreadySetException - If the property has already been set
  - getPropertyType
```
public Class<?> getPropertyType()
```
    Access the SDM model property type of this binding.
    
    Returns:
    
    The property type
  - setPropertyType
```
public void setPropertyType(Class<?> type)
```
    Sets the SDM model property type of this binding.
    
    Note that this method can only be invoked once, when the binding has been constructed as a bean.
    
    Parameters:
    
    type - The SDM model property type
    
    Throws:
    
    IlpAbstractAttributeBinding.PropertyAlreadySetException - If the property has already been set
  - getType
```
public IlpAbstractAttributeBinding.Type getType()
```
    Access the binding type.
    
    Returns:
    
    The binding type
  - setType
```
public void setType(IlpAbstractAttributeBinding.Type type)
```
    Sets the binding type.
    
    Note that this method can only be invoked once, when the binding has been constructed as a bean.
    
    Parameters:
    
    type - The binding type
    
    Throws:
    
    IlpAbstractAttributeBinding.PropertyAlreadySetException - If the property has already been set
  - getBindingContext
```
protected IlpAttributeBindingContext getBindingContext()
```
    Access the binding context.
    
    Returns:
    
    The binding context
  - setBindingContext
```
public final void setBindingContext(IlpAttributeBindingContext bindingContext)
```
    Method invoked internally by IlpAbstractSDMAdapter to set the binding context into this binding.
    
    This method cannot be extended.
    
    Parameters:
    
    bindingContext - The binding context to be set
  - convertToProperty
```
public abstract Object convertToProperty(Object newAttrVal)
```
    Converts a value from the TGO attribute source type to the SDM model property target type.
    
    It can throw RuntimeException if the conversion fails.
    
    Parameters:
    
    newAttrVal - The TGO attribute value
    
    Returns:
    
    The converted target value
  - convertToAttribute
```
public abstract Object convertToAttribute(Object newPropVal)
```
    Converts a value from the SDM model property target type to the TGO attribute source type.
    
    It can throw RuntimeException if the conversion fails.
    
    Parameters:
    
    newPropVal - The target value
    
    Returns:
    
    The converted source value
  - validate
```
public boolean validate(Object value)
```
    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.
    
    Parameters:
    
    value - The attribute value to be validated.
    
    Returns:
    
    true for valid values; false otherwise
  - equals
```
public boolean equals(Object obj)
```
    Two attribute bindings are considered equal if:
```
   this.getAttributeName().equals(other.getAttributeName())
     &&
   this.getPropertyName().equals(other.getPropertyName())
 
```
    Other parameters are not considered.
    Overrides:
    
    equals in class Object

Class IlpAbstractAttributeBinding

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_bindingContext

_attributeName

_attributeType

_propertyName

_propertyType

_type

Constructor Detail

IlpAbstractAttributeBinding

Method Detail

getAttributeName

setAttributeName

getAttributeType

setAttributeType

getPropertyName

setPropertyName

getPropertyType

setPropertyType

getType

setType

getBindingContext

setBindingContext

convertToProperty

convertToAttribute

validate

equals