ilog.cpl.graph

Class IlpDefaultNodeExpansionStrategyFactory

java.lang.Object

ilog.cpl.graph.IlpDefaultNodeExpansionStrategyFactory

All Implemented Interfaces:

IlpExpansionStrategyFactory

public class IlpDefaultNodeExpansionStrategyFactory
extends Object
implements IlpExpansionStrategyFactory

This class models a default expansion strategy factory for both network and equipment components.

This factory returns specific expansion strategies according to the value of the CSS property expansion in the different business objects. Expansion strategies are shared among all objects with a certain expansion type.

By default, the following expansion types are supported:

• IN_PLACE: loads all the children objects present in the datasource. They are visible according to the filter criteria.
• IN_PLACE_MINIMAL_LOADING: loads only the direct children objects present in the datasource. They are visible according to the filter criteria. With this expansion strategy, the objects are loaded according to the view requests when objects are expanded.
• NO_EXPANSION: object cannot be expanded, even when there are children objects in the datasource.

Since:

JTGO 4.0

See Also:

IlpAbstractNodeAdapter, IlpAbstractHierarchyAdapter.setExpansionStrategyFactory(ilog.cpl.util.IlpExpansionStrategyFactory)

Field Summary

Fields

Modifier and Type	Field and Description
protected IlpExpansionStrategy	inPlaceExpansionStrategy Expansion strategy for IN_PLACE expansion.
protected IlpExpansionStrategy	inPlaceMinimalLoadingExpansionStrategy Expansion strategy that loads each level at a time.

Fields inherited from interface ilog.cpl.util.IlpExpansionStrategyFactory

DEFAULT

Constructor Summary

Constructors

Constructor and Description
IlpDefaultNodeExpansionStrategyFactory(IlpAbstractNodeAdapter adapter) Creates an expansion strategy factory for the given adapter.

Method Summary

Modifier and Type	Method and Description
IlpExpansionStrategy	create(IlpObject ilpObject) Creates an expansion strategy to be used by the representation object that corresponds to the given business object.
IlpAbstractNodeAdapter	getAdapter() Returns the adapter that is associated with this expansion strategy factory.

Methods inherited from class java.lang.Object

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

Field Detail

inPlaceExpansionStrategy

protected IlpExpansionStrategy inPlaceExpansionStrategy

Expansion strategy for IN_PLACE expansion.

inPlaceMinimalLoadingExpansionStrategy

protected IlpExpansionStrategy inPlaceMinimalLoadingExpansionStrategy

Expansion strategy that loads each level at a time.

Constructor Detail

IlpDefaultNodeExpansionStrategyFactory

public IlpDefaultNodeExpansionStrategyFactory(IlpAbstractNodeAdapter adapter)

Creates an expansion strategy factory for the given adapter.

Since:

JTGO 4.0

Method Detail

getAdapter

public IlpAbstractNodeAdapter getAdapter()

Returns the adapter that is associated with this expansion strategy factory.

Since:

JTGO 4.0

create

public IlpExpansionStrategy create(IlpObject ilpObject)

Creates an expansion strategy to be used by the representation object that corresponds to the given business object.

An expansion strategy defines how the representation object behaves in the component when it is collapsed or expanded.

This method returns a predefined expansion strategy according to the object expansion type:

• IN_PLACE: returns an expansion strategy which loads in the representation model all the nodes that are present in this object containment subtree and that are visible according to the filter criteria.
• IN_PLACE_MINIMAL_LOADING: returns an expansion strategy which loads in the representation model only its direct children objects that are visible according to the filter criteria. With this expansion strategy, the objects are loaded according to the view requests when objects are expanded.
• NO_EXPANSION: object cannot be expanded, even when there are children objects in the datasource.

The business object expansion type is customized in the adapter using Cascading Style Sheets (CSS). The following example illustrates this customization:

     object {
       expansion: IN_PLACE;
     }
 

Expansion strategies are shared among business objects that share the same expansion type.

Specified by:

create in interface IlpExpansionStrategyFactory

Parameters:

ilpObject - Business object

Since:

JTGO 4.0

See Also:

IlpAbstractNodeAdapter.getExpansionType(ilog.cpl.model.IlpObject), IlpNetworkAdapter.setStyleSheets(java.lang.String[]), IlpEquipmentAdapter.setStyleSheets(java.lang.String[]), IlpExpansionType, IlpExpansionStrategy