Package org.palladiosimulator.generator.fluent.repository.structure.components

Class Component

java.lang.Object

org.palladiosimulator.generator.fluent.shared.structure.Entity

org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity

org.palladiosimulator.generator.fluent.repository.structure.components.Component

Direct Known Subclasses:

BasicComponentCreator, CompleteComponentTypeCreator, ComplexComponent, ProvidesComponentTypeCreator

public abstract class Component
extends RepositoryEntity

This class provides the general infrastructure of a component, i.e. BasicComponent CompositeComponent, SubSystem, CompleteComponentTypea and ProvidesComponentType. It provides the implementation of the methods for creating role connections (ProvidedRole, RequiredRole, ResourceRequiredRole).

Field Summary

Fields

Modifier and Type	Field	Description
protected List<org.palladiosimulator.pcm.repository.ProvidedRole>	providedRoles
protected List<org.palladiosimulator.pcm.repository.RequiredRole>	requiredRoles
protected List<org.palladiosimulator.pcm.core.entity.ResourceRequiredRole>	resourceRequiredRoles

Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity

repository

Fields inherited from class org.palladiosimulator.generator.fluent.shared.structure.Entity

name

Constructor Summary

Constructors

Constructor	Description
Component()

Method Summary

Modifier and Type	Method	Description
abstract org.palladiosimulator.pcm.repository.RepositoryComponent	build()	Turns the entity in the making into the finished entity.
Component	emits(EventGroupCreator eventGroup)	Creates a SourceRole connection between the component and the EventGroup eventGroup and adds it to the component.
Component	emits(EventGroupCreator eventGroup, String name)	Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component.
Component	emits(org.palladiosimulator.pcm.repository.EventGroup eventGroup)	Creates a SourceRole connection between the component and the EventGroup eventGroup and adds it to the component.
Component	emits(org.palladiosimulator.pcm.repository.EventGroup eventGroup, String name)	Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component.
Component	handles(EventGroupCreator eventGroup)	Creates a SinkRole connection between the component and the EventGroup eventGroup and adds it to the component.
Component	handles(EventGroupCreator eventGroup, String name)	Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component.
Component	handles(org.palladiosimulator.pcm.repository.EventGroup eventGroup)	Creates a SinkRole connection between the component and the EventGroup eventGroup and adds it to the component.
Component	handles(org.palladiosimulator.pcm.repository.EventGroup eventGroup, String name)	Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component.
Component	provides(OperationInterfaceCreator interfce)	Creates an OperationProvidedRole connection between the component and the OperationInterface interfce and adds it to the component.
Component	provides(OperationInterfaceCreator interfce, String name)	Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component.
Component	provides(org.palladiosimulator.pcm.repository.OperationInterface interfce)	Creates an OperationProvidedRole connection between the component and the OperationInterface interfce and adds it to the component.
Component	provides(org.palladiosimulator.pcm.repository.OperationInterface interfce, String name)	Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component.
Component	providesInfrastructure(InfrastructureInterfaceCreator interfce)	Creates an InfrastructureProvidedRole connection between the component and the InfrastructureInterface interfce and adds it to the component.
Component	providesInfrastructure(InfrastructureInterfaceCreator interfce, String name)	Creates an InfrastructureProvidedRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component.
Component	providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)	Creates an InfrastructureProvidedRole connection between the component and the InfrastructureInterface interfce and adds it to the component.
Component	providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name)	Creates an InfrastructureProvidedRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component.
Component	requires(OperationInterfaceCreator interfce)	Creates an OperationRequiredRole connection between the component and the OperationInterface interfce and adds it to the component.
Component	requires(OperationInterfaceCreator interfce, String name)	Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component.
Component	requires(org.palladiosimulator.pcm.repository.OperationInterface interfce)	Creates an OperationRequiredRole connection between the component and the OperationInterface interfce and adds it to the component.
Component	requires(org.palladiosimulator.pcm.repository.OperationInterface interfce, String name)	Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component.
Component	requiresInfrastructure(InfrastructureInterfaceCreator interfce)	Creates an InfrastructureRequiredRole connection between the component and the InfrastructureInterface interfce and adds it to the component.
Component	requiresInfrastructure(InfrastructureInterfaceCreator interfce, String name)	Creates an InfrastructureRequiredRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component.
Component	requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)	Creates an InfrastructureRequiredRole connection between the component and the InfrastructureInterface interfce and adds it to the component.
Component	requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce, String name)	Creates an InfrastructureRequiredRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component.
Component	requiresResource(ResourceInterface resourceInterface)	Creates a ResourceRequiredRole connection between the component and the ResourceInterface resourceInterface and adds it to the component.
Component	requiresResource(ResourceInterface resourceInterface, String name)	Creates a ResourceRequiredRole connection with the name name between the component and the ResourceInterface resourceInterface and adds it to the component.

Methods inherited from class org.palladiosimulator.generator.fluent.shared.structure.Entity

withName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

providedRoles

protected List<org.palladiosimulator.pcm.repository.ProvidedRole> providedRoles

requiredRoles

protected List<org.palladiosimulator.pcm.repository.RequiredRole> requiredRoles

resourceRequiredRoles

protected List<org.palladiosimulator.pcm.core.entity.ResourceRequiredRole> resourceRequiredRoles

Constructor Detail

Component

public Component()

Method Detail

build

public abstract org.palladiosimulator.pcm.repository.RepositoryComponent build()

