ilog.cpl.model.container

Interface IlpRepresentationNode

All Superinterfaces:

IlpAttributeValueHolder, IlpRepresentationObject

All Known Subinterfaces:

IlpEquipmentLink, IlpEquipmentNode, IlpMutableEquipmentLink, IlpMutableEquipmentNode, IlpMutableNetworkLink, IlpMutableNetworkNode, IlpMutableRepresentationLink, IlpMutableRepresentationNode, IlpNetworkLink, IlpNetworkNode, IlpRepresentationLink

All Known Implementing Classes:

IlpAbstractRepresentationLink, IlpAbstractRepresentationNode, IlpDefaultEquipmentLink, IlpDefaultEquipmentNode, IlpDefaultNetworkLink, IlpDefaultNetworkNode

public interface IlpRepresentationNode
extends IlpRepresentationObject

Objects implementing this interface build up a container hierarchy. Each such object may be a container and have child objects, and each such object can have a parent object.

This class is used by the network model and the equipment model.

Since:

JTGO 3.0

See Also:

IlpGraphModel

Field Summary

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

VALUE_NOT_SET

Method Summary

Modifier and Type	Method and Description
void	addRepresentationNodeListener(RepresentationNodeListener listener) Adds a listener that is notified each time a change to this container occurs.
boolean	getAllowsChildren() Returns true if this node allows children.
List<IlpRepresentationNode>	getChildren() Returns a list of the child objects of this object.
IlpExpansionStrategy	getExpansionStrategy() Returns the child object loader that was passed to this object at construction time.
IlpRepresentationNode	getParent() Returns the parent object of this object.
boolean	isLeaf() Returns true if this object, by its nature, has no children.
void	removeRepresentationNodeListener(RepresentationNodeListener listener) Removes a listener previously added with addRepresentationNodeListener(ilog.cpl.model.container.RepresentationNodeListener).

Methods inherited from interface ilog.cpl.model.IlpRepresentationObject

getEditor, getIlpObject

Methods inherited from interface ilog.cpl.model.IlpAttributeValueHolder

addAttributeValueListener, fireEvent, getAttributeGroup, getAttributeValue, getAttributeValue, hasAttributeValue, removeAttributeValueListener, setAttributeValue, setAttributeValue

Method Detail

isLeaf

boolean isLeaf()

Returns true if this object, by its nature, has no children. When this method returns false, there may or may not be some children attached to the object; children can be added or removed dynamically.

Note: The result of this method must not change while this node is (directly or indirectly) accessible in an IlpGraphModel.

getChildren

List<IlpRepresentationNode> getChildren()

Returns a list of the child objects of this object.

Note: The order of this list is important as follows:

• It is reflected in the indices in RepresentationNodeEvent events, which indicate the children added (after addition) or removed (before removal).
• If the representation object is a link bundle, the first child in the list will be the leftmost link displayed, and the last child in the list will be the rightmost link displayed.

Returns:

An unmodifiable List of IlpRepresentationNode

addRepresentationNodeListener

void addRepresentationNodeListener(RepresentationNodeListener listener)

Adds a listener that is notified each time a change to this container occurs.

removeRepresentationNodeListener

void removeRepresentationNodeListener(RepresentationNodeListener listener)

Removes a listener previously added with addRepresentationNodeListener(ilog.cpl.model.container.RepresentationNodeListener).

getParent

IlpRepresentationNode getParent()

Returns the parent object of this object.

Note: The result of this method must not change while this node is (directly or indirectly) accessible in an IlpGraphModel.

getAllowsChildren

boolean getAllowsChildren()

Returns true if this node allows children.

getExpansionStrategy

IlpExpansionStrategy getExpansionStrategy()

Returns the child object loader that was passed to this object at construction time. This is a convenience function used by the adapters.