Package org.optaplanner.core.impl.domain.entity.descriptor

Class EntityDescriptor<Solution_>

java.lang.Object

org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

public class EntityDescriptor<Solution_>
extends Object

Constructor Summary

Constructors

Constructor	Description
EntityDescriptor(SolutionDescriptor<Solution_> solutionDescriptor, Class<?> entityClass)

Method Summary

Modifier and Type	Method	Description
String	buildInvalidVariableNameExceptionMessage(String variableName)
int	countReinitializableVariables(Object entity)
int	countUninitializedVariables(Object entity)
List<Object>	extractEntities(Solution_ solution)
Collection<GenuineVariableDescriptor<Solution_>>	getDeclaredGenuineVariableDescriptors()
Collection<ShadowVariableDescriptor<Solution_>>	getDeclaredShadowVariableDescriptors()
Collection<VariableDescriptor<Solution_>>	getDeclaredVariableDescriptors()
SelectionSorter<Solution_,Object>	getDecreasingDifficultySorter()
SelectionFilter<Solution_,Object>	getEffectiveMovableEntitySelectionFilter()
Class<?>	getEntityClass()
long	getGenuineVariableCount()
GenuineVariableDescriptor<Solution_>	getGenuineVariableDescriptor(String variableName)
List<GenuineVariableDescriptor<Solution_>>	getGenuineVariableDescriptorList()
Collection<String>	getGenuineVariableNameSet()
Predicate<Object>	getHasNoNullVariables()
Predicate<Object>	getIsInitializedPredicate()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getHasNoNullVariables().
long	getMaximumValueCount(Solution_ solution, Object entity)
long	getProblemScale(Solution_ solution, Object entity)
ShadowVariableDescriptor<Solution_>	getShadowVariableDescriptor(String variableName)
Collection<ShadowVariableDescriptor<Solution_>>	getShadowVariableDescriptors()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
VariableDescriptor<Solution_>	getVariableDescriptor(String variableName)
Map<String,VariableDescriptor<Solution_>>	getVariableDescriptorMap()
boolean	hasAnyDeclaredGenuineVariableDescriptor()
boolean	hasAnyGenuineListVariables()
boolean	hasAnyGenuineVariables()
boolean	hasEffectiveMovableEntitySelectionFilter()
boolean	hasNoNullVariables(Object entity)
boolean	hasVariableDescriptor(String variableName)
boolean	isEntityInitializedOrPinned(ScoreDirector<Solution_> scoreDirector, Object entity)
boolean	isInitialized(Object entity)
boolean	isMovable(ScoreDirector<Solution_> scoreDirector, Object entity)
void	linkEntityDescriptors(DescriptorPolicy descriptorPolicy)
void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
boolean	matchesEntity(Object entity)
void	processAnnotations(DescriptorPolicy descriptorPolicy)
String	toString()
void	visitAllEntities(Solution_ solution, Consumer<Object> visitor)

Methods inherited from class java.lang.Object

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

Constructor Details

EntityDescriptor

public EntityDescriptor(SolutionDescriptor<Solution_> solutionDescriptor,
 Class<?> entityClass)

Method Details

getIsInitializedPredicate

@Deprecated(forRemoval=true)
public Predicate<Object> getIsInitializedPredicate()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer getHasNoNullVariables().

Using entityDescriptor::isInitialized directly breaks node sharing because it creates multiple instances of this Predicate.

Returns:

never null, always the same Predicate instance to isInitialized(Object)

getHasNoNullVariables

public Predicate<Object> getHasNoNullVariables()

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

linkEntityDescriptors

public void linkEntityDescriptors(DescriptorPolicy descriptorPolicy)

linkVariableDescriptors

public void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

getEntityClass

public Class<?> getEntityClass()

matchesEntity

public boolean matchesEntity(Object entity)

hasEffectiveMovableEntitySelectionFilter

public boolean hasEffectiveMovableEntitySelectionFilter()

getEffectiveMovableEntitySelectionFilter

public SelectionFilter<Solution_,Object> getEffectiveMovableEntitySelectionFilter()

getDecreasingDifficultySorter

public SelectionSorter<Solution_,Object> getDecreasingDifficultySorter()

getGenuineVariableNameSet

public Collection<String> getGenuineVariableNameSet()

getGenuineVariableDescriptor

public GenuineVariableDescriptor<Solution_> getGenuineVariableDescriptor(String variableName)

hasAnyGenuineVariables

public boolean hasAnyGenuineVariables()

hasAnyGenuineListVariables

public boolean hasAnyGenuineListVariables()

getGenuineVariableDescriptorList

public List<GenuineVariableDescriptor<Solution_>> getGenuineVariableDescriptorList()

getGenuineVariableCount

public long getGenuineVariableCount()

getShadowVariableDescriptors

public Collection<ShadowVariableDescriptor<Solution_>> getShadowVariableDescriptors()

getShadowVariableDescriptor

public ShadowVariableDescriptor<Solution_> getShadowVariableDescriptor(String variableName)

getVariableDescriptorMap

public Map<String,VariableDescriptor<Solution_>> getVariableDescriptorMap()

hasVariableDescriptor

public boolean hasVariableDescriptor(String variableName)

getVariableDescriptor

public VariableDescriptor<Solution_> getVariableDescriptor(String variableName)

hasAnyDeclaredGenuineVariableDescriptor

public boolean hasAnyDeclaredGenuineVariableDescriptor()

getDeclaredGenuineVariableDescriptors

public Collection<GenuineVariableDescriptor<Solution_>> getDeclaredGenuineVariableDescriptors()

getDeclaredShadowVariableDescriptors

public Collection<ShadowVariableDescriptor<Solution_>> getDeclaredShadowVariableDescriptors()

getDeclaredVariableDescriptors

public Collection<VariableDescriptor<Solution_>> getDeclaredVariableDescriptors()

buildInvalidVariableNameExceptionMessage

public String buildInvalidVariableNameExceptionMessage(String variableName)

extractEntities

public List<Object> extractEntities(Solution_ solution)

visitAllEntities

public void visitAllEntities(Solution_ solution,
 Consumer<Object> visitor)

getMaximumValueCount

public long getMaximumValueCount(Solution_ solution,
 Object entity)

getProblemScale

public long getProblemScale(Solution_ solution,
 Object entity)

countUninitializedVariables

public int countUninitializedVariables(Object entity)

isInitialized

public boolean isInitialized(Object entity)

hasNoNullVariables

public boolean hasNoNullVariables(Object entity)

countReinitializableVariables

public int countReinitializableVariables(Object entity)

isMovable

public boolean isMovable(ScoreDirector<Solution_> scoreDirector,
 Object entity)

isEntityInitializedOrPinned

public boolean isEntityInitializedOrPinned(ScoreDirector<Solution_> scoreDirector,
 Object entity)

Parameters:

scoreDirector - never null

entity - never null

Returns:

true if the entity is initialized or pinned

toString

public String toString()

Overrides:

toString in class Object