Description copied from class: Entity

Turns the entity in the making into the finished entity.

Specified by:

build in class Entity

Returns:

the finished entity

provides

public Component provides(OperationInterfaceCreator interfce)

Creates an OperationProvidedRole connection between the component and the OperationInterface 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().

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.newOperationInterface()

provides

public Component provides(OperationInterfaceCreator interfce,
                          String name)

Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name 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().

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newOperationInterface()

provides

public Component provides(org.palladiosimulator.pcm.repository.OperationInterface interfce)

Creates an OperationProvidedRole connection between the component and the OperationInterface 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).

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfOperationInterface(String)

provides

public Component provides(org.palladiosimulator.pcm.repository.OperationInterface interfce,
                          String name)

Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name 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).

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfOperationInterface(String)

providesInfrastructure

public Component providesInfrastructure(InfrastructureInterfaceCreator interfce)

Creates an InfrastructureProvidedRole connection between the component and the InfrastructureInterface 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().

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.newInfrastructureInterface()

providesInfrastructure

public Component providesInfrastructure(InfrastructureInterfaceCreator interfce,
                                        String name)

Creates an InfrastructureProvidedRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name 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().

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newInfrastructureInterface()

providesInfrastructure

public Component providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)

Creates an InfrastructureProvidedRole connection between the component and the InfrastructureInterface 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).

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

providesInfrastructure

public Component providesInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce,
                                        String name)

Creates an InfrastructureProvidedRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name 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).

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

handles

public Component handles(EventGroupCreator eventGroup)

Creates a SinkRole connection between the component and the EventGroup 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().

Parameters:

eventGroup -

Returns:

this component

See Also:

FluentRepositoryFactory.newEventGroup()

handles

public Component handles(EventGroupCreator eventGroup,
                         String name)

Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name 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().

Parameters:

eventGroup -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newEventGroup()

handles

public Component handles(org.palladiosimulator.pcm.repository.EventGroup eventGroup)

Creates a SinkRole connection between the component and the EventGroup 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).

Parameters:

eventGroup -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfEventGroup(String)

handles

public Component handles(org.palladiosimulator.pcm.repository.EventGroup eventGroup,
                         String name)

Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name 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).

Parameters:

eventGroup -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfEventGroup(String)

requires

public Component requires(OperationInterfaceCreator interfce)

Creates an OperationRequiredRole connection between the component and the OperationInterface 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().

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.newOperationInterface()

requires

public Component requires(OperationInterfaceCreator interfce,
                          String name)

Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name 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().

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newOperationInterface()

requires

public Component requires(org.palladiosimulator.pcm.repository.OperationInterface interfce)

Creates an OperationRequiredRole connection between the component and the OperationInterface 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).

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfOperationInterface(String)

requires

public Component requires(org.palladiosimulator.pcm.repository.OperationInterface interfce,
                          String name)

Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name 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).

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfOperationInterface(String)

requiresInfrastructure

public Component requiresInfrastructure(InfrastructureInterfaceCreator interfce)

Creates an InfrastructureRequiredRole connection between the component and the InfrastructureInterface 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().

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.newInfrastructureInterface()

requiresInfrastructure

public Component requiresInfrastructure(InfrastructureInterfaceCreator interfce,
                                        String name)

Creates an InfrastructureRequiredRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name 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().

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newInfrastructureInterface()

requiresInfrastructure

public Component requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)

Creates an InfrastructureRequiredRole connection between the component and the InfrastructureInterface 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).

Parameters:

interfce -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

requiresInfrastructure

public Component requiresInfrastructure(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce,
                                        String name)

Creates an InfrastructureRequiredRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name 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).

Parameters:

interfce -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

emits

public Component emits(EventGroupCreator eventGroup)

Creates a SourceRole connection between the component and the EventGroup 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().

Parameters:

eventGroup -

Returns:

this component

See Also:

FluentRepositoryFactory.newEventGroup()

emits

public Component emits(EventGroupCreator eventGroup,
                       String name)

Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name 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().

Parameters:

eventGroup -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.newEventGroup()

emits

public Component emits(org.palladiosimulator.pcm.repository.EventGroup eventGroup)

Creates a SourceRole connection between the component and the EventGroup 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).

Parameters:

eventGroup -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfEventGroup(String)

emits

public Component emits(org.palladiosimulator.pcm.repository.EventGroup eventGroup,
                       String name)

Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name 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).

Parameters:

eventGroup -

name -

Returns:

this component

See Also:

FluentRepositoryFactory.fetchOfEventGroup(String)

requiresResource

public Component requiresResource(ResourceInterface resourceInterface)

Creates a ResourceRequiredRole connection between the component and the ResourceInterface resourceInterface and adds it to the component.

An existing resourceInterface can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.fetchOfResourceInterface(name).

Parameters:

resourceInterface -

name -

Returns:

this component

See Also:

org.palladiosimulator.generator.fluent.repository.factory.FluentRepositoryFactory#fetchOfResourceInterface(String)

requiresResource

public Component requiresResource(ResourceInterface resourceInterface,
                                  String name)

Creates a ResourceRequiredRole connection with the name name between the component and the ResourceInterface resourceInterface and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

An existing resourceInterface can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.fetchOfResourceInterface(name).

Parameters:

resourceInterface -

name -

Returns:

this component

See Also:

org.palladiosimulator.generator.fluent.repository.factory.FluentRepositoryFactory#fetchOfResourceInterface(String)