Class BasicComponentCreator
BasicComponent
. It is used to create the 'BasicComponent' object step-by-step,
i.e. 'BasicComponentCreator' objects are of intermediate state.- See Also:
-
BasicComponent
-
Field Summary
Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.components.Component
providedRoles, requiredRoles, resourceRequiredRoles
Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity
repository
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
addVariableUsage
(org.palladiosimulator.pcm.parameter.VariableUsage varUsage) org.palladiosimulator.pcm.repository.BasicComponent
build()
Turns the entity in the making into the finished entity.conforms
(CompleteComponentTypeCreator completeComponentType) Creates a conforming (parental) connection to thecompleteComponentType
and adds it to the basic component.conforms
(org.palladiosimulator.pcm.repository.CompleteComponentType completeComponentType) Creates a conforming (parental) connection to thecompleteComponentType
and adds it to the basic component.emits
(EventGroupCreator eventGroup) Creates aSourceRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.emits
(EventGroupCreator eventGroup, String name) Creates aSourceRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component.emits
(org.palladiosimulator.pcm.repository.EventGroup eventGroup) Creates aSourceRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.Creates aSourceRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component.handles
(EventGroupCreator eventGroup) Creates aSinkRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.handles
(EventGroupCreator eventGroup, String name) Creates aSinkRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component.handles
(org.palladiosimulator.pcm.repository.EventGroup eventGroup) Creates aSinkRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.Creates aSinkRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component.ofType
(org.palladiosimulator.pcm.repository.ComponentType type) Sets the type of the basic component.
Possible values are 'BUSINESS_COMPONENT' (default) and 'INFRASTRUCTURE_COMPONENT'.provides
(OperationInterfaceCreator interfce) Creates anOperationProvidedRole
connection between the component and theOperationInterface
interfce
and adds it to the component.provides
(OperationInterfaceCreator interfce, String name) Creates anOperationProvidedRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component.provides
(org.palladiosimulator.pcm.repository.OperationInterface interfce) Creates anOperationProvidedRole
connection between the component and theOperationInterface
interfce
and adds it to the component.Creates anOperationProvidedRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component.Creates anInfrastructureProvidedRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.providesInfrastructure
(InfrastructureInterfaceCreator interfce, String name) Creates anInfrastructureProvidedRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component.providesInfrastructure
(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce) Creates anInfrastructureProvidedRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.providesInfrastructure
(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name) Creates anInfrastructureProvidedRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component.requires
(OperationInterfaceCreator interfce) Creates anOperationRequiredRole
connection between the component and theOperationInterface
interfce
and adds it to the component.requires
(OperationInterfaceCreator interfce, String name) Creates anOperationRequiredRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component.requires
(org.palladiosimulator.pcm.repository.OperationInterface interfce) Creates anOperationRequiredRole
connection between the component and theOperationInterface
interfce
and adds it to the component.Creates anOperationRequiredRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component.Creates anInfrastructureRequiredRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.requiresInfrastructure
(InfrastructureInterfaceCreator interfce, String name) Creates anInfrastructureRequiredRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component.requiresInfrastructure
(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce) Creates anInfrastructureRequiredRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.requiresInfrastructure
(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name) Creates anInfrastructureRequiredRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component.requiresResource
(ResourceInterface resourceInterface) Creates aResourceRequiredRole
connection between the component and theResourceInterface
resourceInterface
and adds it to the component.requiresResource
(ResourceInterface resourceInterface, String name) Creates aResourceRequiredRole
connection with the namename
between the component and theResourceInterface
resourceInterface
and adds it to the component.Defines the unique name of this current entity.withPassiveResource
(String capacityStochasticExpression, org.palladiosimulator.pcm.reliability.ResourceTimeoutFailureType failureType) Adds a passive resource (e.g.withPassiveResource
(String capacityStochasticExpression, org.palladiosimulator.pcm.reliability.ResourceTimeoutFailureType failureType, String name) Adds a passive resource (e.g.Adds a service effect specification (SEFF) to the basic component.withServiceEffectSpecification
(org.palladiosimulator.pcm.seff.ServiceEffectSpecification seff) Adds a service effect specification (SEFF) to the basic component.withVariableUsage
(VariableUsageCreator variableUsage) Adds aVariableUsage
to the basic component.
-
Constructor Details
-
BasicComponentCreator
-
-
Method Details
-
withName
Description copied from class:Entity
Defines the unique name of this current entity. Once created entities are referenced by this name. Only entities with a unique name can be fetched from the model. -
ofType
Sets the type of the basic component.
Possible values are 'BUSINESS_COMPONENT' (default) and 'INFRASTRUCTURE_COMPONENT'.- Parameters:
type
-- Returns:
- the basic component in the making
-
provides
Description copied from class:Component
Creates anOperationProvidedRole
connection between the component and theOperationInterface
interfce
and adds it to the component.Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newOperationInterface()
. -
provides
Description copied from class:Component
Creates anOperationProvidedRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newOperationInterface()
. -
provides
public BasicComponentCreator provides(org.palladiosimulator.pcm.repository.OperationInterface interfce) Description copied from class:Component
Creates anOperationProvidedRole
connection between the component and theOperationInterface
interfce
and adds it to the component.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfOperationInterface(name)
. -
provides
public BasicComponentCreator provides(org.palladiosimulator.pcm.repository.OperationInterface interfce, String name) Description copied from class:Component
Creates anOperationProvidedRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfOperationInterface(name)
. -
providesInfrastructure
Description copied from class:Component
Creates anInfrastructureProvidedRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.Create a new infrastructure interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newInfrastructureInterface()
.- Overrides:
providesInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
providesInfrastructure
public BasicComponentCreator providesInfrastructure(InfrastructureInterfaceCreator interfce, String name) Description copied from class:Component
Creates anInfrastructureProvidedRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new infrastructure interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newInfrastructureInterface()
.- Overrides:
providesInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
providesInfrastructure
public BasicComponentCreator providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce) Description copied from class:Component
Creates anInfrastructureProvidedRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfInfrastructureInterface(name)
.- Overrides:
providesInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
providesInfrastructure
public BasicComponentCreator providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name) Description copied from class:Component
Creates anInfrastructureProvidedRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfInfrastructureInterface(name)
.- Overrides:
providesInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
handles
Description copied from class:Component
Creates aSinkRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newEventGroup()
. -
handles
Description copied from class:Component
Creates aSinkRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newEventGroup()
. -
handles
Description copied from class:Component
Creates aSinkRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.An existing
eventGroup
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfEventGroup(name)
. -
handles
public BasicComponentCreator handles(org.palladiosimulator.pcm.repository.EventGroup eventGroup, String name) Description copied from class:Component
Creates aSinkRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
eventGroup
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfEventGroup(name)
. -
requires
Description copied from class:Component
Creates anOperationRequiredRole
connection between the component and theOperationInterface
interfce
and adds it to the component.Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newOperationInterface()
. -
requires
Description copied from class:Component
Creates anOperationRequiredRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newOperationInterface()
. -
requires
public BasicComponentCreator requires(org.palladiosimulator.pcm.repository.OperationInterface interfce) Description copied from class:Component
Creates anOperationRequiredRole
connection between the component and theOperationInterface
interfce
and adds it to the component.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfOperationInterface(name)
. -
requires
public BasicComponentCreator requires(org.palladiosimulator.pcm.repository.OperationInterface interfce, String name) Description copied from class:Component
Creates anOperationRequiredRole
connection with the namename
between the component and theOperationInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfOperationInterface(name)
. -
requiresInfrastructure
Description copied from class:Component
Creates anInfrastructureRequiredRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.Create a new infrastructure interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newInfrastructureInterface()
.- Overrides:
requiresInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
requiresInfrastructure
public BasicComponentCreator requiresInfrastructure(InfrastructureInterfaceCreator interfce, String name) Description copied from class:Component
Creates anInfrastructureRequiredRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new infrastructure interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newInfrastructureInterface()
.- Overrides:
requiresInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
requiresInfrastructure
public BasicComponentCreator requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce) Description copied from class:Component
Creates anInfrastructureRequiredRole
connection between the component and theInfrastructureInterface
interfce
and adds it to the component.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfInfrastructureInterface(name)
.- Overrides:
requiresInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
requiresInfrastructure
public BasicComponentCreator requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name) Description copied from class:Component
Creates anInfrastructureRequiredRole
connection with the namename
between the component and theInfrastructureInterface
interfce
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
interfce
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfInfrastructureInterface(name)
.- Overrides:
requiresInfrastructure
in classComponent
- Returns:
- this component
- See Also:
-
emits
Description copied from class:Component
Creates aSourceRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newEventGroup()
. -
emits
Description copied from class:Component
Creates aSourceRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newEventGroup()
. -
emits
Description copied from class:Component
Creates aSourceRole
connection between the component and theEventGroup
eventGroup
and adds it to the component.An existing
eventGroup
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfEventGroup(name)
. -
emits
public BasicComponentCreator emits(org.palladiosimulator.pcm.repository.EventGroup eventGroup, String name) Description copied from class:Component
Creates aSourceRole
connection with the namename
between the component and theEventGroup
eventGroup
and adds it to the component. Setting thename
is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.An existing
eventGroup
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfEventGroup(name)
. -
conforms
Creates a conforming (parental) connection to thecompleteComponentType
and adds it to the basic component.Complete (Component) types abstract from the realization of components. They only contain provided and required roles omitting the components’ internal structure, i.e., the service effect specifications or assemblies.
The
completeComponentType
can be created using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.newCompleteComponentType()
.- Parameters:
completeComponentType
-- Returns:
- the basic component in the making
- See Also:
-
FluentRepositoryFactory.newCompleteComponentType()
ImplementationComponentType.getParentCompleteComponentTypes()
CompleteComponentType
-
conforms
public BasicComponentCreator conforms(org.palladiosimulator.pcm.repository.CompleteComponentType completeComponentType) Creates a conforming (parental) connection to thecompleteComponentType
and adds it to the basic component.Complete (Component) types abstract from the realization of components. They only contain provided and required roles omitting the components’ internal structure, i.e., the service effect specifications or assemblies.
An existing
completeComponentType
can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.fetchOfCompleteComponentType(name)
.- Parameters:
completeComponentType
-- Returns:
- the basic component in the making
- See Also:
-
FluentRepositoryFactory.fetchOfCompleteComponentType(String)
ImplementationComponentType.getParentCompleteComponentTypes()
CompleteComponentType
-
withPassiveResource
public BasicComponentCreator withPassiveResource(String capacityStochasticExpression, org.palladiosimulator.pcm.reliability.ResourceTimeoutFailureType failureType, String name) Adds a passive resource (e.g. a semaphore) with namename
to the basic component.The stochastic expression in
capacity_stochasticExpression
belongs to aPCMRandomVariable
and describes the capacity of the passive resource. The givenfailureType
is the failure type that represents a timeout failure of an acquiring action for this passive resource.- Parameters:
capacityStochasticExpression
- stochastic expression as a stringfailureType
- a resource timeout failurename
- unique name of the passive resource- Returns:
- the basic component in the making
- See Also:
-
PassiveResource
PCMRandomVariable
ResourceTimeoutFailureType
-
withPassiveResource
public BasicComponentCreator withPassiveResource(String capacityStochasticExpression, org.palladiosimulator.pcm.reliability.ResourceTimeoutFailureType failureType) Adds a passive resource (e.g. a semaphore) to the basic component.The stochastic expression in
capacity_stochasticExpression
belongs to aPCMRandomVariable
and describes the capacity of the passive resource. The givenfailureType
is the failure type that represents a timeout failure of an acquiring action for this passive resource.- Parameters:
capacityStochasticExpression
- stochastic expression as a stringfailureType
- a resource timeout failure- Returns:
- the basic component in the making
- See Also:
-
PassiveResource
PCMRandomVariable
ResourceTimeoutFailureType
-
withServiceEffectSpecification
Adds a service effect specification (SEFF) to the basic component.Service Effect Specification Models the effect of invoking a specific service of a basic component. Therefore, it references a signature from an Interface, for which the component takes a ProvidedRole, to identify the described service.
Create a new SEFF by using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.newSeff()
.- Parameters:
seff
-- Returns:
- the basic component in the making
- See Also:
-
FluentRepositoryFactory.newSeff()
ServiceEffectSpecification
ResourceDemandingSEFF
-
withServiceEffectSpecification
public BasicComponentCreator withServiceEffectSpecification(org.palladiosimulator.pcm.seff.ServiceEffectSpecification seff) Adds a service effect specification (SEFF) to the basic component.Service Effect Specification Models the effect of invoking a specific service of a basic component. Therefore, it references a signature from an Interface, for which the component takes a ProvidedRole, to identify the described service.
- Parameters:
seff
-- Returns:
- the basic component in the making
- See Also:
-
FluentRepositoryFactory.newSeff()
ServiceEffectSpecification
ResourceDemandingSEFF
-
build
public org.palladiosimulator.pcm.repository.BasicComponent build()Description copied from class:Entity
Turns the entity in the making into the finished entity. -
addVariableUsage
protected void addVariableUsage(org.palladiosimulator.pcm.parameter.VariableUsage varUsage)
-