ilog.cpl.graph

Interface IlpNodeHandler

All Known Subinterfaces:

IlpEquipmentHandler, IlpGraphHandler, IlpNetworkEditingHandler, IlpNetworkHandler, IlpNetworkObjectHandler

All Known Implementing Classes:

IlpAbstractGraphHandler, IlpEquipmentHandlerWithDataSource, IlpEquipmentHandlerWithoutDataSource, IlpGraphHandlerWithDataSource, IlpGraphHandlerWithoutDataSource, IlpNetworkHandlerWithDataSource, IlpNetworkHandlerWithoutDataSource

public interface IlpNodeHandler

This interface allows a handler to customize the creation of new representation objects and the deletion of representation objects. Such requests are typically triggered through interactors.

Since:

JTGO 4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINK_FROM_NODE The fromNodeproperty in a request to create an IlpRepresentationLink.
static String	LINK_FROM_PORT The fromPort property in a request to create an IlpRepresentationLink.
static String	LINK_TO_NODE The toNode property in a request to create an IlpRepresentationLink.
static String	LINK_TO_PORT The toPort property in a request to create an IlpRepresentationLink.

Method Summary

Modifier and Type	Method and Description
void	handleChangeRelationship(IlpRepresentationObject object, IlpRepresentationObject parent, IlpPosition position) Requests the change in relationship of an object.
void	handleCloneObject(Collection<? extends IlpRepresentationNode> objects) Requests the creation of a set of copied objects.
Object	handleCreateObject(Class<?> clazz, IlpAttributeGroup attributes, Map<String,Object> properties, IlpPosition position) Requests the creation of an object belonging to a given class, with a set of attributes, and with a given position.
void	handleRemoveObject(Collection<? extends IlpRepresentationNode> objects) Requests the deletion of a set of objects.
void	handleUpdateObject(IlpRepresentationObject object, Map newValues) Requests the change of some properties of an object.

Field Detail

LINK_FROM_NODE

static final String LINK_FROM_NODE

The fromNodeproperty in a request to create an IlpRepresentationLink.

See Also:

Constant Field Values

LINK_TO_NODE

static final String LINK_TO_NODE

The toNode property in a request to create an IlpRepresentationLink.

See Also:

Constant Field Values

LINK_FROM_PORT

static final String LINK_FROM_PORT

The fromPort property in a request to create an IlpRepresentationLink.

This property has a value of type IltLinkPort and is optional.

See Also:

Constant Field Values

LINK_TO_PORT

static final String LINK_TO_PORT

The toPort property in a request to create an IlpRepresentationLink.

This property has a value of type IltLinkPort and is optional.

See Also:

Constant Field Values

Method Detail

handleCreateObject

Object handleCreateObject(Class<?> clazz,
                          IlpAttributeGroup attributes,
                          Map<String,Object> properties,
                          IlpPosition position)

Requests the creation of an object belonging to a given class, with a set of attributes, and with a given position.

The handler will:

• Create a new representation object and add it to the model, or
• Create a new temporary representation object and add it to the model. The handler will then ask the adapter to load a business model object corresponding to this representation object. The adapter will connect this business object to the representation object, or
• Ignore the request.

Parameters:

clazz - An implementation of IlpRepresentationNode.

attributes - A set of attributes for the object to be created, or null.

properties - A set of hints for the object to be created, or null.

position - The desired position/shape of the object, or null.

Returns:

Identifier of the object that has been created

handleRemoveObject

void handleRemoveObject(Collection<? extends IlpRepresentationNode> objects)

Requests the deletion of a set of objects.

The handler will:

• Remove the objects from the model, or
• Ask the adapter to remove the objects and their corresponding business objects, or
• Ignore the request.

Parameters:

objects - A collection of IlpRepresentationNodes.

handleUpdateObject

void handleUpdateObject(IlpRepresentationObject object,
                        Map newValues)

Requests the change of some properties of an object.

Parameters:

object - The representation object.

newValues - A map, mapping each IlpAttribute to be changed to its new values.

handleCloneObject

void handleCloneObject(Collection<? extends IlpRepresentationNode> objects)

Requests the creation of a set of copied objects.

Parameters:

objects - A collection of IlpRepresentationNodes.

handleChangeRelationship

void handleChangeRelationship(IlpRepresentationObject object,
                              IlpRepresentationObject parent,
                              IlpPosition position)

Requests the change in relationship of an object.

Parameters:

object - The representation object.

parent - The new parent of the object; null implies a root object.

position - The position of the object.