Package com.im.df.api.support

Class DFEntityDataEvent

java.lang.Object

java.util.EventObject

com.im.df.api.support.DFEntityDataEvent

All Implemented Interfaces:

java.io.Serializable

public class DFEntityDataEvent
extends java.util.EventObject

Data change event. It is fired from DFEntityDataProvider.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
DFEntityDataEvent(DFEntityDataProvider dataProvider)	Creates the event for all data.
DFEntityDataEvent(DFEntityDataProvider dataProvider, java.util.List<? extends java.lang.Comparable<?>> ids, java.lang.String idOfIdsField, java.util.Collection<java.lang.String> fieldsIds)	Create the event for specific ids.

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.lang.String>	getFieldsIds()
java.util.List<? extends java.lang.Comparable<?>>	getIds()	Get the list of ids which were changed/removed/added.
java.lang.String	getIdsFieldID()
boolean	isAllData()	Is this event related to all rows in table? If true getIds can return null
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

DFEntityDataEvent

public DFEntityDataEvent(DFEntityDataProvider dataProvider)

Creates the event for all data. Method isAllData() will return true and getIds() will return null.

DFEntityDataEvent

public DFEntityDataEvent(DFEntityDataProvider dataProvider,
                         java.util.List<? extends java.lang.Comparable<?>> ids,
                         java.lang.String idOfIdsField,
                         java.util.Collection<java.lang.String> fieldsIds)

Create the event for specific ids.

Parameters:

dataProvider - DFEntityDataProvider this event is tied to.

ids - list of ids for which this event is created

idOfIdsField - of which the ids are value of. If null, ids will be treated as list of entity ID field values

fieldsIds - IDs collection of fields involved in this data event

Method Detail

getIds

public java.util.List<? extends java.lang.Comparable<?>> getIds()

Get the list of ids which were changed/removed/added. Can return null if the event notifies about all rows.

getIdsFieldID

public java.lang.String getIdsFieldID()

Returns:

Unique ID of field, which the ids are value of. Note that this is not always the ID field of an entity.

isAllData

public boolean isAllData()

Is this event related to all rows in table? If true getIds can return null

getFieldsIds

public java.util.Collection<java.lang.String> getFieldsIds()

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject