Package ai.timefold.solver.core.impl.neighborhood.stream.enumerating.common

Class AbstractEnumeratingStream<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.neighborhood.stream.enumerating.common.AbstractEnumeratingStream<Solution_>

All Implemented Interfaces:

BavetStream

Direct Known Subclasses:

AbstractBiEnumeratingStream, AbstractUniEnumeratingStream

@NullMarked
public abstract class AbstractEnumeratingStream<Solution_>
extends Object
implements BavetStream

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<AbstractEnumeratingStream<Solution_>>	childStreamList
protected final EnumeratingStreamFactory<Solution_>	enumeratingStreamFactory
protected final @Nullable AbstractEnumeratingStream<Solution_>	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEnumeratingStream(EnumeratingStreamFactory<Solution_> enumeratingStreamFactory, @Nullable AbstractEnumeratingStream<Solution_> parent)

Method Summary

Modifier and Type	Method	Description
protected void	assertEmptyChildStreamList()
abstract void	buildNode(DataNodeBuildHelper<Solution_> buildHelper)
void	collectActiveEnumeratingStreams(Set<AbstractEnumeratingStream<Solution_>> enumeratingStreamSet)
final List<AbstractEnumeratingStream<Solution_>>	getChildStreamList()
final @Nullable AbstractEnumeratingStream<Solution_>	getParent()
AbstractEnumeratingStream<Solution_>	getTupleSource()	Returns the stream which first produced the tuple that this stream operates on.
protected boolean	guaranteesDistinct()
final <Stream_ extends AbstractEnumeratingStream<Solution_>> Stream_	shareAndAddChild(Stream_ stream)

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.impl.bavet.common.BavetStream

getLocationSet

Field Details

enumeratingStreamFactory

protected final EnumeratingStreamFactory<Solution_> enumeratingStreamFactory

parent

protected final @Nullable AbstractEnumeratingStream<Solution_> parent

childStreamList

protected final List<AbstractEnumeratingStream<Solution_>> childStreamList

Constructor Details

AbstractEnumeratingStream

protected AbstractEnumeratingStream(EnumeratingStreamFactory<Solution_> enumeratingStreamFactory,
 @Nullable AbstractEnumeratingStream<Solution_> parent)

Method Details

shareAndAddChild

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

guaranteesDistinct

protected boolean guaranteesDistinct()

collectActiveEnumeratingStreams

public void collectActiveEnumeratingStreams(Set<AbstractEnumeratingStream<Solution_>> enumeratingStreamSet)

getTupleSource

public AbstractEnumeratingStream<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 void buildNode(DataNodeBuildHelper<Solution_> buildHelper)

assertEmptyChildStreamList

protected void assertEmptyChildStreamList()

getParent

public final @Nullable AbstractEnumeratingStream<Solution_> getParent()

Specified by:

getParent in interface BavetStream

getChildStreamList

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