Package org.palladiosimulator.generator.fluent.usagemodel.structure

Class UsageModelCreator

java.lang.Object
org.palladiosimulator.generator.fluent.shared.structure.Entity
org.palladiosimulator.generator.fluent.usagemodel.structure.UsageModelEntity
org.palladiosimulator.generator.fluent.usagemodel.structure.UsageModelCreator
All Implemented Interfaces:
IUsageModel, IUsageModelAddition
public class UsageModelCreator extends UsageModelEntity implements IUsageModel, IUsageModelAddition
This class constructs a Usage Model. It is used to create the 'Usage Model' object step-by-step, i.e. 'UsageModelCreator' objects are of intermediate state.
See Also:
  • UsageModel

  • Constructor Details

  • Method Details

    • createUsageModelNow

      public org.palladiosimulator.pcm.usagemodel.UsageModel createUsageModelNow()
      Description copied from interface: IUsageModelAddition
      Turns this usageModel-in-the-making into a Palladio-'UsageModel' object.
      Specified by:
      createUsageModelNow in interface IUsageModelAddition
      Returns:
      the final UsageModel object
      See Also:
      • UsageModel

    • build

      protected org.palladiosimulator.pcm.usagemodel.UsageModel 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

    • addToUsageModel

      public IUsageModelAddition addToUsageModel(UserDataCreator userData)
      Adds a UserData to the usage model.

      UserData characterises data used in specific assembly contexts in the system. This data is the same for all UsageScenarios, i.e.,multiple users accessing the same components access the same data. This UserData refers to component parameters of the system publicized by the software architect (see pcm::parameters package). The domain expert characterises the values of component parameters related to business concepts (e.g., user specific data,data specific for a business domain), whereas the software architect characterises the values of component parameters related to technical concepts (e.g., size of caches, size of a thread pool, configuration data,etc.). One UserData instance includes all parameter characterisation for the annotated entity.

      Create a new user data by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newUserData(AssemblyContext context).

      Specified by:
      addToUsageModel in interface IUsageModelAddition
      Parameters:
      userData - in the making
      Returns:
      the usage model in the making
      See Also:

    • addToUsageModel

      public IUsageModelAddition addToUsageModel(UsageScenarioCreator usageScenario)
      Adds a Usage Scenario to the usage model.

      UsageScenarios are concurrently executed behaviours of users within one UsageModel. It describes which services are directly invoked by users in one specific use case and models the possible sequences of calling them. Each UsageScenario includes a workload and a scenario behaviour.

      Create a new usage scenario by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newUsageScenario(ScenarioBehaviourCreator scenarioBehavior, WorkloadCreator workload).

      Specified by:
      addToUsageModel in interface IUsageModelAddition
      Parameters:
      usage - scenario in the making
      Returns:
      the usage model in the making
      See Also: