ilog.cpl.graph

Class IlpAbstractNodeAdapter

java.lang.Object

ilog.cpl.datasource.IlpAbstractAdapter

ilog.cpl.datasource.IlpAbstractHierarchyAdapter

ilog.cpl.graph.IlpAbstractNodeAdapter

All Implemented Interfaces:

DataSourceListener, IlpRepresentationObjectMapper, EventListener

Direct Known Subclasses:

IlpEquipmentAdapter, IlpNetworkAdapter

public abstract class IlpAbstractNodeAdapter
extends IlpAbstractHierarchyAdapter

Abstract node adapter for representing hierarchies of objects.

Since:

JTGO 3.0

See Also:

IlpDataSourceLoggers.ilog_cpl_datasource_adapter

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_BREADTH_FIRST_THRESHOLD This parameter is used by the adapter to identify the algorithm that should be used when refiltering objects.

Constructor Summary

Constructors

Constructor and Description
IlpAbstractNodeAdapter() Default constructor.
IlpAbstractNodeAdapter(IlpContext context) Constructor for a given context.

Method Summary

Modifier and Type	Method and Description
protected IlpBusinessObjectCustomization	applyObjectCustomization(IlpObject ilpObject) Applies the current customization to the given object.
protected void	clearRepresentationObjects() Removes all objects created by this adapter
void	clearTemporaryRepresentationObjects() Clears all the temporary objects.
protected abstract IlpRepresentationLink	createLink(IlpObject ilpObject, IlpRepresentationNode fromNode, IlpRepresentationNode toNode) Creates a representation link object from a given business object.
protected abstract IlpRepresentationNode	createNode(IlpObject ilpObject) Creates a representation node object from a given business object.
protected IlpRepresentationObject	createRepresentationObject(IlpObject ilpObject) Creates a representation object and stores it in the identifier-to-RO map.
protected void	customizeAllObjects() Apply CSS configuration to all objects.
protected void	customizeObject(IlpObject object) This method is automatically called by createExpansionStrategy to guarantee that every new object (or updated) is customized before being added to this adapter.
protected void	fillModel() Fills the model with the representation object.
protected IlpExpansionType	getDefaultExpansionType(IlpObject ilpObject) This internal method returns the default expansion type, which is IlpExpansionType.NO_EXPANSION.
IlpExpansionType	getExpansionType(IlpObject ilpObject) Retrieves the expansion type of a given business object.
int	getPendingLinksCount() Returns the number of pending links.
IlpAttribute	getPositionAttribute(IlpClass clazz) Returns the position attribute of an IlpClass.
IlpAttribute	getPositionAttribute(IlpObject object) Returns the position attribute for an object.
protected IlpMutableGraphModel	getRepresentationModel() Returns the network model.
IlpRepresentationNode	getRepresentationNode(IlpObject ilpObject) Returns the node representing the IlpObject.
IlpRepresentationNode	getRepresentationNode(Object identifier) Returns the node representing the IlpObject identified by identifier.
boolean	hasModel() Returns true if the adapter is connected to a model.
boolean	hasTemporaryRepresentationObject(IlpRepresentationNode node) Informs whether a representation node is temporary or not.
protected void	initializeExcludedClasses() Initializes the predefined list of excluded classes.
boolean	isPendingLink(Object id) Returns if the given identifier corresponds to a pending link.
void	loadChildren(IlpRepresentationObject representation) Initiates the loading of the child objects of the given object, if they are not all already present.
void	objectAttributeChanged(DataSourceObjectEvent e) Called when an object structure has changed.
void	objectsAdded(DataSourceEvent evt) Called when an object has been added to the data source.
void	objectsRemoved(DataSourceEvent evt) Called when an object has been removed from the data source.
void	objectStructureChanged(DataSourceObjectEvent evt) Called when an object structure has changed.
protected void	refilterObjects() Reapplies the filter to the objects that exist in the attached data source.
void	releaseChildren(IlpRepresentationObject representation) Signals that the model and the attached views do not need the child objects of the given object anymore.
protected IlpRepresentationObject	removeRepresentation(Object id) Removes the representation object that corresponds to the given identifier.
void	removeTemporaryRepresentationObject(IlpRepresentationNode node) Remove a temporary object.
void	setPositionAttribute(IlpClass clazz, IlpAttribute attribute) Sets the position attribute used by objects belonging to the given business object class.
protected void	setRepresentationModel(IlpMutableGraphModel newmodel) Sets the network model.
void	storeTemporaryRepresentationObject(IlpRepresentationNode node, IlpMutableRepresentationNode parent, IlpFilter boFilter) Stores a temporary object along with a filter to detect the corresponding business object.

