ilog.cpl.datasource

Interface IlpDataSource

All Known Subinterfaces:

IlpMutableDataSource

All Known Implementing Classes:

IlpAbstractDataSource, IlpDefaultDataSource, IltDefaultDataSource

public interface IlpDataSource

Interface of data sources. A data source contains a number of IlpObjects. A data source notifies its listener when an object gets inserted or removed.

Since:

JTGO 3.0

Method Summary

Modifier and Type	Method and Description
void	addDataSourceListener(DataSourceListener l) Adds a listener to the data source.
IlpChild	getChildInterface(Object childIdOrIlpObject) Returns the child interface corresponding to an object.
IlpContainer	getContainerInterface(Object containerIdOrIlpObject) Returns the container interface corresponding to an object.
IlpContext	getContext() Returns the context used by this data source.
IlpLinkExtremity	getLinkExtremityInterface(Object linkIdOrIlpObject) Returns the link extremity interface corresponding to an object.
IlpLink	getLinkInterface(Object linkIdOrIlpObject) Returns the link interface corresponding to an object.
IlpObject	getObject(Object identifier) Returns the IlpObject corresponding to an identifier.
Collection<IlpObject>	getObjects() Returns the objects contained by the data source in a Collection.
List<IlpObject>	getRootObjects() Returns the objects that have no parent information in the data source.
void	removeDataSourceListener(DataSourceListener l) Removes a listener of the data source.

Method Detail

addDataSourceListener

void addDataSourceListener(DataSourceListener l)

Adds a listener to the data source.

Parameters:

l - The listener to add.

removeDataSourceListener

void removeDataSourceListener(DataSourceListener l)

Removes a listener of the data source.

Parameters:

l - The listener to remove.

getContainerInterface

IlpContainer getContainerInterface(Object containerIdOrIlpObject)

Returns the container interface corresponding to an object.

Parameters:

containerIdOrIlpObject - The identifier of the object or the object itself that may be a container.

Returns:

The corresponding container interface. May be null.

getChildInterface

IlpChild getChildInterface(Object childIdOrIlpObject)

Returns the child interface corresponding to an object.

Parameters:

childIdOrIlpObject - The identifier of the object or the object itself that may be a child.

Returns:

The corresponding child interface. May be null.

getLinkInterface

IlpLink getLinkInterface(Object linkIdOrIlpObject)

Returns the link interface corresponding to an object.

Parameters:

linkIdOrIlpObject - The identifier of the object or the object itself that may be a link.

Returns:

The corresponding link interface. May be null.

getLinkExtremityInterface

IlpLinkExtremity getLinkExtremityInterface(Object linkIdOrIlpObject)

Returns the link extremity interface corresponding to an object.

Parameters:

linkIdOrIlpObject - The identifier of the object or the object itself that may be a link extremity.

Returns:

The corresponding link extremity interface. May be null.

getObject

IlpObject getObject(Object identifier)

Returns the IlpObject corresponding to an identifier.

Parameters:

identifier - The identifier.

Returns:

The IlpObject corresponding to the identifier. May be null if there is no corresponding IlpObject.

getObjects

Collection<IlpObject> getObjects()

Returns the objects contained by the data source in a Collection.

Returns:

A set containing the IlpObjects of the data source.

getRootObjects

List<IlpObject> getRootObjects()

Returns the objects that have no parent information in the data source.

Returns:

A set containing the root IlpObjects of the data source.

Since:

JViews 8.5

getContext

IlpContext getContext()

Returns the context used by this data source.