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

Class UserDataCreator

java.lang.Object
org.palladiosimulator.generator.fluent.shared.structure.Entity
org.palladiosimulator.generator.fluent.usagemodel.structure.UsageModelEntity
org.palladiosimulator.generator.fluent.usagemodel.structure.components.UserDataCreator
public class UserDataCreator extends UsageModelEntity
This class constructs a User Data. It is used to create the 'User Data' object step-by-step, i.e. 'UserDataCreator' objects are of intermediate state.
See Also:
  • UserData

  • Constructor Details

    • UserDataCreator

      public UserDataCreator(UsageModelCreator usgModelCreator, org.palladiosimulator.pcm.core.composition.AssemblyContext context)
      Instantiates a new user data creator.

      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.

      Parameters:
      usgModelCreator - the usage model creator
      context - the assembly context
      See Also:
      • UserData
      • AssemblyContext

  • Method Details

    • addToUserData

      public UserDataCreator addToUserData(VariableUsageCreator variable)
      Adds an Variable Usage to the user data.

      Variable usages are used to characterise variables like input and output variables or component parameters. They contain the specification of the variable as VariableCharacterisation and also refer to the name of the characterised variable in its namedReference association. Note that it was an explicit design decision to refer to variable names instead of the actual variables (i.e., by refering to Parameter class). It eased the writing of transformations (DSolver as well as SimuCom) but put some complexity in the frontend for entering the variable usages.

      Create a new variable usage by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newVariableUsage(String variableReference) or create.newVariableUsage(String namespaceReference, String... innerReferences)

      Parameters:
      variable - usage in the making
      Returns:
      the user data in the making
      See Also:
      • VariableUsage

    • build

      public org.palladiosimulator.pcm.usagemodel.UserData 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