Package org.processmining.specpp.base.impls

Class RecursiveComposer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

java.lang.Object

org.processmining.specpp.componenting.system.link.AbstractBaseClass

org.processmining.specpp.base.impls.RecursiveComposer<C,I,R>

All Implemented Interfaces:

java.util.function.Consumer<C>, Composer<C,I,R>, FullComponentSystemUser, ComposerComponent<C,I,R>, HasComponentCollection, IsGlobalProvider, UsesGlobalComponentSystem, UsesLocalComponentSystem, Initializable

Direct Known Subclasses:

AbstractPostponingComposer, FilteringComposer

public abstract class RecursiveComposer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>
extends AbstractBaseClass
implements ComposerComponent<C,I,R>

Field Summary

Fields

Modifier and Type	Field	Description
protected Composer<C,I,R>	childComposer

Constructor Summary

Constructors

Constructor	Description
RecursiveComposer(ComposerComponent<C,I,R> childComposer)

Method Summary

Modifier and Type	Method	Description
abstract void	accept(C c)	Hook method which decides how to handle an incoming candidate.
void	candidatesAreExhausted()	Hook method which is called when this composer will not receive any more candidates in the future as the connected proposer has been exhausted.
protected void	forward(C c)
R	generateResult()	Hook method where a final result is computed from the incrementally built up intermediate result.
I	getIntermediateResult()	Typically just returns the internally managed composition.
boolean	isFinished()	Whether this composer has reached a state where it does not want to handle new candidates.

Methods inherited from class org.processmining.specpp.componenting.system.link.AbstractBaseClass

collectTransitiveSubcomponents, getComponentCollection, getSubComponents, globalComponentSystem, init, initSelf, localComponentSystem, postSubComponentInit, preSubComponentInit, registerSubComponent, unregisterSubComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.processmining.specpp.componenting.system.FullComponentSystemUser

collectTransitiveSubcomponents, connectLocalComponentSystem, getComponentCollection, registerSubComponent, unregisterSubComponent

Methods inherited from interface org.processmining.specpp.traits.Initializable

init

Methods inherited from interface org.processmining.specpp.componenting.traits.UsesGlobalComponentSystem

globalComponentSystem

Methods inherited from interface org.processmining.specpp.componenting.traits.UsesLocalComponentSystem

bridgeToChildren, localComponentSystem

Field Detail

childComposer

protected final Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result> childComposer

Constructor Detail

RecursiveComposer

public RecursiveComposer(ComposerComponent<C,I,R> childComposer)

Method Detail

candidatesAreExhausted

public void candidatesAreExhausted()

Description copied from interface: Composer

Hook method which is called when this composer will not receive any more candidates in the future as the connected proposer has been exhausted.

Specified by:

candidatesAreExhausted in interface Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

isFinished

public boolean isFinished()

Description copied from interface: Composer

Whether this composer has reached a state where it does not want to handle new candidates.

Specified by:

isFinished in interface Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

Returns:

true iff no more candidates will be accepted

getIntermediateResult

public I getIntermediateResult()

Description copied from interface: Composer

Typically just returns the internally managed composition. Care must be taken, that this method may be called asynchronously.

Specified by:

getIntermediateResult in interface Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

Returns:

the intermediate result

generateResult

public R generateResult()

Description copied from interface: Composer

Hook method where a final result is computed from the incrementally built up intermediate result.

Specified by:

generateResult in interface Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

Returns:

the final result

forward

protected void forward(C c)

accept

public abstract void accept(C c)

Description copied from interface: Composer

Hook method which decides how to handle an incoming candidate. The internal logic decides whether the candidate is eventually added to the current composition.

Specified by:

accept in interface Composer<C extends Candidate,I extends CompositionComponent<C>,R extends Result>

Specified by:

accept in interface java.util.function.Consumer<C extends Candidate>

Parameters:

c - the candidate that has been offered to this composer