org.objectweb.kilim.description
Class EventSource

java.lang.Object
  org.objectweb.kilim.description.EventSource

All Implemented Interfaces:

BasicElement, java.lang.Cloneable, TemplateElement

public class EventSource

extends java.lang.Object

implements BasicElement

Author:

horn

Field Summary

static EventSource

EVENT_SOURCE EVENT_SOURCE is a singleton indicating that a parameter or a support is the trigger source

Constructor Summary

private

EventSource()

Method Summary

java.lang.Object	clone() clones a template
TemplateDescription	getContainingTemplate() returns the template in which the element is defined.
int	getKind() returns the element kind.
java.util.Iterator	getTemplateDefHierarchy() returns as an iterator all templates in which an element has been defined and overloaded.
boolean	isEventSource() indicates whether the element is an event source or not.
boolean	performsAction() Basic elements either provide values or exceute actions that complete the instatiation process This method.
boolean	providesValue() Basic elements either provide values or exceute actions that complete the instatiation process This method.
void	setContainingTemplate(TemplateDescription aTemplate) sets the template in which the element is defined.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_SOURCE

public static final EventSource EVENT_SOURCE

EVENT_SOURCE is a singleton indicating that a parameter or a support is the trigger source

Constructor Detail

EventSource

private EventSource()

Method Detail

isEventSource

public boolean isEventSource()

Description copied from interface: BasicElement

indicates whether the element is an event source or not.

Specified by:

isEventSource in interface BasicElement

Returns:

boolean

See Also:

org.objectweb.kilim.description.lang.Source#isEventSource()

providesValue

public boolean providesValue()

Description copied from interface: BasicElement

Basic elements either provide values or exceute actions that complete the instatiation process This method. indicates whether the element returns a value in the Kilim model. The result is true for providers, ports, properties, inlined getters inlined news, constructors, methods which do not return void. It also return true for references to the elements previously defined (i.e. ports, properties, .).

Specified by:

providesValue in interface BasicElement

Returns:

boolean

See Also:

org.objectweb.kilim.description.TemplateElement#providesValue()

performsAction

public boolean performsAction()

Description copied from interface: BasicElement

Basic elements either provide values or exceute actions that complete the instatiation process This method. indicates whether the element performs an action and can therefore been used in a trigger. The result is true for transformers, inlined setter, inlined news, methods, and constructors. It also return true for references to the elements previously defined (setters, methods, ...).

Specified by:

performsAction in interface BasicElement

Returns:

boolean

See Also:

org.objectweb.kilim.description.TemplateElement#performsAction()

getContainingTemplate

public TemplateDescription getContainingTemplate()

Description copied from interface: TemplateElement

returns the template in which the element is defined.

Specified by:

getContainingTemplate in interface TemplateElement

Returns:

Template

See Also:

TemplateElement.getContainingTemplate()

getTemplateDefHierarchy

public java.util.Iterator getTemplateDefHierarchy()

Description copied from interface: TemplateElement

returns as an iterator all templates in which an element has been defined and overloaded.

Specified by:

getTemplateDefHierarchy in interface TemplateElement

Returns:

Iterator

See Also:

TemplateElement.getTemplateDefHierarchy()

setContainingTemplate

public void setContainingTemplate(TemplateDescription aTemplate)
                           throws KilimException

Description copied from interface: TemplateElement

sets the template in which the element is defined.

Specified by:

setContainingTemplate in interface TemplateElement

Parameters:

aTemplate - : the template.

Throws:

KilimException - :

See Also:

TemplateElement.setContainingTemplate(TemplateDescription)

getKind

public int getKind()

Description copied from interface: BasicElement

returns the element kind.

Specified by:

getKind in interface BasicElement

Returns:

int

See Also:

BasicElement.getKind()

clone

public java.lang.Object clone()

Description copied from interface: TemplateElement

clones a template

Specified by:

clone in interface TemplateElement

See Also:

Object.clone()