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

Interface GenuineEntityMetaModel<Solution_,Entity_>

Type Parameters:

Solution_ - The solution type.

Entity_ - The entity type.

All Superinterfaces:

PlanningEntityMetaModel<Solution_,Entity_>

All Known Implementing Classes:

DefaultGenuineEntityMetaModel

@NullMarked
public non-sealed interface GenuineEntityMetaModel<Solution_,Entity_>
extends PlanningEntityMetaModel<Solution_,Entity_>

Represents the meta-model of a genuine planning entity, an entity that has at least one genuine planning variable, and may also have shadow variables. Gives access to the entity's variable meta-models.

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
<Value_> PlanningVariableMetaModel<Solution_,Entity_,Value_>	basicVariable()	As defined by genuineVariable(), but only succeeds if the variable is a basic planning variable.
<Value_> PlanningVariableMetaModel<Solution_,Entity_,Value_>	basicVariable(String variableName)	As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a basic planning variable.
<Value_> PlanningVariableMetaModel<Solution_,Entity_,Value_>	basicVariable(String variableName, Class<Value_> variableClass)	As defined by basicVariable(String), but only succeeds if the variable is of a given type.
<Value_> GenuineVariableMetaModel<Solution_,Entity_,Value_>	genuineVariable()	Returns a single genuine variable declared by the entity.
<Value_> GenuineVariableMetaModel<Solution_,Entity_,Value_>	genuineVariable(String variableName)	Returns a PlanningVariableMetaModel for a variable with the given name.
<Value_> GenuineVariableMetaModel<Solution_,Entity_,Value_>	genuineVariable(String variableName, Class<Value_> variableClass)	Returns a PlanningVariableMetaModel for a variable with the given name.
default List<GenuineVariableMetaModel<Solution_,Entity_,?>>	genuineVariables()	Returns the genuine variables declared by the entity.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	listVariable()	As defined by genuineVariable(), but only succeeds if the variable is a planning list variable.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	listVariable(String variableName)	As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a planning list variable.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	listVariable(String variableName, Class<Value_> variableClass)	As defined by listVariable(String), but only succeeds if the variable is of a given type.
<Value_> ShadowVariableMetaModel<Solution_,Entity_,Value_>	shadowVariable(String variableName)	As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a shadow variable.
<Value_> ShadowVariableMetaModel<Solution_,Entity_,Value_>	shadowVariable(String variableName, Class<Value_> variableClass)	As defined by shadowVariable(String), but only succeeds if the variable is of a given type.

Methods inherited from interface ai.timefold.solver.core.preview.api.domain.metamodel.PlanningEntityMetaModel

hasVariable, isGenuine, solution, type, variable, variable, variables

Method Details

genuineVariables

default List<GenuineVariableMetaModel<Solution_,Entity_,?>> genuineVariables()

Returns the genuine variables declared by the entity.

Returns:

Genuine variables declared by the entity.

genuineVariable

<Value_>
GenuineVariableMetaModel<Solution_,Entity_,Value_> genuineVariable()

Returns a single genuine variable declared by the entity.

Type Parameters:

Value_ - The type of the value of the variable.

Returns:

The single genuine variable declared by the entity.

genuineVariable

<Value_>
GenuineVariableMetaModel<Solution_,Entity_,Value_> genuineVariable(String variableName)

Returns a PlanningVariableMetaModel for a variable with the given name.

Returns:

A genuine variable declared by the entity.

genuineVariable

<Value_>
GenuineVariableMetaModel<Solution_,Entity_,Value_> genuineVariable(String variableName,
 Class<Value_> variableClass)

Returns a PlanningVariableMetaModel for a variable with the given name.

Returns:

A genuine variable declared by the entity.

basicVariable

<Value_>
PlanningVariableMetaModel<Solution_,Entity_,Value_> basicVariable()

As defined by genuineVariable(), but only succeeds if the variable is a basic planning variable.

basicVariable

<Value_>
PlanningVariableMetaModel<Solution_,Entity_,Value_> basicVariable(String variableName)

As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a basic planning variable.

basicVariable

<Value_>
PlanningVariableMetaModel<Solution_,Entity_,Value_> basicVariable(String variableName,
 Class<Value_> variableClass)

As defined by basicVariable(String), but only succeeds if the variable is of a given type.

listVariable

<Value_>
PlanningListVariableMetaModel<Solution_,Entity_,Value_> listVariable()

As defined by genuineVariable(), but only succeeds if the variable is a planning list variable.

listVariable

<Value_>
PlanningListVariableMetaModel<Solution_,Entity_,Value_> listVariable(String variableName)

As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a planning list variable.

listVariable

<Value_>
PlanningListVariableMetaModel<Solution_,Entity_,Value_> listVariable(String variableName,
 Class<Value_> variableClass)

As defined by listVariable(String), but only succeeds if the variable is of a given type.

shadowVariable

<Value_>
ShadowVariableMetaModel<Solution_,Entity_,Value_> shadowVariable(String variableName)

As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a shadow variable.

shadowVariable

<Value_>
ShadowVariableMetaModel<Solution_,Entity_,Value_> shadowVariable(String variableName,
 Class<Value_> variableClass)

As defined by shadowVariable(String), but only succeeds if the variable is of a given type.