org.objectweb.kilim.model
Interface ComponentElement

All Known Subinterfaces:
Component, ComponentInterface, ComponentProperty, ComponentSlot, ComponentSource, ContainerElement
All Known Implementing Classes:
RtComponent, RtComponentElement, RtComponentInterface, RtComponentProperty, RtComponentSlot, RtSingleValuePort

public interface ComponentElement

Author:
horn

Method Summary
 Component getContainingComponent()
          returns a reference to the component containing the element.
 ContainerElement getContainingElement()
          returns a reference to the component or the slot containing the element.
 TemplateElementImpl getElementDescription()
          returns the "template description" of the component element.
 java.lang.String getLocalName()
          returns the local name of the component element.
 java.lang.String getQualifiedName()
          returns the fully qualified name of the component element.
 java.util.Iterator getTemplateDefHierarchy()
          returns all templates in which the element has been defined (and eventually redefined).
 

Method Detail

getContainingElement

public ContainerElement getContainingElement()
returns a reference to the component or the slot containing the element. It returns null when applied to the top level component.

Returns:
ContainerElement

getContainingComponent

public Component getContainingComponent()
returns a reference to the component containing the element. It returns null when applied to the top level component. It is equivalent to getContainingElement() for elements directly defined at a component level. It is equivalent to getContainingElement().getContainingElement() for elements defined at a slot level.

Returns:
Component

getElementDescription

public TemplateElementImpl getElementDescription()
returns the "template description" of the component element.

Returns:
TemplateElement

getTemplateDefHierarchy

public java.util.Iterator getTemplateDefHierarchy()
returns all templates in which the element has been defined (and eventually redefined). This method is mainly targeted to debugging.

Returns:
Iterator

getQualifiedName

public java.lang.String getQualifiedName()
returns the fully qualified name of the component element.

Returns:
String :

getLocalName

public java.lang.String getLocalName()
returns the local name of the component element.

Returns:
String