ilog.views.sdm.model

Class IlvMultipleSDMModel

java.lang.Object

ilog.views.sdm.model.IlvBasicSDMModel

ilog.views.sdm.model.IlvMultipleSDMModel

All Implemented Interfaces:

SDMModelListener, SDMPropertyChangeListener, IlvSDMModel, Serializable, EventListener

Direct Known Subclasses:

IlvJDBCSDMModel

public class IlvMultipleSDMModel
extends IlvBasicSDMModel
implements SDMModelListener, SDMPropertyChangeListener

The class IlvMultipleSDMModel lets you combine several SDM models (called the "submodels") into a single one. It is especially useful when used with the IlvTableSDMModel, when you need to combine several tables into one SDM model.

The multiple model will delegate most of its calls to the submodel to which an object belongs. To determine the owner model for each object, it will call the getModel(java.lang.Object) method. The default implementation uses a hash map to store the submodel to which an object belongs. This default implementation may not be very efficient, so it is recommended, if possible, to write a subclass and override the getModel(java.lang.Object) and setModel(java.lang.Object, ilog.views.sdm.IlvSDMModel) methods with a more efficient implementation (for example, storing the model in a member variable of the data object).

The multiple model can resolve intermodel links, that is, links contained in a submodel and connecting nodes in other submodels. For such links to work, the submodel containing the intermodel links must implement the IlvInterModelLinks interface. Then the source and destination nodes of links can be resolved by querying their IDs and searching for the nodes globally in all the submodels.

Since:

JViews 6.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IlvMultipleSDMModel.OwnedObject This interface can be implemented by nodes and links contained in models that are combined using an IlvMultipleSDMModel.

Constructor Summary

Constructors

Constructor and Description
IlvMultipleSDMModel() Creates a new multiple model with no submodels.
IlvMultipleSDMModel(IlvSDMModel[] models) Creates a new multiple model that combines the specified submodels.

Method Summary

Modifier and Type	Method and Description
void	addModel(IlvSDMModel model) Adds a submodel at the end of the list.
void	addModel(IlvSDMModel model, int index) Adds a submodel at a specified position.
void	addObject(Object object, Object parent, Object before) This call is delegated to the submodel returned by getModel(java.lang.Object).
void	adjustmentFinished(SDMModelEvent event) This method is called at the end of an adjustment sequence on the underlying filtered model.
void	clear() Clears all the submodels.
Object	createLink(String tag) This method returns null, because it is not possible in general to know which submodel must be called to create the new object.
Object	createNode(String tag) This method returns null, because it is not possible in general to know which submodel must be called to create the new object.
void	dataChanged(SDMModelEvent event) This method is called when the contents of a submodel are changed.
Enumeration	getChildren(Object parent) This call is delegated to the submodel returned by getModel(java.lang.Object).
Object	getFrom(Object link) This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method first queries the source node's ID by calling IlvInterModelLinks.getFromID(java.lang.Object), then it searches for the source node in all the submodels by calling getObject(java.lang.String).
String	getID(Object obj) This call is delegated to the submodel returned by getModel(java.lang.Object).
String	getIDImpl(Object obj) This method calls getID(java.lang.Object).
protected IlvSDMModel	getModel(Object obj) This method determines the model to which an object belongs.
IlvSDMModel[]	getModels() Returns the submodels that this multiple model combines.
Object	getObject(String id) Finds the object with the specified ID in all the submodels.
Object	getObjectProperty(Object obj, String property) This call is delegated to the submodel returned by getModel(java.lang.Object).
String[]	getObjectPropertyNames(Object obj) This call is delegated to the submodel returned by getModel(java.lang.Object).
Enumeration	getObjects() Returns the objects of each submodel, one after another in the order in which the submodels were added.
Object	getParent(Object obj) This call is delegated to the submodel returned by getModel(java.lang.Object).
String	getTag(Object obj) This call is delegated to the submodel returned by getModel(java.lang.Object).
Object	getTo(Object link) This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method first queries the destination node's ID by calling IlvInterModelLinks.getToID(java.lang.Object), then it searches for the destination node in all the submodels by calling getObject(java.lang.String).
boolean	isAdjusting() Returns the last value passed to IlvBasicSDMModel.setAdjusting(boolean).
boolean	isEditable() Returns true if all submodels are editable.
boolean	isLink(Object obj) This call is delegated to the submodel returned by getModel(java.lang.Object).
void	linkDestinationChanged(SDMModelEvent event) This method is called when the destination of a link has changed in a submodel.
void	linkSourceChanged(SDMModelEvent event) This method is called when the source of a link has changed in a submodel.
void	objectAdded(SDMModelEvent event) This method is called when an object is added to a submodel.
void	objectRemoved(SDMModelEvent event) This method is called when an object is removed from a submodel.
void	propertyChanged(SDMPropertyChangeEvent event) This method is called when a property of an object of a submodel is changed.
void	removeModel(IlvSDMModel model) Removes a submodel.
void	removeObject(Object object) This call is delegated to the submodel returned by getModel(java.lang.Object).
void	setAdjusting(boolean adjusting) This method sets the flag indicating that subsequent calls to the editing methods should be treated as a single modification.
void	setFrom(Object link, Object node) This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method calls IlvInterModelLinks.setFromID(java.lang.Object, java.lang.String) with the ID of the source node.
void	setID(Object obj, String id) This call is delegated to the submodel returned by getModel(java.lang.Object).
void	setIDImpl(Object obj, String id) This method calls setID(java.lang.Object, java.lang.String).
protected void	setModel(Object obj, IlvSDMModel model) This method is called every time an object is returned by the enumeration resulting from the getObjects() method.
void	setModels(IlvSDMModel[] models) Sets the submodels that this multiple model combines.
void	setObjectProperty(Object object, String property, Object value) This call is delegated to the submodel returned by getModel(java.lang.Object).
void	setTo(Object link, Object node) This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method calls IlvInterModelLinks.setFromID(java.lang.Object, java.lang.String) with the ID of the destination node.

