jadex.bridge

Class ComponentChangeEvent

java.lang.Object

jadex.bridge.ComponentChangeEvent

All Implemented Interfaces:

IComponentChangeEvent

public class ComponentChangeEvent
extends Object
implements IComponentChangeEvent

The component change event.

Field Summary

Fields inherited from interface jadex.bridge.IComponentChangeEvent

EVENT_TYPE_BULK, EVENT_TYPE_CREATION, EVENT_TYPE_DISPOSAL, EVENT_TYPE_MODIFICATION, EVENT_TYPE_OCCURRENCE, SOURCE_CATEGORY_ACTIVITY, SOURCE_CATEGORY_COMPONENT, SOURCE_CATEGORY_EXECUTION, SOURCE_CATEGORY_FACT, SOURCE_CATEGORY_GOAL, SOURCE_CATEGORY_IEVENT, SOURCE_CATEGORY_MESSAGE, SOURCE_CATEGORY_PLAN

Constructor Summary

Constructors

Constructor and Description
ComponentChangeEvent() Create a new event.
ComponentChangeEvent(String eventtype, String sourcecategory, String sourcetype, String sourcename, IComponentIdentifier cid, long componentcreationtime, Object details) Create a new event.
ComponentChangeEvent(String eventtype, String sourcecategory, String sourcetype, String sourcename, IComponentIdentifier cid, long componentcreationtime, String reason, Object details, long time) Create a new event.

Method Summary

Methods

Modifier and Type	Method and Description
static IFuture<Void>	dispatchComponentChangeEvent(IComponentChangeEvent event, Collection<IComponentListener> componentlisteners) Dispatches a component change event.
static IFuture<Void>	dispatchTerminatedEvent(IComponentIdentifier cid, long creationtime, IModelInfo model, Collection<IComponentListener> componentlisteners, IClockService clock) Dispatch a "component terminated" event.
static IFuture<Void>	dispatchTerminatingEvent(IComponentAdapter adapter, long creationtime, IModelInfo model, IServiceProvider provider, Collection<IComponentListener> componentlisteners) Dispatch a "component terminating" event.
IComponentChangeEvent[]	getBulkEvents() Get the bulk events.
IComponentIdentifier	getComponent() Returns the component that generated the event.
long	getComponentCreationTime() Returns creation time of the component that generated the event.
Object	getDetails() Get the details.
String	getEventType() Returns the type of the event.
String	getParent() Returns the parent of the source that generated the event, if any.
String	getReason() Returns a reason why the event occured.
String	getSourceCategory() Returns the category of the source that caused the event.
String	getSourceName() Returns the name of the source that caused the event.
String	getSourceType() Returns the type of the source that caused the event.
long	getTime() Returns the time when the event occured.
static IFuture<Long>	getTimeStamp(IServiceProvider provider) Retrieves a timestamp from the clock service which can be used in events.
void	setComponent(IComponentIdentifier id) Sets the component that generated the event.
void	setComponentCreationTime(long creationtime) Sets the creation time of the component that generated the event.
void	setDetails(Object details) Set the details.
void	setEventType(String type) Sets the type of the event.
void	setParent(String id) Sets the parent of the source that generated the event, if any.
void	setReason(String reason) Sets a reason why the event occured.
void	setSourceCategory(String category) Sets the category of the source that caused the event.
void	setSourceName(String name) Sets the name of the source that caused the event.
void	setSourceType(String type) Sets the type of the source that caused the event.
void	setTime(long time) Sets the time when the event occured.
String	toString() Get the string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentChangeEvent

public ComponentChangeEvent()

Create a new event.

ComponentChangeEvent

public ComponentChangeEvent(String eventtype,
                    String sourcecategory,
                    String sourcetype,
                    String sourcename,
                    IComponentIdentifier cid,
                    long componentcreationtime,
                    Object details)

Create a new event.

ComponentChangeEvent

public ComponentChangeEvent(String eventtype,
                    String sourcecategory,
                    String sourcetype,
                    String sourcename,
                    IComponentIdentifier cid,
                    long componentcreationtime,
                    String reason,
                    Object details,
                    long time)

Create a new event.

Method Detail

getEventType

public String getEventType()

Returns the type of the event.

Specified by:

getEventType in interface IComponentChangeEvent

Returns:

The type of the event.

getTime

public long getTime()

Returns the time when the event occured.

Specified by:

getTime in interface IComponentChangeEvent

Returns:

