Package ai.timefold.solver.core.preview.api.domain.metamodel

Interface VariableMetaModel<Solution_,Entity_,Value_>

Type Parameters:
Solution_ -
Entity_ -
Value_ -
All Known Subinterfaces:
GenuineVariableMetaModel<Solution_,Entity_,Value_>, PlanningListVariableMetaModel<Solution_,Entity_,Value_>, PlanningVariableMetaModel<Solution_,Entity_,Value_>, ShadowVariableMetaModel<Solution_,Entity_,Value_>
All Known Implementing Classes:
DefaultPlanningListVariableMetaModel, DefaultPlanningVariableMetaModel, DefaultShadowVariableMetaModel
@NullMarked public sealed interface VariableMetaModel<Solution_,Entity_,Value_> permits GenuineVariableMetaModel<Solution_,Entity_,Value_>, ShadowVariableMetaModel<Solution_,Entity_,Value_>
Describes a variable in the domain model. See extending interfaces for more specific types of variables.

This package and all of its contents are part of the Neighborhoods API, which is under development and is only offered as a preview feature. There are no guarantees for backward compatibility; any class, method, or field may change or be removed without prior notice, although we will strive to avoid this as much as possible.

We encourage you to try the API and give us feedback on your experience with it, before we finalize the API. Please direct your feedback to Timefold Solver GitHub or to Timefold Discord.

  • Method Summary

    Modifier and Type
    Method
    Description
    PlanningEntityMetaModel<Solution_,Entity_>
    entity()
    Describes the entity that owns this variable.
    default boolean
    isGenuine()
    Returns true if this variable is a genuine (i.e. not shadow) variable.
    String
    name()
    Describes the name of this variable, which is typically a field name in the entity.
    Class<Value_>
    type()
    Describes the type of the value that this variable can hold.

  • Method Details

    • entity

      PlanningEntityMetaModel<Solution_,Entity_> entity()
      Describes the entity that owns this variable.
      Returns:
      never null

    • type

      Class<Value_> type()
      Describes the type of the value that this variable can hold.
      Returns:
      never null

    • name

      String name()
      Describes the name of this variable, which is typically a field name in the entity.
      Returns:
      never null

    • isGenuine

      default boolean isGenuine()
      Returns true if this variable is a genuine (i.e. not shadow) variable. Effectively checks if this variable is an instance of GenuineVariableMetaModel.
      Returns:
      true if this variable is genuine