ilog.views.gantt.faces.dhtml.component

Class IlvFacesGanttPropertyAccessor

java.lang.Object

ilog.views.gantt.faces.dhtml.component.IlvFacesGanttPropertyAccessor

All Implemented Interfaces:

Serializable

public class IlvFacesGanttPropertyAccessor
extends Object
implements Serializable

The IlvFacesGanttPropertyAccessor class let the IlvFacesGanttSelectionManager access the properties of the selected objects for read or write operations. Write operations are allowed only if the parent IlvFacesHierarchyChartView is editable.

Property values are marshalled/unmarshalled using IlvConvert. By default converters are registered to handle types java.util.Date, IlvDuration and IlvConstraintType.

Since:

JViews 8.0

See Also:

IlvFacesHierarchyChartView.setEditable(boolean), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvFacesGanttPropertyAccessor() Creates an IlvFacesGanttPropertyAccessor.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptGetProperty(IlvHierarchyChart view, Object object, String propertyName) The default implementation calls acceptProperty(IlvHierarchyChart, Object, String).
protected boolean	acceptProperty(IlvHierarchyChart view, Object object, String propertyName) Returns whether or not a given property can be read or written by the client.
protected boolean	acceptSetProperty(IlvHierarchyChart view, Object object, String propertyName, Object propertyValue) Returns whether a property can be set on an object.
Map<String,String>	getProperties(IlvHierarchyChart view, Object object) Returns the properties of an object.
protected List<String>	getPropertyNames(IlvHierarchyChart view, Object object) Returns the properties of an object, that will be exported for a hierarchy chart.
protected String	getStringFromValue(IlvHierarchyChart view, Object object, String propertyName, Object propertyValue) Marshalls a model object representation to a client-side suitable String representation of a property value.
protected Object	getValueFromString(IlvHierarchyChart view, Object object, String propertyName, String propertyValue) Unmarshalls a client-side String representation of a property value to an object representation.
void	registerType(Class clazz, String propertyName, Class type) Registers the expected object type for a property of an class.
Map	setProperties(IlvHierarchyChart view, Object object, Map properties) Set the properties of an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesGanttPropertyAccessor

public IlvFacesGanttPropertyAccessor()

Creates an IlvFacesGanttPropertyAccessor.

Method Detail

getProperties

public Map<String,String> getProperties(IlvHierarchyChart view,
                                        Object object)

Returns the properties of an object. The Map contains properties names as keys and properties values as values in the form of String objects.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The chart Object.

Returns:

The properties of the given object. It is a Map, mapping property names to property values as String.

setProperties

public Map setProperties(IlvHierarchyChart view,
                         Object object,
                         Map properties)

Set the properties of an object.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The chart Object for which to set properties.

properties - The properties of the given object. This is a Map of property names to property values, where the property values are String objects.

Returns:

the Map containing the properties names as keys and (@link ilog.views.faces.dhtml.component.IlvFacesPropertyAccessorError} objects as values for the properties that couldn't be set either because not accepted or because of conversion errors. This returned value might be null if no problem occurred.

getPropertyNames

protected List<String> getPropertyNames(IlvHierarchyChart view,
                                        Object object)

Returns the properties of an object, that will be exported for a hierarchy chart. Redefine this method to filter properties.

Parameters:

view - The IlvHierarchyChart to which the object belongs to.

object - The Gantt model Object for which to return property names.

Returns:

The names of the properties.

acceptProperty

protected boolean acceptProperty(IlvHierarchyChart view,
                                 Object object,
                                 String propertyName)

Returns whether or not a given property can be read or written by the client. This implementation returns true, always -- that is: there is no restriction.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The Gantt model Object.

propertyName - The name of the property.

Returns:

true when the property can be accessed.

acceptGetProperty

protected boolean acceptGetProperty(IlvHierarchyChart view,
                                    Object object,
                                    String propertyName)

The default implementation calls acceptProperty(IlvHierarchyChart, Object, String). Redefine this method to filter accepted properties for the get operations only.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The Gantt model Object.

propertyName - The name of the property.

Returns:

true when the property can be accessed during a get operation.

acceptSetProperty

protected boolean acceptSetProperty(IlvHierarchyChart view,
                                    Object object,
                                    String propertyName,
                                    Object propertyValue)

Returns whether a property can be set on an object.

Predefined properties are settable as defined in the base interfaces for Gantt model objects:

• IlvActivity,
• IlvConstraint,
• IlvReservation,
• IlvResource.

The default implementation allows to set any user property on an object implementing IlvUserPropertyHolder -- that is:

• IlvGeneralActivity, IlvGeneralConstraint, IlvGeneralReservation, IlvGeneralResource,
• IlvTableActivity, IlvTableConstraint, IlvTableReservation, IlvTableResource.

Any property value can be set.

Redefine this method to filter accepted properties and values for the set operations only.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The Gantt model Object.

propertyName - The name of the property.

propertyValue - The proposed value for the property.

Returns:

true when the property can be accessed during a set operation.

getValueFromString

protected Object getValueFromString(IlvHierarchyChart view,
                                    Object object,
                                    String propertyName,
                                    String propertyValue)
                             throws IlvConvertException

Unmarshalls a client-side String representation of a property value to an object representation. By default this is done using the IlvConvert utility to convert the String to the given type.

null is always unmarshalled to null.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The Gantt model Object .

propertyName - The name of the property.

propertyValue - The String value for the property.

Returns:

The object representation suitable for the Gantt model.

Throws:

IlvConvertException - if the conversion failed.

getStringFromValue

protected String getStringFromValue(IlvHierarchyChart view,
                                    Object object,
                                    String propertyName,
                                    Object propertyValue)

Marshalls a model object representation to a client-side suitable String representation of a property value.

By default this is done using IlvConvert utility to convert the Object to a String.

For values of type IlvActivity and IlvResource the converted value is their ID property value.

Parameters:

view - The IlvHierarchyChart to which the object belongs.

object - The Gantt model Object.

propertyName - The name of the property.

propertyValue - The object value for the property.

Returns:

The String representation suitable for the client-side.

registerType

public final void registerType(Class clazz,
                               String propertyName,
                               Class type)

Registers the expected object type for a property of an class. This information is used in getValueFromString(IlvHierarchyChart, Object, String, String). Use this method to register the type of user properties as defined in IlvUserPropertyHolder.

Parameters:

clazz - The class of the object. Must be one of:

• IlvActivity.class
,
• IlvConstraint.class
,
• IlvReservation.class
,
• IlvResource.class
.

propertyName - The property name.

type - The expected type for the property.