Methods inherited from class ilog.views.sdm.model.IlvBasicSDMModel

addObjectImpl, addSDMModelListener, addSDMPropertyChangeListener, allocID, contains, fireAdjustmentFinished, fireDataChanged, fireIDChanged, fireLinkDestinationChanged, fireLinkSourceChanged, fireObjectAdded, fireObjectRemoved, firePropertyChanged, firePropertyChanged, removeSDMModelListener, removeSDMPropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMultipleSDMModel

public IlvMultipleSDMModel(IlvSDMModel[] models)

Creates a new multiple model that combines the specified submodels.

Parameters:

models - The models to combine. This parameter may be null, in which case the submodels must be specified through setModels(ilog.views.sdm.IlvSDMModel[]) or addModel(ilog.views.sdm.IlvSDMModel).

IlvMultipleSDMModel

public IlvMultipleSDMModel()

Creates a new multiple model with no submodels. The submodels must be specified through setModels(ilog.views.sdm.IlvSDMModel[]) or addModel(ilog.views.sdm.IlvSDMModel).

Method Detail

setModels

public void setModels(IlvSDMModel[] models)

Sets the submodels that this multiple model combines.

Parameters:

models - The models to combine.

getModels

public IlvSDMModel[] getModels()

Returns the submodels that this multiple model combines.

addModel

public void addModel(IlvSDMModel model)

Adds a submodel at the end of the list.

Parameters:

model - The submodel to add.

addModel

public void addModel(IlvSDMModel model,
                     int index)

Adds a submodel at a specified position.

Parameters:

model - The submodel to add.

index - The position where the submodel must be inserted.

removeModel

public void removeModel(IlvSDMModel model)

Removes a submodel.

Parameters:

model - The submodel to remove.

getObjects

public Enumeration getObjects()

Returns the objects of each submodel, one after another in the order in which the submodels were added.

Specified by:

getObjects in interface IlvSDMModel

Returns:

An enumeration of objects that will be converted to IlvGraphics by the IlvSDMViewRenderer associated with the IlvSDMView. The returned enumeration can be null if the model has no objects.

getChildren

public Enumeration getChildren(Object parent)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getChildren in interface IlvSDMModel

Overrides:

getChildren in class IlvBasicSDMModel

Parameters:

parent - The parent object.

Returns:

null.

getParent

public Object getParent(Object obj)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getParent in interface IlvSDMModel

Overrides:

getParent in class IlvBasicSDMModel

Parameters:

obj - The child object.

Returns:

null.

isLink

public boolean isLink(Object obj)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

isLink in interface IlvSDMModel

Overrides:

isLink in class IlvBasicSDMModel

Parameters:

obj - The object whose type is queried.

Returns:

false.

getFrom

public Object getFrom(Object link)

This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method first queries the source node's ID by calling IlvInterModelLinks.getFromID(java.lang.Object), then it searches for the source node in all the submodels by calling getObject(java.lang.String).

If the link's model does not implement IlvInterModelLinks, this call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getFrom in interface IlvSDMModel

Overrides:

getFrom in class IlvBasicSDMModel

Parameters:

link - The link whose source node is queried.

Returns:

null.

getTo

public Object getTo(Object link)

This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method first queries the destination node's ID by calling IlvInterModelLinks.getToID(java.lang.Object), then it searches for the destination node in all the submodels by calling getObject(java.lang.String).

