org.objectweb.kilim.description
Class Provider

java.lang.Object
  extended byorg.objectweb.kilim.description.TemplateElementImpl
      extended byorg.objectweb.kilim.description.BasicNamedElementImpl
          extended byorg.objectweb.kilim.description.Provider
All Implemented Interfaces:
BasicElement, BasicNamedElement, java.lang.Cloneable, NamedElement, TemplateElement

public class Provider
extends BasicNamedElementImpl

Author:
horn

Field Summary
private  BasicElement source
           
 
Fields inherited from class org.objectweb.kilim.description.BasicNamedElementImpl
 
Fields inherited from class org.objectweb.kilim.description.TemplateElementImpl
 
Constructor Summary
Provider(java.lang.String aName, int aStatus, boolean isT, TemplateDescription aTemplate)
          a public constructor for providers.
Provider(java.lang.String aName, int aStatus, TemplateDescription aTemplate)
          a public constructor for providers.
 
Method Summary
 int getKind()
          returns the element kind.
 BasicElement getSource()
          returns the source.
 void setLocalName(java.lang.String aName)
          sets a name to the element.
 void setSource(BasicElement aSource)
          sets the source of the provider.
 void setStatus(int aStatus)
          sets the element status.
 
Methods inherited from class org.objectweb.kilim.description.BasicNamedElementImpl
getLocalName, getStatus, isEventSource, performsAction, providesValue, setContainingTemplate, toString
 
Methods inherited from class org.objectweb.kilim.description.TemplateElementImpl
clone, getContainingTemplate, getTemplateDefHierarchy
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.objectweb.kilim.description.TemplateElement
clone, getContainingTemplate, getTemplateDefHierarchy
 

Field Detail

source

private BasicElement source
Constructor Detail

Provider

public Provider(java.lang.String aName,
                int aStatus,
                boolean isT,
                TemplateDescription aTemplate)
         throws KilimException
a public constructor for providers.

Parameters:
aName - : the local name of the provider
aStatus - : the status of the provider. It should be one of KILIM.PRIVATE, KILIM.PROTECTED, KILIM.PUBLIC.
isT - : is true if the provider can also be used as a transformer.
aTemplate - : the template in which the provider is defined
Throws:
KilimException - : generated if aName or aTemplate is null or if the value for aStatus is invalid.

Provider

public Provider(java.lang.String aName,
                int aStatus,
                TemplateDescription aTemplate)
         throws KilimException
a public constructor for providers. The constructor equivalent to this(aName, aStatus, false, aTemplate);

Parameters:
aName - : the local name of the provider
aStatus - : the status of the provider. It should be one of KILIM.PRIVATE, KILIM.PROTECTED, KILIM.PUBLIC.
aTemplate - : the template in which the provider is defined
Throws:
KilimException - : generated if aName or aTemplate is null or if the value for aStatus is invalid.
Method Detail

getKind

public int getKind()
Description copied from interface: BasicElement
returns the element kind.

Returns:
int
See Also:
BasicElement.getKind()

setSource

public void setSource(BasicElement aSource)
               throws KilimException
sets the source of the provider.

Parameters:
aSource - : the element providing the value.
Throws:
KilimException - : generated when the element provided as an argument does not provide a value.

getSource

public BasicElement getSource()
                       throws KilimException
returns the source.

Returns:
InlinedElement
Throws:
KilimException - :

setLocalName

public void setLocalName(java.lang.String aName)
                  throws KilimException
Description copied from interface: NamedElement
sets a name to the element.

Specified by:
setLocalName in interface NamedElement
Overrides:
setLocalName in class BasicNamedElementImpl
Throws:
KilimException
See Also:
org.objectweb.kilim.description.TemplateElement#setLocalName(String)

setStatus

public void setStatus(int aStatus)
               throws KilimException
Description copied from interface: NamedElement
sets the element status.

Specified by:
setStatus in interface NamedElement
Overrides:
setStatus in class BasicNamedElementImpl
Throws:
KilimException
See Also:
org.objectweb.kilim.description.TemplateElement#setStatus(int)