Package ai.timefold.solver.core.impl.bavet.common

Class BavetAbstractConstraintStream<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStream<Solution_>

ai.timefold.solver.core.impl.bavet.common.BavetAbstractConstraintStream<Solution_>

All Implemented Interfaces:

ConstraintStream, BavetStream

Direct Known Subclasses:

BavetAbstractBiConstraintStream, BavetAbstractQuadConstraintStream, BavetAbstractTriConstraintStream, BavetAbstractUniConstraintStream

public abstract class BavetAbstractConstraintStream<Solution_>
extends AbstractConstraintStream<Solution_>
implements BavetStream

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<BavetAbstractConstraintStream<Solution_>>	childStreamList
protected final BavetConstraintFactory<Solution_>	constraintFactory
protected final BavetAbstractConstraintStream<Solution_>	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BavetAbstractConstraintStream(BavetConstraintFactory<Solution_> constraintFactory, BavetAbstractConstraintStream<Solution_> parent)
protected	BavetAbstractConstraintStream(BavetConstraintFactory<Solution_> constraintFactory, RetrievalSemantics retrievalSemantics)

Method Summary

Modifier and Type	Method	Description
protected void	assertEmptyChildStreamList()
protected <Score_ extends Score<Score_>> Constraint	buildConstraint(String constraintPackage, String constraintName, String description, String constraintGroup, Score_ constraintWeight, ScoreImpactType impactType, Object justificationFunction, Object indictedObjectsMapping, BavetScoringConstraintStream<Solution_> stream)
abstract <Score_ extends Score<Score_>> void	buildNode(ConstraintNodeBuildHelper<Solution_,Score_> buildHelper)
void	collectActiveConstraintStreams(Set<BavetAbstractConstraintStream<Solution_>> constraintStreamSet)
final List<BavetAbstractConstraintStream<Solution_>>	getChildStreamList()
@NonNull BavetConstraintFactory<Solution_>	getConstraintFactory()	The ConstraintFactory that build this.
final BavetAbstractConstraintStream<Solution_>	getParent()
BavetAbstractConstraintStream<Solution_>	getTupleSource()	Returns the stream which first produced the tuple that this stream operates on.
boolean	guaranteesDistinct()	Whether the stream guarantees that no two tuples it produces will ever have the same set of facts.
final <Stream_ extends BavetAbstractConstraintStream<Solution_>> Stream_	shareAndAddChild(Stream_ stream)

Methods inherited from class ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStream

getDefaultIndictedObjectsMapping, getDefaultJustificationMapping, getRetrievalSemantics

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.api.score.stream.ConstraintStream

impact, impact, penalize, penalize, penalizeConfigurable, penalizeConfigurable, reward, reward, rewardConfigurable, rewardConfigurable

Field Details

constraintFactory

protected final BavetConstraintFactory<Solution_> constraintFactory

parent

protected final BavetAbstractConstraintStream<Solution_> parent

childStreamList

protected final List<BavetAbstractConstraintStream<Solution_>> childStreamList

Constructor Details

BavetAbstractConstraintStream

protected BavetAbstractConstraintStream(BavetConstraintFactory<Solution_> constraintFactory,
 BavetAbstractConstraintStream<Solution_> parent)

BavetAbstractConstraintStream

protected BavetAbstractConstraintStream(BavetConstraintFactory<Solution_> constraintFactory,
 RetrievalSemantics retrievalSemantics)

Method Details

guaranteesDistinct

public boolean guaranteesDistinct()

Whether the stream guarantees that no two tuples it produces will ever have the same set of facts. Streams which can prove that they either do or do not produce unique tuples should override this method.

Returns:

delegates to getParent() if not null, otherwise false

buildConstraint

protected <Score_ extends Score<Score_>> Constraint buildConstraint(String constraintPackage,
 String constraintName,
 String description,
 String constraintGroup,
 Score_ constraintWeight,
 ScoreImpactType impactType,
 Object justificationFunction,
 Object indictedObjectsMapping,
 BavetScoringConstraintStream<Solution_> stream)

shareAndAddChild

public final <Stream_ extends BavetAbstractConstraintStream<Solution_>>
Stream_ shareAndAddChild(Stream_ stream)

collectActiveConstraintStreams

public void collectActiveConstraintStreams(Set<BavetAbstractConstraintStream<Solution_>> constraintStreamSet)

getTupleSource

public BavetAbstractConstraintStream<Solution_> getTupleSource()

Returns the stream which first produced the tuple that this stream operates on. If a stream does not have a single parent nor is it a source, it is expected to override this method.

Returns:

this if TupleSource, otherwise parent's tuple source.

buildNode

public abstract <Score_ extends Score<Score_>> void buildNode(ConstraintNodeBuildHelper<Solution_,Score_> buildHelper)

assertEmptyChildStreamList

protected void assertEmptyChildStreamList()

getConstraintFactory

public @NonNull BavetConstraintFactory<Solution_> getConstraintFactory()

Description copied from interface: ConstraintStream

The ConstraintFactory that build this.

Specified by:

getConstraintFactory in interface ConstraintStream

Specified by:

getConstraintFactory in class AbstractConstraintStream<Solution_>

getParent

public final BavetAbstractConstraintStream<Solution_> getParent()

Specified by:

getParent in interface BavetStream

Returns:

null for join/ifExists nodes, which have left and right parents instead; also null for forEach node, which has no parent.

getChildStreamList

public final List<BavetAbstractConstraintStream<Solution_>> getChildStreamList()