Record Class ChaseDescription<RW extends MaterializedData & Writable>

java.lang.Object

java.lang.Record

fr.inria.rules.integraal.forward_chaining.chase.description.ChaseDescription<RW>

Type Parameters:

RW - the writable materialized data type described by this chase snapshot

Record Components:

chasableData - the data manipulated by the chase

ruleBase - the rule base currently attached to the chase

ruleScheduler - the scheduler used to choose rules to apply

ruleApplier - the applier used to execute triggered rules

lastStepResult - the result of the previous chase step

stepNumber - the current chase step number

haltingConditions - the configured halting conditions

globalPreTreatments - the treatments applied before the chase starts

stepPreTreatments - the treatments applied before each step

globalEndTreatments - the treatments applied after the chase completes

endOfStepTreatments - the treatments applied after each step

All Implemented Interfaces:

IChaseDescription

public record ChaseDescription<RW extends MaterializedData & Writable>(ChasableData<RW extends MaterializedData & Writable> chasableData, RuleBase ruleBase, RuleScheduler ruleScheduler, RuleApplier<RW extends MaterializedData & Writable> ruleApplier, RuleApplicationStepResult lastStepResult, int stepNumber, Collection<HaltingCondition<RW extends MaterializedData & Writable>> haltingConditions, Collection<PreTreatment<RW extends MaterializedData & Writable>> globalPreTreatments, Collection<PreTreatment<RW extends MaterializedData & Writable>> stepPreTreatments, Collection<EndTreatment<RW extends MaterializedData & Writable>> globalEndTreatments, Collection<EndTreatment<RW extends MaterializedData & Writable>> endOfStepTreatments)
extends Record
implements IChaseDescription

Immutable description of a chase configuration and its current state.

Constructor Summary

Constructors

Constructor

Description

ChaseDescription(ChasableData<RW> chasableData, RuleBase ruleBase, RuleScheduler ruleScheduler, RuleApplier<RW> ruleApplier, RuleApplicationStepResult lastStepResult, int stepNumber, Collection<HaltingCondition<RW>> haltingConditions, Collection<PreTreatment<RW>> globalPreTreatments, Collection<PreTreatment<RW>> stepPreTreatments, Collection<EndTreatment<RW>> globalEndTreatments, Collection<EndTreatment<RW>> endOfStepTreatments)

Creates an instance of a ChaseDescription record class.

Method Summary

Modifier and Type	Method	Description
ChasableData<RW>	chasableData()	Returns the value of the chasableData record component.
Collection<EndTreatment<RW>>	endOfStepTreatments()	Returns the value of the endOfStepTreatments record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Collection<IGParameter<InteGraalKeywords, ?>>	getCorrespondingParameters()	Returns the configuration parameters corresponding to this description.
Collection<EndTreatment<RW>>	globalEndTreatments()	Returns the value of the globalEndTreatments record component.
Collection<PreTreatment<RW>>	globalPreTreatments()	Returns the value of the globalPreTreatments record component.
Collection<HaltingCondition<RW>>	haltingConditions()	Returns the value of the haltingConditions record component.
final int	hashCode()	Returns a hash code value for this object.
RuleApplicationStepResult	lastStepResult()	Returns the value of the lastStepResult record component.
RuleApplier<RW>	ruleApplier()	Returns the value of the ruleApplier record component.
RuleBase	ruleBase()	Returns the value of the ruleBase record component.
RuleScheduler	ruleScheduler()	Returns the value of the ruleScheduler record component.
int	stepNumber()	Returns the value of the stepNumber record component.
Collection<PreTreatment<RW>>	stepPreTreatments()	Returns the value of the stepPreTreatments record component.
String	toJson()	Serializes this description as JSON.
String	toPrettyString()	Serializes this description as a multi-line human-readable string.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChaseDescription

public ChaseDescription(ChasableData<RW> chasableData,
 RuleBase ruleBase,
 RuleScheduler ruleScheduler,
 RuleApplier<RW> ruleApplier,
 RuleApplicationStepResult lastStepResult,
 int stepNumber,
 Collection<HaltingCondition<RW>> haltingConditions,
 Collection<PreTreatment<RW>> globalPreTreatments,
 Collection<PreTreatment<RW>> stepPreTreatments,
 Collection<EndTreatment<RW>> globalEndTreatments,
 Collection<EndTreatment<RW>> endOfStepTreatments)

Creates an instance of a ChaseDescription record class.

Parameters:

chasableData - the value for the chasableData record component

ruleBase - the value for the ruleBase record component

ruleScheduler - the value for the ruleScheduler record component

ruleApplier - the value for the ruleApplier record component

lastStepResult - the value for the lastStepResult record component

stepNumber - the value for the stepNumber record component

haltingConditions - the value for the haltingConditions record component

globalPreTreatments - the value for the globalPreTreatments record component

stepPreTreatments - the value for the stepPreTreatments record component

globalEndTreatments - the value for the globalEndTreatments record component

endOfStepTreatments - the value for the endOfStepTreatments record component

Method Details

getCorrespondingParameters

public Collection<IGParameter<InteGraalKeywords, ?>> getCorrespondingParameters()

Returns the configuration parameters corresponding to this description.

Specified by:

getCorrespondingParameters in interface IChaseDescription

Returns:

the associated configuration parameters

toJson

public String toJson()

Serializes this description as JSON.

Specified by:

toJson in interface IChaseDescription

Returns:

the JSON representation

toPrettyString

public String toPrettyString()

Serializes this description as a multi-line human-readable string.

Specified by:

toPrettyString in interface IChaseDescription

Returns:

the formatted description

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

chasableData

public ChasableData<RW> chasableData()

Returns the value of the chasableData record component.

Returns:

the value of the chasableData record component

ruleBase

public RuleBase ruleBase()

Returns the value of the ruleBase record component.

Returns:

the value of the ruleBase record component

ruleScheduler

public RuleScheduler ruleScheduler()

Returns the value of the ruleScheduler record component.

Returns:

the value of the ruleScheduler record component

ruleApplier

public RuleApplier<RW> ruleApplier()

Returns the value of the ruleApplier record component.

Returns:

the value of the ruleApplier record component

lastStepResult

public RuleApplicationStepResult lastStepResult()

Returns the value of the lastStepResult record component.

Returns:

the value of the lastStepResult record component

stepNumber

public int stepNumber()

Returns the value of the stepNumber record component.

Returns:

the value of the stepNumber record component

haltingConditions

public Collection<HaltingCondition<RW>> haltingConditions()

Returns the value of the haltingConditions record component.

Returns:

the value of the haltingConditions record component

globalPreTreatments

public Collection<PreTreatment<RW>> globalPreTreatments()

Returns the value of the globalPreTreatments record component.

Returns:

the value of the globalPreTreatments record component

stepPreTreatments

public Collection<PreTreatment<RW>> stepPreTreatments()

Returns the value of the stepPreTreatments record component.

Returns:

the value of the stepPreTreatments record component

globalEndTreatments

public Collection<EndTreatment<RW>> globalEndTreatments()

Returns the value of the globalEndTreatments record component.

Returns:

the value of the globalEndTreatments record component

endOfStepTreatments

public Collection<EndTreatment<RW>> endOfStepTreatments()

Returns the value of the endOfStepTreatments record component.

Returns:

the value of the endOfStepTreatments record component