ilog.views.sdm.model

Class IlvJavaBeanSDMModel

java.lang.Object

ilog.views.sdm.model.IlvBasicSDMModel

ilog.views.sdm.model.IlvJavaBeanSDMModel

All Implemented Interfaces:

IlvSDMModel, Serializable

public abstract class IlvJavaBeanSDMModel
extends IlvBasicSDMModel

IlvJavaBeanSDMModel is an SDM data model that uses the Java introspection mechanism. Each object contained in the model is considered as a Java bean, and its properties are read and written using introspection.

This class can be used as a convenient base class to implement simple custom SDM data models that return existing Java objects created by an application.

This class is abstract because it does not define how the objects are stored in the model. At the very least, subclasses must implement the IlvSDMModel.getObjects() and IlvSDMModel.clear() methods.

Since:

JViews 4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvJavaBeanSDMModel() Creates a new JavaBean model.

Method Summary

Modifier and Type	Method and Description
Object	createLink(String tag) This method returns a new instance of the Java class of name tag.
Object	createNode(String tag) This method returns a new instance of the Java class of name tag.
Object	getFrom(Object link) This method returns the value of the JavaBean property specified by setFromProperty(java.lang.String).
String	getFromProperty() Returns the name of the JavaBean property holding a reference to the source node of a link.
protected String	getIDImpl(Object obj) This method returns the value of the Java bean property specified by setIDProperty(java.lang.String).
String	getIDProperty() Returns the name of the JavaBean property holding the ID of an object.
Object	getObjectProperty(Object obj, String property) This method retrieves the value of the specified property using bean introspection.
String[]	getObjectPropertyNames(Object obj) This method uses bean introspection to determine the names of the properties that can be retrieved for an object.
String	getTag(Object obj) Returns the symbolic type (the "tag") of an object.
Object	getTo(Object link) This method returns the value of the JavaBean property specified by setToProperty(java.lang.String).
String	getToProperty() Returns the name of the JavaBean property holding a reference to the destination node of a link.
boolean	isEditable() Returns true to indicate that this model can be edited.
boolean	isLink(Object obj) This method returns true if and only if getFrom(obj) and getTo(obj) return a non-null value.
void	setFrom(Object link, Object from) This method sets the value of the JavaBean property specified by setFromProperty(java.lang.String).
void	setFromProperty(String property) Sets the name of the JavaBean property holding a reference to the source node of a link.
protected void	setIDImpl(Object obj, String id) This method sets the value of the JavaBean property specified by setIDProperty(java.lang.String).
void	setIDProperty(String property) Sets the name of the JavaBean property holding the ID of an object.
void	setObjectProperty(Object object, String property, Object value) This method sets the value of the specified property using bean introspection.
void	setTo(Object link, Object to) This method sets the value of the Java bean property specified by setToProperty(java.lang.String).
void	setToProperty(String property) Sets the name of the JavaBean property holding a reference to the destination node of a link.

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

addObject, addObjectImpl, addSDMModelListener, addSDMPropertyChangeListener, allocID, contains, fireAdjustmentFinished, fireDataChanged, fireIDChanged, fireLinkDestinationChanged, fireLinkSourceChanged, fireObjectAdded, fireObjectRemoved, firePropertyChanged, firePropertyChanged, getChildren, getID, getObject, getParent, isAdjusting, removeObject, removeSDMModelListener, removeSDMPropertyChangeListener, setAdjusting, setID

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.sdm.IlvSDMModel

clear, getObjects

Constructor Detail

IlvJavaBeanSDMModel

public IlvJavaBeanSDMModel()

Creates a new JavaBean model.

Method Detail

setIDProperty

public void setIDProperty(String property)

Sets the name of the JavaBean property holding the ID of an object. If this property is null, object IDs are allocated automatically. The property is initially null.

Parameters:

property - The JavaBean property.

getIDProperty

public String getIDProperty()

Returns the name of the JavaBean property holding the ID of an object.

setFromProperty

