ilog.views.gantt.property

Class IlvAbstractStringProperty

java.lang.Object

ilog.views.gantt.property.IlvAbstractStringProperty

All Implemented Interfaces:

IlvProperty, IlvStringProperty

Direct Known Subclasses:

IlvAbstractUserDefinedProperty, IlvActivityFormattedDurationProperty, IlvActivityIDProperty, IlvActivityNameProperty, IlvFormattedNumberProperty, IlvFormattedTimeProperty, IlvResourceIDProperty, IlvResourceNameProperty

public abstract class IlvAbstractStringProperty
extends Object
implements IlvStringProperty

IlvAbstractStringProperty provides a common framework for accessing arbitrary object properties via the generic IlvStringProperty interface. A Format can be supplied to convert non-String properties to/from a string.

Field Summary

Fields

Modifier and Type	Field and Description
protected Format	_formatter The formatter which is used to convert the target object's property to/from a string, or null if no formatting is desired.

Constructor Summary

Constructors

Constructor and Description
IlvAbstractStringProperty() Creates an IlvAbstractStringProperty.

Method Summary

Modifier and Type	Method and Description
Iterator<IlvHierarchyNode>	changedRowsIterator(EventObject event) Returns an iterator over the activities or resources that the specified event reports have changed with respect to this property.
Format	getFormat() Returns the formatter which is used to convert the property represented by this adapter to/from a string, or null if there is no formatter.
String	getValue(Object target) Returns the String value of the property represented by this adapter from the specified target object.
protected abstract Object	getValueImpl(Object target) Returns the value of the property represented by this adapter from the specified target object.
boolean	isPropertyChangedEvent(EventObject event) Returns whether the specified event is a changed event for this property.
void	setFormat(Format formatter) Sets the formatter which will be used to convert the property represented by this adapter to/from a string.
void	setValue(Object target, String s) Sets the value of the property represented by this adapter in the specified target object.
protected abstract void	setValueImpl(Object target, Object newValue) Sets the value of the property represented by this adapter in the specified target object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.property.IlvProperty

getEventClass

Field Detail

_formatter

protected Format _formatter

The formatter which is used to convert the target object's property to/from a string, or null if no formatting is desired. Typically, this will be the case if the property value is a String and no additional formatting is desired.

Constructor Detail

IlvAbstractStringProperty

public IlvAbstractStringProperty()

Creates an IlvAbstractStringProperty.

Method Detail

getValue

public String getValue(Object target)

Returns the String value of the property represented by this adapter from the specified target object. This method first invokes getValueImpl() to obtain target's property value. If this adapter has a Format set, it is then applied to the property value to obtain its string representation. Otherwise, if no Format is set, then the property value's toString() method is invoked to obtain its string representation.

Specified by:

getValue in interface IlvProperty

Specified by:

getValue in interface IlvStringProperty

Parameters:

target - the target object

Returns:

target's property, represented as a String

See Also:

getValueImpl(java.lang.Object), setFormat(java.text.Format)

setValue

public void setValue(Object target,
                     String s)
              throws ParseException

Sets the value of the property represented by this adapter in the specified target object. If this adapter has a Format set, it is used to parse s into the appropriate type of property value. The parsed property value is then passed to setValueImpl() to actually set target's property. Otherwise, if no Format is set, then s is directly passed to setValueImpl() as the new value of target's property. If s cannot be parsed into a valid property value, a ParseException will be thrown.

Specified by:

setValue in interface IlvStringProperty

Parameters:

target - the target object

s - the new value of the property

Throws:

ParseException - if s cannot be parsed into a valid property value

See Also:

setValueImpl(java.lang.Object, java.lang.Object), setFormat(java.text.Format)

getValueImpl

protected abstract Object getValueImpl(Object target)

Returns the value of the property represented by this adapter from the specified target object. Subclasses should provide an implementation of this method similar to this:

   // Adapter representing the Bar property of Foo objects. The value of Bar
   // is an instance of the class BarType.
   public class FooBarProperty extends IlvAbstractStringProperty {

     protected Object getValueImpl (Object aFoo) {
       return ((Foo)aFoo).getBar();
     }

      ... }
 

Parameters:

target - the target object

See Also:

getValue(java.lang.Object)

setValueImpl

protected abstract void setValueImpl(Object target,
                                     Object newValue)
                              throws ParseException

Sets the value of the property represented by this adapter in the specified target object. Subclasses should provide an implementation of this method similar to this:

   // Adapter representing the Bar property of Foo objects. The value of Bar
   // is an instance of the class BarType.
   public class FooBarProperty extends IlvAbstractStringProperty {

     protected Object setValueImpl (Object aFoo, Object newValue) {
       ((Foo)aFoo).setBar((BarType) newValue);
     }

      ...
   }
 

Parameters:

target - the target object

newValue - the new value of the property

Throws:

ParseException - if newValue cannot be parsed into a valid property value

See Also:

setValue(java.lang.Object, java.lang.String)

getFormat

public Format getFormat()

Returns the formatter which is used to convert the property represented by this adapter to/from a string, or null if there is no formatter. Typically, this will be the case if the property value is a String and no additional formatting is desired.

See Also:

setFormat(java.text.Format)

setFormat

public void setFormat(Format formatter)

Sets the formatter which will be used to convert the property represented by this adapter to/from a string. null can be supplied if the property type is a String and no additional formatting is desired.

Parameters:

formatter - the formatter or null if no formatter is desired

See Also:

getFormat()

isPropertyChangedEvent

public boolean isPropertyChangedEvent(EventObject event)

Returns whether the specified event is a changed event for this property. The default implementation returns true if and only if event is the same or a subclass of IlvProperty.getEventClass(), is also an IlvPropertyEvent, and ((IlvPropertyEvent)event).isChangedEvent() returns true. This implementation is suitable for a property that fires a specific IlvPropertyEvent subclass when its value changes. Subclasses should override this method as necessary.

Specified by:

isPropertyChangedEvent in interface IlvProperty

changedRowsIterator

public Iterator<IlvHierarchyNode> changedRowsIterator(EventObject event)

Returns an iterator over the activities or resources that the specified event reports have changed with respect to this property. For example, if this is an IlvActivityNameProperty and event is an ActivityNameEvent, then this method returns an iterator over the single activity that fired the event.

The default implementation returns an iterator over event's source if event is a property changed event. This implementation is suitable for an activity or resource property that fires a specific IlvPropertyEvent subclass when its value changes. Subclasses should override this method as necessary.

Specified by:

changedRowsIterator in interface IlvProperty