Methods inherited from class ilog.cpl.datasource.IlpAbstractHierarchyAdapter

createExpansionStrategy, doApplyConfiguration, getAcceptedClasses, getExpansionStrategyFactory, getOrigins, getPossibleRoots, getRoots, hasConfigurationChanged, initializeAcceptedClasses, isEmptyOrigins, isOrigin, isShowingOrigin, replaceAcceptedClasses, resetOrigins, setAcceptedClasses, setExpansionStrategyFactory, setExpansionType, setOrigins, testObject, testRootObject

Methods inherited from class ilog.cpl.datasource.IlpAbstractAdapter

addAdapterListener, addPropertyChangeListener, addPropertyChangeListener, addRepresentation, applyConfiguration, batchEnded, batchStarted, beginRepresentation, clearIdToRepresentationObjectMap, endBatch, firePropertyChange, fireRepresentationObjectsAdded, fireRepresentationObjectsRemoved, getContext, getDataSource, getExcludedClasses, getFilter, getRepresentationObject, getRepresentationObject, getRepresentationObjects, getSyncStrategy, hasRepresentationObject, hasRepresentationObjects, initializeRepresentationObjects, isRepresenting, refilter, removeAdapterListener, removePropertyChangeListener, removePropertyChangeListener, replaceExcludedClasses, setBatchable, setDataSource, setExcludedClasses, setFilter, startBatch, stopRepresentation

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_BREADTH_FIRST_THRESHOLD

public static int FILTER_BREADTH_FIRST_THRESHOLD

This parameter is used by the adapter to identify the algorithm that should be used when refiltering objects.

If the threshold is set to -1, breadth-first is always applied no matter the number of objects that are currently present in this datasource.

If the number of objects in the datasource is below the given threshold, the refiltering is applied through a breadth-first algorithm. If the number of objects is above the given threshold, the refiltering is applied by removing and recreating the objects.

Since:

JTGO 4.0

Constructor Detail

IlpAbstractNodeAdapter

public IlpAbstractNodeAdapter()

Default constructor.

An adapter built this way will use the IlpChild and IlpContainer interfaces.

IlpAbstractNodeAdapter

public IlpAbstractNodeAdapter(IlpContext context)

Constructor for a given context.

An adapter built this way will use the IlpChild and IlpContainer interfaces.

Parameters:

context - The context used by this adapter.

Method Detail

getExpansionType

public IlpExpansionType getExpansionType(IlpObject ilpObject)

Description copied from class: IlpAbstractHierarchyAdapter

Retrieves the expansion type of a given business object.

Compatibility Note: In JViews 8.0, ilog.cpl.model.IlpObject.ExpansionType has been replaced by IlpExpansionType.

Overrides:

getExpansionType in class IlpAbstractHierarchyAdapter

Parameters:

ilpObject - The business object containing the expansion type.

Returns:

The expansion type for this object.

getDefaultExpansionType

protected IlpExpansionType getDefaultExpansionType(IlpObject ilpObject)

This internal method returns the default expansion type, which is IlpExpansionType.NO_EXPANSION. This value is overridden by the value in expansionType structure (or, the value set through the API).

Parameters:

ilpObject - The business object.