If the link's model does not implement IlvInterModelLinks, this call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getTo in interface IlvSDMModel

Overrides:

getTo in class IlvBasicSDMModel

Parameters:

link - The link whose destination node is queried.

Returns:

null.

getID

public String getID(Object obj)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getID in interface IlvSDMModel

Overrides:

getID in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is requested.

Returns:

A String that identifies the object in a unique way.

getIDImpl

public String getIDImpl(Object obj)

This method calls getID(java.lang.Object).

Overrides:

getIDImpl in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is requested.

See Also:

IlvBasicSDMModel.getID(java.lang.Object)

setID

public void setID(Object obj,
                  String id)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

setID in interface IlvSDMModel

Overrides:

setID in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is to be changed.

id - The new identifier.

setIDImpl

public void setIDImpl(Object obj,
                      String id)

This method calls setID(java.lang.Object, java.lang.String).

Overrides:

setIDImpl in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is to be set.

id - The new identifier.

See Also:

IlvBasicSDMModel.setID(java.lang.Object, java.lang.String)

getObject

public Object getObject(String id)

Finds the object with the specified ID in all the submodels. The first object found is returned.

Specified by:

getObject in interface IlvSDMModel

Overrides:

getObject in class IlvBasicSDMModel

Parameters:

id - The identifier of the requested object.

Returns:

The object whose identifier is id.

getTag

public String getTag(Object obj)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getTag in interface IlvSDMModel

Parameters:

obj - The object whose tag is requested.

Returns:

A string that identifies the symbolic type of the object.

getObjectProperty

public Object getObjectProperty(Object obj,
                                String property)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getObjectProperty in interface IlvSDMModel

Parameters:

obj - The object whose property is queried.

property - The name of the property.

Returns:

An Object representing the value of the specified property, or null if the object does not have or support the specified property.

getObjectPropertyNames

public String[] getObjectPropertyNames(Object obj)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

getObjectPropertyNames in interface IlvSDMModel

Parameters:

obj - The object whose property names are queried.

isEditable

public boolean isEditable()

Returns true if all submodels are editable.

Specified by:

isEditable in interface IlvSDMModel

Overrides:

isEditable in class IlvBasicSDMModel

addObject

public void addObject(Object object,
                      Object parent,
                      Object before)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

addObject in interface IlvSDMModel

Overrides:

addObject in class IlvBasicSDMModel

Parameters:

object - The new object to add to the model.

parent - The parent if the new object must be added to a submodel, or null if the new object is a top-level object.

before - An existing object of the model before which the new object must be inserted. You can pass null to append the new object at the end of the model.

removeObject

public void removeObject(Object object)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

removeObject in interface IlvSDMModel

Overrides:

removeObject in class IlvBasicSDMModel

Parameters:

object - The object to remove.

setObjectProperty

public void setObjectProperty(Object object,
                              String property,
                              Object value)

This call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

setObjectProperty in interface IlvSDMModel

Overrides:

setObjectProperty in class IlvBasicSDMModel

Parameters:

object - The object whose property is to be set.

property - The name of the property to set.

value - The new value of the property.

createNode

public Object createNode(String tag)

This method returns null, because it is not possible in general to know which submodel must be called to create the new object. Subclasses should override this method and determine how the new object must be created.

Specified by:

createNode in interface IlvSDMModel

Overrides:

createNode in class IlvBasicSDMModel

Parameters:

tag - The tag of the new node.

createLink

public Object createLink(String tag)

This method returns null, because it is not possible in general to know which submodel must be called to create the new object. Subclasses should override this method and determine how the new object must be created.

Specified by:

createLink in interface IlvSDMModel

Overrides:

createLink in class IlvBasicSDMModel

Parameters:

tag - The tag of the new link.

setFrom

public void setFrom(Object link,
                    Object node)

This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method calls IlvInterModelLinks.setFromID(java.lang.Object, java.lang.String) with the ID of the source node.

If the link's model does not implement IlvInterModelLinks, this call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

setFrom in interface IlvSDMModel

Overrides:

setFrom in class IlvBasicSDMModel

Parameters:

link - The link whose source node must be set.

node - The new source node of the link.

setTo

public void setTo(Object link,
                  Object node)

This method handles intermodel links: if the submodel containing the link implements the IlvInterModelLinks interface, this method calls IlvInterModelLinks.setFromID(java.lang.Object, java.lang.String) with the ID of the destination node.

If the link's model does not implement IlvInterModelLinks, this call is delegated to the submodel returned by getModel(java.lang.Object).

Specified by:

setTo in interface IlvSDMModel

Overrides:

setTo in class IlvBasicSDMModel

Parameters:

link - The link whose destination node must be set.

node - The new destination node of the link.

setAdjusting

