org.eclipse.stp.core.sca
Interface Composite

All Superinterfaces:
SCAObject
All Known Subinterfaces:
Module, ModuleFragment, Subsystem

public interface Composite
extends SCAObject

A representation of the model object 'Composite'.

This interface is not intended to be implemented by clients.

The following features are supported:

See Also:
SCAPackage.getComposite()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List getAllMatchingSources(WireTarget wireTarget)
           
 java.util.List getAllMatchingTargets(WireSource wireSource)
           
 java.util.Collection getAllWiredSources(WireTarget wireTarget)
          Return a list of all WireSource elements within this Composite which are wired to the passed wireTarget.
 Component getComponent(java.lang.String componentName)
           
 java.util.List getComponents()
          Returns the value of the 'Components' containment reference list.
 EntryPoint getEntryPoint(java.lang.String name)
          Return an EntryPoint with a matching name.
 java.util.List getEntryPoints()
          Returns the value of the 'Entry Points' containment reference list.
 ExternalService getExternalService(java.lang.String name)
          Return an ExternalService with a matching name.
 java.util.List getExternalServices()
          Returns the value of the 'External Services' containment reference list.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 WireSource resolveWireSource(java.lang.String sourceURI)
          Use this API to resolve soure URIs to a WireSource within the composite.
 WireTarget resolveWireTarget(java.lang.String targetURI)
          Use this API to resolve target URIs to a WireTarget within the composite.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 
Methods inherited from interface org.eclipse.stp.core.sca.SCAObject
addStatus, clearStatus, getEObject, getFlags, getStatus
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getEntryPoints

java.util.List getEntryPoints()
Returns the value of the 'Entry Points' containment reference list. The list contents are of type EntryPoint.

If the meaning of the 'Entry Points' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Entry Points' containment reference list.
See Also:
SCAPackage.getComposite_EntryPoints()

getExternalServices

java.util.List getExternalServices()
Returns the value of the 'External Services' containment reference list. The list contents are of type ExternalService.

If the meaning of the 'External Services' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'External Services' containment reference list.
See Also:
SCAPackage.getComposite_ExternalServices()

getComponents

java.util.List getComponents()
Returns the value of the 'Components' containment reference list. The list contents are of type Component.

If the meaning of the 'Components' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Components' containment reference list.
See Also:
SCAPackage.getComposite_Components()

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Specified by:
getName in interface SCAObject
Returns:
the value of the 'Name' attribute.
See Also:
setName(String), SCAPackage.getComposite_Name()

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Specified by:
setName in interface SCAObject
Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getAllMatchingTargets

java.util.List getAllMatchingTargets(WireSource wireSource)
Parameters:
wireSource - A non-null WireSource (generally one of 'EntryPoint' or 'ReferenceValue'
Returns:
The current set of possible targets for the given wireSource

getAllMatchingSources

java.util.List getAllMatchingSources(WireTarget wireTarget)
Parameters:
wireTarget - a non-null WireTarget (generally one of 'ExternalService' or 'Service')
Returns:
The current set of possible sources for the given wireTarget

getAllWiredSources

java.util.Collection getAllWiredSources(WireTarget wireTarget)
Return a list of all WireSource elements within this Composite which are wired to the passed wireTarget.

Parameters:
wireTarget -
Returns:
Collection
See Also:
WireSource

getExternalService

ExternalService getExternalService(java.lang.String name)
Return an ExternalService with a matching name.

Parameters:
name -
Returns:
ExternalService

getEntryPoint

EntryPoint getEntryPoint(java.lang.String name)
Return an EntryPoint with a matching name.

Parameters:
name -
Returns:
EntryPoint

resolveWireTarget

WireTarget resolveWireTarget(java.lang.String targetURI)
Use this API to resolve target URIs to a WireTarget within the composite. The targetURI in the form "[Component name]/[opt service name]" when pointing to a service on a Component. The service name is optional if there is only one service on the Component. It is an error condition if the service name is not provided and there is more than one service on the component. In this situation the targetInterface is optional. The targetURI for an ExternalService will be in the form "[ExternalService name]". No service name is required for an ExternalService since it is by definition a single service. In this situation the targetInterface is optional.

Parameters:
targetURI -
Returns:
WireTarget

resolveWireSource

WireSource resolveWireSource(java.lang.String sourceURI)
Use this API to resolve soure URIs to a WireSource within the composite. The sourceURI in the form "[Component name]/[reference name]" when pointing to a reference on a Component. The sourceURI for an EntryPoint will be in the form "[EntryPoint name]".

Parameters:
sourceURI -
Returns:
WireSource

getComponent

Component getComponent(java.lang.String componentName)
Parameters:
componentName - The name of configurable to search for
Returns:
The specific Component of the given name, if available or null otherwise.