Since:

JViews 8.1

Internal: do not use!

getRepresentationNode

public IlpRepresentationNode getRepresentationNode(IlpObject ilpObject)

Returns the node representing the IlpObject.

getRepresentationNode

public IlpRepresentationNode getRepresentationNode(Object identifier)

Returns the node representing the IlpObject identified by identifier.

createNode

protected abstract IlpRepresentationNode createNode(IlpObject ilpObject)

Creates a representation node object from a given business object.

This method returns a representation object that is not a link.

Parameters:

ilpObject - The business object

Returns:

The representation node corresponding to the given business object.

createLink

protected abstract IlpRepresentationLink createLink(IlpObject ilpObject,
                                                    IlpRepresentationNode fromNode,
                                                    IlpRepresentationNode toNode)

Creates a representation link object from a given business object.

Parameters:

ilpObject - The business object.

fromNode - The from endpoint for the link.

toNode - The to endpoint for the link.

Returns:

The representation link corresponding to the given business object.

isPendingLink

public boolean isPendingLink(Object id)

Returns if the given identifier corresponds to a pending link.

Parameters:

id - Object identifier

Returns:

true if the object is a pending link.

Since:

JViews 7.5

Internal: do not use!

getPendingLinksCount

public int getPendingLinksCount()

Returns the number of pending links.

Returns:

Number of pending links

Internal: do not use!

initializeExcludedClasses

protected void initializeExcludedClasses()

Initializes the predefined list of excluded classes. In general, this list is empty. This method is overridden in subclasses if the specific adapter does not handle some predefined classes.

By default, alarm objects (ilog.tgo.model.IltAlarm) are not displayed in the graph model.

Overrides:

initializeExcludedClasses in class IlpAbstractAdapter

refilterObjects

protected void refilterObjects()

Reapplies the filter to the objects that exist in the attached data source.

The default implementation performs a breadth-first search on the representation nodes. It tests each node that is currently displayed against the new filter criteria. The worst case performance of the algorithm is o(n), where n is the number of objects in the data source.

If the number of objects present in the attached data source is large, the performance of this algorithm may not be good. In this case, instead of performing a systematic breadth-first search, you can configure the threshold of the breadth-first algorithm.

Overrides:

refilterObjects in class IlpAbstractAdapter

Since:

JTGO 4.0

See Also:

FILTER_BREADTH_FIRST_THRESHOLD

getPositionAttribute

public IlpAttribute getPositionAttribute(IlpClass clazz)

Returns the position attribute of an IlpClass.

Since:

JTGO 3.0

getPositionAttribute

public IlpAttribute getPositionAttribute(IlpObject object)

Returns the position attribute for an object.

Since:

JTGO 3.0

setPositionAttribute

public void setPositionAttribute(IlpClass clazz,
                                 IlpAttribute attribute)

Sets the position attribute used by objects belonging to the given business object class.

storeTemporaryRepresentationObject

public void storeTemporaryRepresentationObject(IlpRepresentationNode node,
                                               IlpMutableRepresentationNode parent,
                                               IlpFilter boFilter)

Stores a temporary object along with a filter to detect the corresponding business object.

Parameters:

node - Temporary representation object. It has to implement IlpRepresentationNode.

parent - The parent of the temporary representation object. May be null.

boFilter - The filter that is applied to the business object to find out if the temporary representation object is to be replaced by a "real" one representing the first IlpObject that matches the filter.

Throws:

IllegalStateException - If the adapter does not have a model.

removeTemporaryRepresentationObject

public void removeTemporaryRepresentationObject(IlpRepresentationNode node)

Remove a temporary object.

Parameters:

node - The temporary representation object to remove.

Since:

JTGO 3.1

clearTemporaryRepresentationObjects

public void clearTemporaryRepresentationObjects()

Clears all the temporary objects. All temporary objects are removed from the model.

Since:

JTGO 3.1

hasTemporaryRepresentationObject

