Package ai.timefold.solver.core.impl.domain.solution.descriptor

Class DefaultGenuineEntityMetaModel<Solution_,Entity_>

java.lang.Object

ai.timefold.solver.core.impl.domain.solution.descriptor.DefaultGenuineEntityMetaModel<Solution_,Entity_>

All Implemented Interfaces:

GenuineEntityMetaModel<Solution_,Entity_>, PlanningEntityMetaModel<Solution_,Entity_>

@NullMarked
public final class DefaultGenuineEntityMetaModel<Solution_,Entity_>
extends Object
implements GenuineEntityMetaModel<Solution_,Entity_>

Method Summary

Modifier and Type	Method	Description
void	addVariable(VariableMetaModel<Solution_,Entity_,?> variable)
<Value_> PlanningVariableMetaModel<Solution_,Entity_,Value_>	basicVariable()	As defined by GenuineEntityMetaModel.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 GenuineEntityMetaModel.basicVariable(String), but only succeeds if the variable is of a given type.
EntityDescriptor<Solution_>	entityDescriptor()
<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.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	listVariable()	As defined by GenuineEntityMetaModel.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 GenuineEntityMetaModel.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 GenuineEntityMetaModel.shadowVariable(String), but only succeeds if the variable is of a given type.
PlanningSolutionMetaModel<Solution_>	solution()	Describes the PlanningSolution that owns this entity.
String	toString()
Class<Entity_>	type()	Returns the most specific class of the entity.
List<VariableMetaModel<Solution_,Entity_,?>>	variables()	Returns the variables declared by the entity, both genuine and shadow.

Methods inherited from class java.lang.Object

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

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

genuineVariables

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

hasVariable, isGenuine, variable, variable

Method Details

entityDescriptor

public EntityDescriptor<Solution_> entityDescriptor()

solution

public PlanningSolutionMetaModel<Solution_> solution()

Description copied from interface: PlanningEntityMetaModel

Describes the PlanningSolution that owns this entity.

Specified by:

solution in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

never null, the solution meta-model.

type

public Class<Entity_> type()

Description copied from interface: PlanningEntityMetaModel

Returns the most specific class of the entity.

Specified by:

type in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

The entity type.

variables

public List<VariableMetaModel<Solution_,Entity_,?>> variables()

Description copied from interface: PlanningEntityMetaModel

Returns the variables declared by the entity, both genuine and shadow.

Specified by:

variables in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

Variables declared by the entity.

genuineVariable

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

Description copied from interface: GenuineEntityMetaModel

Returns a single genuine variable declared by the entity.

Specified by:

genuineVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

Type Parameters:

Value_ - The type of the value of the variable.

Returns:

The single genuine variable declared by the entity.

genuineVariable

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

Description copied from interface: GenuineEntityMetaModel

Returns a PlanningVariableMetaModel for a variable with the given name.

Specified by:

genuineVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

Returns:

A genuine variable declared by the entity.

genuineVariable

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

Description copied from interface: GenuineEntityMetaModel

Returns a PlanningVariableMetaModel for a variable with the given name.

Specified by:

genuineVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

Returns:

A genuine variable declared by the entity.

basicVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

basicVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

basicVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

basicVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

basicVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

basicVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

listVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

listVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

listVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

listVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

listVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

listVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

shadowVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

shadowVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

shadowVariable

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

Description copied from interface: GenuineEntityMetaModel

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

Specified by:

shadowVariable in interface GenuineEntityMetaModel<Solution_,Entity_>

addVariable

public void addVariable(VariableMetaModel<Solution_,Entity_,?> variable)

toString

public String toString()

Overrides:

toString in class Object