public void setFromProperty(String property)

Sets the name of the JavaBean property holding a reference to the source node of a link. If this property is null, the model will not consider any object as a link. The property is initially null.

Parameters:

property - The new JavaBean property.

getFromProperty

public String getFromProperty()

Returns the name of the JavaBean property holding a reference to the source node of a link.

setToProperty

public void setToProperty(String property)

Sets the name of the JavaBean property holding a reference to the destination node of a link. If this property is null, the model will not consider any object as a link. The property is initially null.

Parameters:

property - The new JavaBean property.

getToProperty

public String getToProperty()

Returns the name of the JavaBean property holding a reference to the destination node of a link.

isLink

public boolean isLink(Object obj)

This method returns true if and only if getFrom(obj) and getTo(obj) return a non-null value.

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 returns the value of the JavaBean property specified by setFromProperty(java.lang.String). If no property was specified, this method returns null.

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 returns the value of the JavaBean property specified by setToProperty(java.lang.String). If no property was specified, this method returns null.

Specified by:

getTo in interface IlvSDMModel

Overrides:

getTo in class IlvBasicSDMModel

Parameters:

link - The link whose destination node is queried.

Returns:

null.

setFrom

public void setFrom(Object link,
                    Object from)

This method sets the value of the JavaBean property specified by setFromProperty(java.lang.String). If no property was specified, this method does nothing.

Specified by:

setFrom in interface IlvSDMModel

Overrides:

setFrom in class IlvBasicSDMModel

Parameters:

link - The link whose source node is to be set.

from - The new source of the link.

setTo

public void setTo(Object link,
                  Object to)

This method sets the value of the Java bean property specified by setToProperty(java.lang.String). If no property was specified, this method does nothing.

Specified by:

setTo in interface IlvSDMModel

Overrides:

setTo in class IlvBasicSDMModel

Parameters:

link - The link whose destination node is to be set.

to - The new destination of the link.

getIDImpl

protected String getIDImpl(Object obj)

This method returns the value of the Java bean property specified by setIDProperty(java.lang.String). If no property was specified, this method returns null.

Overrides:

getIDImpl in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is requested.

See Also:

IlvBasicSDMModel.getID(java.lang.Object)

setIDImpl

protected void setIDImpl(Object obj,
                         String id)

This method sets the value of the JavaBean property specified by setIDProperty(java.lang.String). If no property was specified, this method does nothing.

Overrides:

setIDImpl in class IlvBasicSDMModel

Parameters:

obj - The object whose identifier is to be set.

id - The new identifier of the object.

See Also:

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

getTag

public String getTag(Object obj)

Returns the symbolic type (the "tag") of an object.

This implementation returns the name of the Java class of the object.

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 method retrieves the value of the specified property using bean introspection.

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.

setObjectProperty

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

This method sets the value of the specified property using bean introspection.

Specified by:

setObjectProperty in interface IlvSDMModel

Overrides:

setObjectProperty in class IlvBasicSDMModel

Parameters:

object - The object whose property must be set.

property - The name of the property to set.

value - The new value of the property.

getObjectPropertyNames

public String[] getObjectPropertyNames(Object obj)

This method uses bean introspection to determine the names of the properties that can be retrieved for an object.

Parameters:

obj - The object whose property names are queried.

isEditable

public boolean isEditable()

Returns true to indicate that this model can be edited.

Specified by:

isEditable in interface IlvSDMModel

Overrides:

isEditable in class IlvBasicSDMModel

createNode

public Object createNode(String tag)

This method returns a new instance of the Java class of name tag.

Specified by:

createNode in interface IlvSDMModel

Overrides:

createNode in class IlvBasicSDMModel

Parameters:

tag - The class name of the new node.

createLink

public Object createLink(String tag)

This method returns a new instance of the Java class of name tag.

Specified by:

createLink in interface IlvSDMModel

Overrides:

createLink in class IlvBasicSDMModel

Parameters:

tag - The class name of the new link.