ilog.cpl.sdm

Class IlpDefaultSDMAdapter

java.lang.Object

ilog.cpl.sdm.IlpAbstractSDMAdapter

ilog.cpl.sdm.IlpDefaultSDMAdapter

All Implemented Interfaces:

DataSourceListener, EventListener

public class IlpDefaultSDMAdapter
extends IlpAbstractSDMAdapter

Implements an adapter between a mutable TGO data source (IlpMutableDataSource) and a basic SDM model (IlvBasicSDMModel).

Since:

JViews 8.7

Constructor Summary

Constructors

Constructor and Description
IlpDefaultSDMAdapter()

Method Summary

Modifier and Type	Method and Description
void	addDefaultBindings() Applies a default set of attribute bindings to this adapter.
protected void	dataSourceAddObject(IlpObject object) Adds a new object in the TGO data source.
protected void	dataSourceClear() Clears the TGO data source completely.
protected void	dataSourceEndBatch() Stops the TGO data source batching mode.
protected void	dataSourceRemoveObject(IlpObject object) Removes an object from the TGO data source.
protected void	dataSourceSetLink(IlpObject link, Object fromId, Object toId) Sets the link endpoint relationship between a link and two nodes in the TGO data source.
protected void	dataSourceSetParent(IlpObject object, IlpObject parent) Sets a parent-child relationship in the TGO data source.
protected void	dataSourceStartBatch() Starts the TGO data source batching mode.
void	setDataSource(IlpDataSource dataSource) Sets the data source.

Methods inherited from class ilog.cpl.sdm.IlpAbstractSDMAdapter

addAttributeBinding, addAttributeBinding, addPropertyChangeListener, addPropertyChangeListener, batchEnded, batchStarted, firePropertyChange, getAcceptedClasses, getBindings, getBindings, getDataSource, getExcludedClasses, getFilter, getSDMLogger, getSDMModel, isRepresenting, objectAttributeChanged, objectsAdded, objectsRemoved, objectStructureChanged, refilter, refilterObjects, removeAllAttributeBindings, removeAllAttributeBindings, removeAttributeBinding, removeAttributeBinding, removePropertyChangeListener, removePropertyChangeListener, setAcceptedClasses, setExcludedClasses, setFilter, testObject

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpDefaultSDMAdapter

public IlpDefaultSDMAdapter()

Method Detail

setDataSource

public void setDataSource(IlpDataSource dataSource)

Sets the data source.

Ensures that the given data source is a mutable data source (IlpMutableDataSource).

Overrides:

setDataSource in class IlpAbstractSDMAdapter

Parameters:

dataSource - The mutable data source to be used by this adapter.

Throws:

IllegalArgumentException - If the input data source is not an instance of IlpMutableDataSource

See Also:

IlpMutableDataSource

dataSourceAddObject

protected void dataSourceAddObject(IlpObject object)

Description copied from class: IlpAbstractSDMAdapter

Adds a new object in the TGO data source.

Specified by:

dataSourceAddObject in class IlpAbstractSDMAdapter

Parameters:

object - The object to be added

dataSourceClear

protected void dataSourceClear()

Description copied from class: IlpAbstractSDMAdapter

Clears the TGO data source completely.

Specified by:

dataSourceClear in class IlpAbstractSDMAdapter

dataSourceEndBatch

protected void dataSourceEndBatch()

Description copied from class: IlpAbstractSDMAdapter

Stops the TGO data source batching mode.

Specified by:

dataSourceEndBatch in class IlpAbstractSDMAdapter

dataSourceRemoveObject

protected void dataSourceRemoveObject(IlpObject object)

Description copied from class: IlpAbstractSDMAdapter

Removes an object from the TGO data source.

Specified by:

dataSourceRemoveObject in class IlpAbstractSDMAdapter

Parameters:

object - The object to be removed

dataSourceSetLink

protected void dataSourceSetLink(IlpObject link,
                                 Object fromId,
                                 Object toId)

Description copied from class: IlpAbstractSDMAdapter

Sets the link endpoint relationship between a link and two nodes in the TGO data source.

Specified by:

dataSourceSetLink in class IlpAbstractSDMAdapter

Parameters:

link - The link being set

fromId - The identifier of the from endpoint

toId - The identifier of the to endpoint

dataSourceSetParent

protected void dataSourceSetParent(IlpObject object,
                                   IlpObject parent)

Description copied from class: IlpAbstractSDMAdapter

Sets a parent-child relationship in the TGO data source.

Specified by:

dataSourceSetParent in class IlpAbstractSDMAdapter

Parameters:

object - The child object

parent - The parent object

dataSourceStartBatch

protected void dataSourceStartBatch()

Description copied from class: IlpAbstractSDMAdapter

Starts the TGO data source batching mode.

Specified by:

dataSourceStartBatch in class IlpAbstractSDMAdapter

addDefaultBindings

public void addDefaultBindings()
                        throws IlpInvalidBindingException

Applies a default set of attribute bindings to this adapter.

By default, there are no attribute bindings applied to the adapter, so that no TGO attribute is mapped to an SDM property. This method sets up default bindings for the following predefined TGO attributes:

• IltObject.NameAttribute: Read and write
• IltObject.PositionAttribute: Read and write (excludes geographic position)
• IltNetworkElement.TypeAttribute: Read only
• IltLink.TypeAttribute: Read only
• IltCard.TypeAttribute: Read only
• IltObject.NewAlarmCountAttribute: Read only

This method can be overridden in order to provide easy access to custom bindings.

Attribute bindings are not allowed when the adapter is representing (IlpAbstractSDMAdapter.isRepresenting() is true).

Throws:

IlpInvalidBindingException - when the adapter is currently representing objects from a data source.