org.objectweb.kilim.description
Class InlinedElement

java.lang.Object
  extended byorg.objectweb.kilim.description.TemplateElementImpl
      extended byorg.objectweb.kilim.description.InlinedElement
All Implemented Interfaces:
BasicElement, java.lang.Cloneable, TemplateElement
Direct Known Subclasses:
ArraySource, ClassSource, NullElement, TpAccessor, TpMethod

public abstract class InlinedElement
extends TemplateElementImpl
implements BasicElement

Author:
horn Superinterface of all of Template-contained constructs. Template

Field Summary
private  boolean isProvider
           
private  boolean isTransformer
           
private  java.lang.String name
           
 
Fields inherited from class org.objectweb.kilim.description.TemplateElementImpl
 
Constructor Summary
protected InlinedElement(boolean isP, boolean isT, TemplateDescription aTemplate)
          The protected constructor of an inlined element.
 
Method Summary
 java.lang.String getLocalName()
          Every Kilim element has a name (for debugging purposes).
 int getStatus()
           
 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 setLocalName(java.lang.String aName)
          sets the local name of an inlined element.
 void setStatus(int aStatus)
           
 
Methods inherited from class org.objectweb.kilim.description.TemplateElementImpl
clone, getContainingTemplate, getTemplateDefHierarchy, setContainingTemplate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.kilim.description.BasicElement
getKind
 
Methods inherited from interface org.objectweb.kilim.description.TemplateElement
clone, getContainingTemplate, getTemplateDefHierarchy, setContainingTemplate
 

Field Detail

isProvider

private boolean isProvider

isTransformer

private boolean isTransformer

name

private java.lang.String name
Constructor Detail

InlinedElement

protected InlinedElement(boolean isP,
                         boolean isT,
                         TemplateDescription aTemplate)
                  throws KilimException
The protected constructor of an inlined element.

Parameters:
isP - : is true when element is a provider
isT - : is true when the element is a transformer
aTemplate - : the templatye in which the element is defined.
Throws:
KilimException - :
Method Detail

getLocalName

public java.lang.String getLocalName()
Every Kilim element has a name (for debugging purposes). This method sets the local name of an inlined element.

Returns:
String

setLocalName

public void setLocalName(java.lang.String aName)
                  throws KilimException
sets the local name of an inlined element. This name is for debugging purpouse only.

Parameters:
aName - : the local name
Throws:
KilimException - : never generated.

setStatus

public void setStatus(int aStatus)
               throws KilimException
Throws:
KilimException
See Also:
org.objectweb.kilim.description.TemplateElement#setStatus(int)

getStatus

public int getStatus()
              throws KilimException
Throws:
KilimException
See Also:
org.objectweb.kilim.description.TemplateElement#getStatus()

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()

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.TemplateElement#isEventSource()