ilog.ds.sdm
Interface IlSDMDataSourceEditor

All Superinterfaces:

IlDataSourceEditor

All Known Implementing Classes:

IlsSDMDataSource

public interface IlSDMDataSourceEditor

extends IlDataSourceEditor

SDM data source editor. Note that the dereferencing is missing.

Method Summary

abstract java.lang.Object	dsAddLink(java.lang.String tag, java.lang.Object parent, java.lang.Object from, java.lang.Object to, java.util.Map properties) Creates a new link in the SDM model of logical type tag.
abstract java.lang.Object	dsAddNode(java.lang.String tag, java.lang.Object parent, java.util.Map properties) Creates a new node in the SDM model of logical type tag.
abstract void	dsRemoveLink(java.lang.Object link) Removes a link from the sdm model.
abstract void	dsRemoveNode(java.lang.Object node) Removes a node from the SDM model.
abstract void	dsUpdateLink(java.lang.Object link, java.lang.String propertyName, java.lang.Object propertyValue) Updates a property of a link
abstract void	dsUpdateNode(java.lang.Object node, java.lang.String propertyName, java.lang.Object propertyValue) Updates a property of a node.
abstract boolean	isLinkEditable(java.lang.Object link) Returns false if the link is read-only.
abstract boolean	isNodeEditable(java.lang.Object node) Returns false if the node is read-only.

Methods inherited from interface ilog.ds.IlDataSourceEditor

dsEndBatch, dsStartBatch, dsUpdateProperty, getDSBatchLevel, isEditable

Method Detail

isNodeEditable

public boolean isNodeEditable(java.lang.Object node)

Returns false if the node is read-only.

Parameters:

node - The node to test.

dsAddNode

public java.lang.Object dsAddNode(java.lang.String tag,
                                  java.lang.Object parent,
                                  java.util.Map properties)

Creates a new node in the SDM model of logical type tag.

Parameters:

tag - The node's logical type.

parent - The parent to which the new node is added, may be null

properties - The properties of the node to create

Returns:

the created node (to be used only as a key). Note that this method may return null if the node takes a long time to be created.

dsRemoveNode

public void dsRemoveNode(java.lang.Object node)

Removes a node from the SDM model.

Parameters:

node - The node to be removed

dsUpdateNode

public void dsUpdateNode(java.lang.Object node,
                         java.lang.String propertyName,
                         java.lang.Object propertyValue)

Updates a property of a node.

Parameters:

node - The node to update

propertyName - The name of the property to be updated

propertyValue - The new value of the property

isLinkEditable

public boolean isLinkEditable(java.lang.Object link)

Returns false if the link is read-only.

Parameters:

link - The link to test.

dsAddLink

public java.lang.Object dsAddLink(java.lang.String tag,
                                  java.lang.Object parent,
                                  java.lang.Object from,
                                  java.lang.Object to,
                                  java.util.Map properties)

Creates a new link in the SDM model of logical type tag.

Parameters:

tag - The link's logical type.

parent - The parent to which the new link is added, may be null

from - The origin node of the link, may be null

to - The target node of the link, may be null

properties - The properties of the link to create

Returns:

the created link (to be used only as a key). Note that this method may return null if the link takes a long time to be created.

dsRemoveLink

public void dsRemoveLink(java.lang.Object link)

Removes a link from the sdm model.

Parameters:

link - The link to be removed

dsUpdateLink

public void dsUpdateLink(java.lang.Object link,
                         java.lang.String propertyName,
                         java.lang.Object propertyValue)

Updates a property of a link

Parameters:

link - The link to update

propertyName - The name of the property to be updated

propertyValue - The new value of the property