OptaPlanner core 6.0.0.Beta3

org.optaplanner.core.impl.domain.variable
Class PlanningVariableDescriptor

java.lang.Object
  extended by org.optaplanner.core.impl.domain.variable.PlanningVariableDescriptor

public class PlanningVariableDescriptor
extends Object


Constructor Summary
PlanningVariableDescriptor(PlanningEntityDescriptor planningEntityDescriptor, PropertyDescriptor propertyDescriptor)
           
 
Method Summary
 Collection<?> extractAllPlanningValues(Solution solution)
           
 Collection<?> extractPlanningValues(Solution solution, Object entity)
           
 PlanningEntityDescriptor getPlanningEntityDescriptor()
           
 Object getValue(Object entity)
           
 long getValueCount(Solution solution, Object entity)
           
 PlanningValueRangeDescriptor getValueRangeDescriptor()
           
 PlanningValueSorter getValueSorter()
          Deprecated. 
 String getVariableName()
           
 Class<?> getVariablePropertyType()
           
 boolean isChained()
           
 boolean isContinuous()
           
 boolean isInitialized(Object entity)
          A PlanningVariable.nullable() value is always considered initialized, but it can still be reinitialized with PlanningVariable.reinitializeVariableEntityFilter().
 boolean isNullable()
           
 boolean isPlanningValuesCacheable()
          Deprecated. 
 void processAnnotations()
           
 void setValue(Object entity, Object value)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PlanningVariableDescriptor

public PlanningVariableDescriptor(PlanningEntityDescriptor planningEntityDescriptor,
                                  PropertyDescriptor propertyDescriptor)
Method Detail

processAnnotations

public void processAnnotations()

getPlanningEntityDescriptor

public PlanningEntityDescriptor getPlanningEntityDescriptor()

getVariableName

public String getVariableName()

getVariablePropertyType

public Class<?> getVariablePropertyType()

isContinuous

public boolean isContinuous()
Returns:
true if the value range is continuous (as in for example every double value between 1.2 and 1.4)

isChained

public boolean isChained()

isNullable

public boolean isNullable()

getValueRangeDescriptor

public PlanningValueRangeDescriptor getValueRangeDescriptor()

isInitialized

public boolean isInitialized(Object entity)
A PlanningVariable.nullable() value is always considered initialized, but it can still be reinitialized with PlanningVariable.reinitializeVariableEntityFilter().

Parameters:
entity - never null
Returns:
true if the variable on that entity is initialized

getValue

public Object getValue(Object entity)

setValue

public void setValue(Object entity,
                     Object value)

extractAllPlanningValues

public Collection<?> extractAllPlanningValues(Solution solution)

extractPlanningValues

public Collection<?> extractPlanningValues(Solution solution,
                                           Object entity)

isPlanningValuesCacheable

@Deprecated
public boolean isPlanningValuesCacheable()
Deprecated. 


getValueSorter

@Deprecated
public PlanningValueSorter getValueSorter()
Deprecated. 


getValueCount

public long getValueCount(Solution solution,
                          Object entity)

toString

public String toString()
Overrides:
toString in class Object

OptaPlanner core 6.0.0.Beta3

Copyright © 2006-2013 JBoss by Red Hat. All Rights Reserved.