public void setAdjusting(boolean adjusting)

This method sets the flag indicating that subsequent calls to the editing methods should be treated as a single modification.

Specified by:

setAdjusting in interface IlvSDMModel

Overrides:

setAdjusting in class IlvBasicSDMModel

Parameters:

adjusting - The value of the flag.

isAdjusting

public boolean isAdjusting()

Returns the last value passed to IlvBasicSDMModel.setAdjusting(boolean).

Specified by:

isAdjusting in interface IlvSDMModel

Overrides:

isAdjusting in class IlvBasicSDMModel

clear

public void clear()

Clears all the submodels.

Specified by:

clear in interface IlvSDMModel

getModel

protected IlvSDMModel getModel(Object obj)

This method determines the model to which an object belongs. The model can be stored in the object itself, or in some other data structure such as a hash map.

The implementation of this method can rely on the setModel(java.lang.Object, ilog.views.sdm.IlvSDMModel) method being called for every object returned by the enumeration resulting from the getObject(java.lang.String) method. For example, if you use a hash map to store the model, you can associate the model with the object in setModel(java.lang.Object, ilog.views.sdm.IlvSDMModel), and retrieve it in getModel(java.lang.Object).

The default implementation tests if the object implements the IlvMultipleSDMModel.OwnedObject interface. If it does, the interface's IlvMultipleSDMModel.OwnedObject.getModel() is called. Otherwise, this method uses a HashMap. If the objects of the submodels do not implement IlvMultipleSDMModel.OwnedObject, you are recommended, if you can, to override this method and use a more efficient implementation, such as storing the model in a member variable in the object.

Parameters:

obj - The data model object.

Returns:

The submodel to which the object belongs, that is, the one that will be called to get the object's properties, tag, and so on.

See Also:

setModel(java.lang.Object, ilog.views.sdm.IlvSDMModel), IlvMultipleSDMModel.OwnedObject

setModel

protected void setModel(Object obj,
                        IlvSDMModel model)

This method is called every time an object is returned by the enumeration resulting from the getObjects() method.

This method should associate the model with the object in the most effective way, so that subsequent calls to getModel(java.lang.Object) return the correct model.

Note: This method must also be called by createNode(java.lang.String) and createLink(java.lang.String) when a new object is created.

The default implementation tests if the object implements the IlvMultipleSDMModel.OwnedObject interface. If it does, the interface's IlvMultipleSDMModel.OwnedObject.setModel(ilog.views.sdm.IlvSDMModel) is called. Otherwise, this method uses a HashMap. If the objects of the submodels do not implement IlvMultipleSDMModel.OwnedObject, you are recommended, if you can, to override this method and use a more efficient implementation, such as storing the model in a member variable in the object.

See Also:

getModel(java.lang.Object), IlvMultipleSDMModel.OwnedObject

objectAdded

public void objectAdded(SDMModelEvent event)

This method is called when an object is added to a submodel. The default implementation calls IlvBasicSDMModel.fireObjectAdded(java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

objectAdded in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

objectRemoved

public void objectRemoved(SDMModelEvent event)

This method is called when an object is removed from a submodel. The default implementation calls IlvBasicSDMModel.fireObjectRemoved(java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

objectRemoved in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

dataChanged

public void dataChanged(SDMModelEvent event)

This method is called when the contents of a submodel are changed. The default implementation calls IlvBasicSDMModel.fireDataChanged(java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

dataChanged in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

linkSourceChanged

public void linkSourceChanged(SDMModelEvent event)

This method is called when the source of a link has changed in a submodel. The default implementation calls IlvBasicSDMModel.fireLinkSourceChanged(java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

linkSourceChanged in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

linkDestinationChanged

public void linkDestinationChanged(SDMModelEvent event)

This method is called when the destination of a link has changed in a submodel. The default implementation calls IlvBasicSDMModel.fireLinkDestinationChanged(java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

linkDestinationChanged in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

adjustmentFinished

public void adjustmentFinished(SDMModelEvent event)

This method is called at the end of an adjustment sequence on the underlying filtered model. The default implementation calls IlvBasicSDMModel.fireAdjustmentFinished() to propagate the event to the listeners of this multiple model.

Specified by:

adjustmentFinished in interface SDMModelListener

Parameters:

event - The event that was fired by the submodel.

propertyChanged

public void propertyChanged(SDMPropertyChangeEvent event)

This method is called when a property of an object of a submodel is changed. The default implementation calls IlvBasicSDMModel.firePropertyChanged(java.lang.Object, java.lang.String, java.lang.Object, java.lang.Object) to propagate the event to the listeners of this multiple model.

Specified by:

propertyChanged in interface SDMPropertyChangeListener

Parameters:

event - The event that was fired by the submodel.