org.objectweb.kilim.model
Class RtExternalValue

java.lang.Object
  extended byorg.objectweb.kilim.model.RtComponentElement
      extended byorg.objectweb.kilim.model.RtComponentSource
          extended byorg.objectweb.kilim.model.RtExternalValue
All Implemented Interfaces:
ComponentElement, RuntimeElement, RuntimeSource

public class RtExternalValue
extends RtComponentSource

RtExternalValues are specific sources referencing external system entities i.e. entities not described by Kilim descriptors. RtExternalValues can be seen as special properties referencing objects without descriptors and runtime objects. Remark : Next Kilim implementation should define this class as an extension of ComponentProperty.

Author:
horn

Field Summary
private  java.lang.String name
           
private  java.lang.Object value
           
 
Fields inherited from class org.objectweb.kilim.model.RtComponentSource
knownValues, mapper, mappingContext, svpStack
 
Fields inherited from class org.objectweb.kilim.model.RtComponentElement
nbComponent, nbElement
 
Constructor Summary
RtExternalValue(java.lang.String aName, java.lang.Object aValue)
          The public constructor for external values (i.e.
 
Method Summary
 boolean checkValue(java.util.Stack exclude)
          returns whether a value can be obtained without having to create new objects
 java.lang.Object getEventSourceValue()
          Method gets the EventSourceValue.
 java.lang.String getLocalName()
          returns the local name of the component element.
 java.lang.Object getValue()
          Method getValue.
 boolean hasValue()
          returns whether the source has a value.
 boolean isEventSource()
          returns whether the source is an event source..
 void setEventSourceValue(java.lang.Object aSource)
          sets the EventSourceValue.
 
Methods inherited from class org.objectweb.kilim.model.RtComponentSource
addInterfaceListener, evaluationPerformed, getCurrentSVP, getInterfaceListeners, removeInterfaceListener
 
Methods inherited from class org.objectweb.kilim.model.RtComponentElement
containsElement, getContainingComponent, getContainingElement, getElement, getElementDescription, getNbComponent, getNbElement, getQualifiedName, getTarget, getTemplateDefHierarchy, removeElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.kilim.model.RuntimeSource
getTarget
 

Field Detail

name

private java.lang.String name

value

private java.lang.Object value
Constructor Detail

RtExternalValue

public RtExternalValue(java.lang.String aName,
                       java.lang.Object aValue)
The public constructor for external values (i.e. objects without kilim descriptor).

Parameters:
aName - : the name of the external value
aValue - : the object reference.
Method Detail

getLocalName

public java.lang.String getLocalName()
Description copied from interface: ComponentElement
returns the local name of the component element.

Returns:
String
See Also:
ComponentElement.getLocalName()

getValue

public java.lang.Object getValue()
                          throws KilimException
Description copied from interface: RuntimeSource
Method getValue.

Returns:
Object : the reference of the object provided by the source.
Throws:
KilimException - : the exception is generated when the method is invoked on unbound references or on illegal elements.
See Also:
RuntimeSource.getValue()

isEventSource

public boolean isEventSource()
Description copied from interface: RuntimeSource
returns whether the source is an event source..

Returns:
boolean : is true when the source is the current event source.
See Also:
RuntimeSource.isEventSource()

getEventSourceValue

public java.lang.Object getEventSourceValue()
                                     throws KilimException
Description copied from interface: RuntimeSource
Method gets the EventSourceValue.

Returns:
Object
Throws:
KilimException - : the exception is generated when the method is invoked on unbound references or on illegal elements.
See Also:
org.objectweb.kilim.model.RuntimeSource#getEventSource()

setEventSourceValue

public void setEventSourceValue(java.lang.Object aSource)
                         throws KilimException
Description copied from interface: RuntimeSource
sets the EventSourceValue.

Parameters:
aSource - :
Throws:
KilimException - : the exception is generated when the method is invoked on unbound references or on illegal elements.
See Also:
org.objectweb.kilim.model.RuntimeSource#setEventSource(Object)

hasValue

public boolean hasValue()
                 throws KilimException
Description copied from interface: RuntimeSource
returns whether the source has a value. The behaviour depends on the nature of the source. It always returns false when invoked on tagged providers, for example.

Returns:
boolean
Throws:
KilimException - :
See Also:
org.objectweb.kilim.model.RuntimeSource#checkValue()

checkValue

public boolean checkValue(java.util.Stack exclude)
                   throws KilimException
Description copied from interface: RuntimeSource
returns whether a value can be obtained without having to create new objects

Parameters:
exclude - : the exclude stack contains objects beiing in the process of being built.
Returns:
boolean
Throws:
KilimException - :
See Also:
RuntimeSource.checkValue(Stack)