Time of event.

getSourceName

public String getSourceName()

Returns the name of the source that caused the event.

Specified by:

getSourceName in interface IComponentChangeEvent

Returns:

Name of the source.

getSourceType

public String getSourceType()

Returns the type of the source that caused the event.

Specified by:

getSourceType in interface IComponentChangeEvent

Returns:

Type of the source.

getSourceCategory

public String getSourceCategory()

Returns the category of the source that caused the event.

Specified by:

getSourceCategory in interface IComponentChangeEvent

Returns:

Type of the source.

getComponent

public IComponentIdentifier getComponent()

Returns the component that generated the event.

Specified by:

getComponent in interface IComponentChangeEvent

Returns:

Component ID.

getComponentCreationTime

public long getComponentCreationTime()

Returns creation time of the component that generated the event.

Specified by:

getComponentCreationTime in interface IComponentChangeEvent

Returns:

Parent ID.

getParent

public String getParent()

Returns the parent of the source that generated the event, if any.

Specified by:

getParent in interface IComponentChangeEvent

Returns:

Parent ID.

getReason

public String getReason()

Returns a reason why the event occured.

Specified by:

getReason in interface IComponentChangeEvent

Returns:

Reason why the event occured, may be null.

getDetails

public Object getDetails()

Get the details.

Specified by:

getDetails in interface IComponentChangeEvent

Returns:

The details.

setEventType

public void setEventType(String type)

Sets the type of the event.

Parameters:

type - The type of the event.

setTime

public void setTime(long time)

Sets the time when the event occured.

Parameters:

time - Time of event.

setSourceName

public void setSourceName(String name)

Sets the name of the source that caused the event.

Parameters:

name - Name of the source.

setSourceType

public void setSourceType(String type)

Sets the type of the source that caused the event.

Parameters:

type - Type of the source.

setSourceCategory

public void setSourceCategory(String category)

Sets the category of the source that caused the event.

Parameters:

category - Category of the source.

setComponent

public void setComponent(IComponentIdentifier id)

Sets the component that generated the event.

Parameters:

id - Component ID.

setComponentCreationTime

public void setComponentCreationTime(long creationtime)

Sets the creation time of the component that generated the event.

Parameters:

creationtime - The creation time.

setParent

public void setParent(String id)

Sets the parent of the source that generated the event, if any.

Parameters:

id - Parent ID.

setReason

public void setReason(String reason)

Sets a reason why the event occured.

Parameters:

reason - Reason why the event occured, may be null.

setDetails

public void setDetails(Object details)

Set the details.

Parameters:

details - The details to set.

getBulkEvents

public IComponentChangeEvent[] getBulkEvents()

Get the bulk events.

Specified by:

getBulkEvents in interface IComponentChangeEvent

Returns:

The bulk events.

toString

public String toString()

Get the string representation.

Overrides:

toString in class Object

getTimeStamp

public static final IFuture<Long> getTimeStamp(IServiceProvider provider)

Retrieves a timestamp from the clock service which can be used in events.

Parameters:

provider - Service provider of the component.

Returns:

Time stamp.

dispatchComponentChangeEvent

public static final IFuture<Void> dispatchComponentChangeEvent(IComponentChangeEvent event,
                                         Collection<IComponentListener> componentlisteners)

Dispatches a component change event.

Parameters:

event - The event.

componentlisteners - Event listeners.

finished - Future, called when the event has been dispatched.

dispatchTerminatedEvent

public static final IFuture<Void> dispatchTerminatedEvent(IComponentIdentifier cid,
                                    long creationtime,
                                    IModelInfo model,
                                    Collection<IComponentListener> componentlisteners,
                                    IClockService clock)

Dispatch a "component terminated" event.

Parameters:

adapter - Component adapter.

creationtime - Creation time of the component.

model - Component model.

provider - Component service provider.

componentlisteners - Listeners of the component.

finished - Future, called when the event has been dispatched.

dispatchTerminatingEvent

public static final IFuture<Void> dispatchTerminatingEvent(IComponentAdapter adapter,
                                     long creationtime,
                                     IModelInfo model,
                                     IServiceProvider provider,
                                     Collection<IComponentListener> componentlisteners)

Dispatch a "component terminating" event.

Parameters:

adapter - Component adapter.

creationtime - Creation time of the component.

model - Component model.

provider - Component service provider.

componentlisteners - Listeners of the component.

finished - Future, called when the event has been dispatched.