org.optaplanner.core.impl.domain.solution.descriptor

Class SolutionDescriptor

java.lang.Object

org.optaplanner.core.impl.domain.solution.descriptor.SolutionDescriptor

public class SolutionDescriptor
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SolutionDescriptor(Class<? extends Solution> solutionClass)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntityDescriptor(EntityDescriptor entityDescriptor)
void	afterAnnotationsProcessed(DescriptorPolicy descriptorPolicy)
int	countReinitializableVariables(ScoreDirector scoreDirector, Solution solution)
int	countUninitializedVariables(Solution solution)
Iterator<Object>	extractAllEntitiesIterator(Solution solution)
Class<? extends Score>	extractScoreClass()
EntityDescriptor	findEntityDescriptor(Class<?> entitySubclass)
EntityDescriptor	findEntityDescriptorOrFail(Class<?> entitySubclass)
GenuineVariableDescriptor	findGenuineVariableDescriptor(Object entity, String variableName)
GenuineVariableDescriptor	findGenuineVariableDescriptorOrFail(Object entity, String variableName)
VariableDescriptor	findVariableDescriptor(Object entity, String variableName)
VariableDescriptor	findVariableDescriptorOrFail(Object entity, String variableName)
Collection<Object>	getAllFacts(Solution solution)
Set<Class<?>>	getEntityClassSet()
Map<String,MemberAccessor>	getEntityCollectionPropertyAccessorMap()
int	getEntityCount(Solution solution)
Collection<EntityDescriptor>	getEntityDescriptors()
EntityDescriptor	getEntityDescriptorStrict(Class<?> entityClass)
List<Object>	getEntityList(Solution solution)
List<Object>	getEntityListByEntityClass(Solution solution, Class<?> entityClass)
Map<String,MemberAccessor>	getEntityPropertyAccessorMap()
Collection<EntityDescriptor>	getGenuineEntityDescriptors()
long	getProblemScale(Solution solution) Calculates an indication on how big this problem instance is.
Class<? extends Solution>	getSolutionClass()
SolutionCloner	getSolutionCloner()
int	getValueCount(Solution solution)
long	getVariableCount(Solution solution)
boolean	hasEntityDescriptor(Class<?> entitySubclass)
boolean	hasEntityDescriptorStrict(Class<?> entityClass)
boolean	isEntityInitializedOrImmovable(ScoreDirector scoreDirector, Object entity)
void	processAnnotations(DescriptorPolicy descriptorPolicy)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

Constructor Detail

SolutionDescriptor

public SolutionDescriptor(Class<? extends Solution> solutionClass)

Method Detail

addEntityDescriptor

public void addEntityDescriptor(EntityDescriptor entityDescriptor)

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

afterAnnotationsProcessed

public void afterAnnotationsProcessed(DescriptorPolicy descriptorPolicy)

getSolutionClass

public Class<? extends Solution> getSolutionClass()

extractScoreClass

public Class<? extends Score> extractScoreClass()

Returns:

the Class of Solution.getScore()

getSolutionCloner

public SolutionCloner getSolutionCloner()

getEntityPropertyAccessorMap

public Map<String,MemberAccessor> getEntityPropertyAccessorMap()

getEntityCollectionPropertyAccessorMap

public Map<String,MemberAccessor> getEntityCollectionPropertyAccessorMap()

getEntityClassSet

public Set<Class<?>> getEntityClassSet()

getEntityDescriptors

public Collection<EntityDescriptor> getEntityDescriptors()

getGenuineEntityDescriptors

public Collection<EntityDescriptor> getGenuineEntityDescriptors()

hasEntityDescriptorStrict

public boolean hasEntityDescriptorStrict(Class<?> entityClass)

getEntityDescriptorStrict

public EntityDescriptor getEntityDescriptorStrict(Class<?> entityClass)

hasEntityDescriptor

public boolean hasEntityDescriptor(Class<?> entitySubclass)

findEntityDescriptorOrFail

public EntityDescriptor findEntityDescriptorOrFail(Class<?> entitySubclass)

findEntityDescriptor

public EntityDescriptor findEntityDescriptor(Class<?> entitySubclass)

findGenuineVariableDescriptor

public GenuineVariableDescriptor findGenuineVariableDescriptor(Object entity,
                                                      String variableName)

findGenuineVariableDescriptorOrFail

public GenuineVariableDescriptor findGenuineVariableDescriptorOrFail(Object entity,
                                                            String variableName)

findVariableDescriptor

public VariableDescriptor findVariableDescriptor(Object entity,
                                        String variableName)

findVariableDescriptorOrFail

public VariableDescriptor findVariableDescriptorOrFail(Object entity,
                                              String variableName)

getAllFacts

public Collection<Object> getAllFacts(Solution solution)

getEntityCount

public int getEntityCount(Solution solution)

Parameters:

solution - never null

Returns:

>= 0

getEntityList

public List<Object> getEntityList(Solution solution)

getEntityListByEntityClass

public List<Object> getEntityListByEntityClass(Solution solution,
                                      Class<?> entityClass)

getVariableCount

public long getVariableCount(Solution solution)

Parameters:

solution - never null

Returns:

>= 0

getValueCount

public int getValueCount(Solution solution)

Parameters:

solution - never null

Returns:

>= 0

getProblemScale

public long getProblemScale(Solution solution)

Calculates an indication on how big this problem instance is. This is intentionally very loosely defined for now.

Parameters:

solution - never null

Returns:

>= 0

countUninitializedVariables

public int countUninitializedVariables(Solution solution)

isEntityInitializedOrImmovable

public boolean isEntityInitializedOrImmovable(ScoreDirector scoreDirector,
                                     Object entity)

Parameters:

scoreDirector - never null

entity - never null

Returns:

true if the entity is initialized or immovable

countReinitializableVariables

public int countReinitializableVariables(ScoreDirector scoreDirector,
                                Solution solution)

extractAllEntitiesIterator

public Iterator<Object> extractAllEntitiesIterator(Solution solution)

toString

public String toString()

Overrides:

toString in class Object