public boolean hasTemporaryRepresentationObject(IlpRepresentationNode node)

Informs whether a representation node is temporary or not.

createRepresentationObject

protected IlpRepresentationObject createRepresentationObject(IlpObject ilpObject)

Creates a representation object and stores it in the identifier-to-RO map.

The resulting object will be instance of IlpRepresentationNode.

Specified by:

createRepresentationObject in class IlpAbstractAdapter

Internal: do not use!

clearRepresentationObjects

protected void clearRepresentationObjects()

Removes all objects created by this adapter

Specified by:

clearRepresentationObjects in class IlpAbstractAdapter

removeRepresentation

protected IlpRepresentationObject removeRepresentation(Object id)

Description copied from class: IlpAbstractAdapter

Removes the representation object that corresponds to the given identifier.

Overrides:

removeRepresentation in class IlpAbstractHierarchyAdapter

Parameters:

id - Object identifier

fillModel

protected void fillModel()

Fills the model with the representation object. This method is called only when there is a model.

Specified by:

fillModel in class IlpAbstractAdapter

Internal: do not use!

loadChildren

public void loadChildren(IlpRepresentationObject representation)

Initiates the loading of the child objects of the given object, if they are not all already present. The child objects can be added asynchronously.

Specified by:

loadChildren in class IlpAbstractHierarchyAdapter

Parameters:

representation - Container representation object

See Also:

IlpExpansionStrategy.loadChildren(ilog.cpl.model.IlpRepresentationObject)

releaseChildren

public void releaseChildren(IlpRepresentationObject representation)

Signals that the model and the attached views do not need the child objects of the given object anymore. The child objects can be removed (but need not be) from working memory.

Specified by:

releaseChildren in class IlpAbstractHierarchyAdapter

Parameters:

representation - Container representation object

See Also:

IlpExpansionStrategy.releaseChildren(ilog.cpl.model.IlpRepresentationObject)

applyObjectCustomization

protected IlpBusinessObjectCustomization applyObjectCustomization(IlpObject ilpObject)

Applies the current customization to the given object.

Parameters:

ilpObject - Business object

Returns:

Customization object or null if customization is not available.

Since:

JViews 7.5

Internal: do not use!

customizeObject

protected void customizeObject(IlpObject object)

This method is automatically called by createExpansionStrategy to guarantee that every new object (or updated) is customized before being added to this adapter.

Specified by:

customizeObject in class IlpAbstractHierarchyAdapter

Parameters:

object - The object to be customized.

Since:

JTGO 4.0

Internal: do not use!

customizeAllObjects

protected void customizeAllObjects()

Apply CSS configuration to all objects. This method should be called whenever a new style sheet is applied.

The method will check for changes in the expansion type of each object represented by this adapter. In case of change, the object will be removed and recreated.

Overrides:

customizeAllObjects in class IlpAbstractHierarchyAdapter

Since:

JTGO 4.0

Internal: do not use!

objectsAdded

public void objectsAdded(DataSourceEvent evt)

Called when an object has been added to the data source.

objectsRemoved

public void objectsRemoved(DataSourceEvent evt)

Called when an object has been removed from the data source.

objectAttributeChanged

public void objectAttributeChanged(DataSourceObjectEvent e)

Called when an object structure has changed.

objectStructureChanged

public void objectStructureChanged(DataSourceObjectEvent evt)

Called when an object structure has changed.

getRepresentationModel

protected IlpMutableGraphModel getRepresentationModel()

Returns the network model.

This is a bound property.

Returns:

The model where the adapter puts the representation objects.

Internal: do not use!

setRepresentationModel

protected void setRepresentationModel(IlpMutableGraphModel newmodel)

Sets the network model.

This is a bound property.

Parameters:

newmodel - The model where the adapter will put representation objects.

Internal: do not use!

hasModel

public boolean hasModel()

Returns true if the adapter is connected to a model.

Specified by:

hasModel in class IlpAbstractAdapter