Class CompositionOperator

java.lang.Object

ca.mcscert.jpipe.operators.CompositionOperator

Direct Known Subclasses:

AssembleOperator, RefineOperator

public abstract class CompositionOperator
extends Object

Base class for all composition operators. Owns the partition + two-phase (create-then-link) algorithm via the Template Method pattern.

Subclasses provide three hooks:

1. equivalenceRelation(List, Map) — decides which elements belong to the same group
2. mergeFunction(List, Map) — creates the merged element for each group and populates the AliasRegistry
3. createResultModel(String, SourceLocation, List, Map) — emits the command that declares the result model

Operators are stateless: the same instance can be reused for multiple apply(String, List, Map) calls with different arguments.

Constructor Summary

Constructors

Constructor	Description
CompositionOperator()

Method Summary

Modifier and Type	Method	Description
protected List<Command>	additionalCommands(String resultName, List<JustificationModel<?>> sources, AliasRegistry aliases, Map<String,String> args)	Returns additional commands to append after Phase 2 edge reconstruction.
final List<Command>	apply(String resultName, List<JustificationModel<?>> sources, Map<String,String> arguments)	Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName.
final List<Command>	apply(String resultName, List<JustificationModel<?>> sources, Map<String,String> arguments, SourceLocation location)	Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName.
final List<Command>	apply(String resultName, List<JustificationModel<?>> sources, Map<String,String> arguments, SourceLocation location, Map<String, SourceLocation> knownLocations)	Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName.
protected abstract Command	createResultModel(String name, SourceLocation location, List<JustificationModel<?>> sources, Map<String,String> arguments)	Returns the command that creates the result model (typically CreateJustification or CreateTemplate).
protected abstract EquivalenceRelation	equivalenceRelation(List<JustificationModel<?>> sources, Map<String,String> arguments)	Returns the equivalence relation to use for partitioning elements from sources and arguments.
protected abstract MergeFunction	mergeFunction(List<JustificationModel<?>> sources, Map<String,String> arguments)	Returns the merge function to use for creating result elements from sources and arguments.
protected Set<String>	requiredArguments()	Declares which argument keys this operator requires.
ModelKind	resultKind(List<JustificationModel<?>> sources, Map<String,String> args)	Returns the ModelKind of the model produced by this operator for the given sources and args.

Methods inherited from class Object

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

Constructor Details

CompositionOperator

public CompositionOperator()

Method Details

requiredArguments

protected Set<String> requiredArguments()

Declares which argument keys this operator requires. The framework validates their presence at the start of apply(String, List, Map) and throws InvalidOperatorCallException listing any missing keys. Default: empty set (no required arguments).

resultKind

public ModelKind resultKind(List<JustificationModel<?>> sources,
 Map<String,String> args)

Returns the ModelKind of the model produced by this operator for the given sources and args. Defaults to ModelKind.JUSTIFICATION. Override in subclasses whose result kind depends on the input models (e.g. an operator that produces a Template when any source is a Template).

equivalenceRelation

protected abstract EquivalenceRelation equivalenceRelation(List<JustificationModel<?>> sources,
 Map<String,String> arguments)

Returns the equivalence relation to use for partitioning elements from sources and arguments.

mergeFunction

protected abstract MergeFunction mergeFunction(List<JustificationModel<?>> sources,
 Map<String,String> arguments)

Returns the merge function to use for creating result elements from sources and arguments.

createResultModel

protected abstract Command createResultModel(String name,
 SourceLocation location,
 List<JustificationModel<?>> sources,
 Map<String,String> arguments)

Returns the command that creates the result model (typically CreateJustification or CreateTemplate).

Parameters:

location - the source location of the operator call; forwarded to the creation command so the result model appears in the symbol table.

sources - the source models being composed; provided so operators can choose the result model type (e.g. Template vs Justification) based on the source types.

additionalCommands

protected List<Command> additionalCommands(String resultName,
 List<JustificationModel<?>> sources,
 AliasRegistry aliases,
 Map<String,String> args)

Returns additional commands to append after Phase 2 edge reconstruction. Override to inject synthesized elements and their edges that have no counterpart in any source model. Default: empty.

apply

public final List<Command> apply(String resultName,
 List<JustificationModel<?>> sources,
 Map<String,String> arguments)

Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName. Uses SourceLocation.UNKNOWN for the result model's location.

Throws:

InvalidOperatorCallException - if any key declared by requiredArguments() is absent from arguments

apply

public final List<Command> apply(String resultName,
 List<JustificationModel<?>> sources,
 Map<String,String> arguments,
 SourceLocation location)

Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName.

Parameters:

location - source location of the operator call; forwarded to createResultModel(String, SourceLocation, List, Map) so the result model is registered in the symbol table.

Throws:

InvalidOperatorCallException - if any key declared by requiredArguments() is absent from arguments

apply

public final List<Command> apply(String resultName,
 List<JustificationModel<?>> sources,
 Map<String,String> arguments,
 SourceLocation location,
 Map<String, SourceLocation> knownLocations)

Applies this operator to sources and returns the complete list of commands needed to build the result model named resultName.

Parameters:

location - source location of the operator call; forwarded to createResultModel(String, SourceLocation, List, Map) so the result model is registered in the symbol table.

knownLocations - location registry of the compilation unit (keyed as "modelName/elementId"); used to attach each source element's original location to its copy in the result model.

Throws:

InvalidOperatorCallException - if any key declared by requiredArguments() is absent from arguments