Package org.variantsync.diffdetective.variation.diff

Class Projection<L extends Label>

java.lang.Object

org.variantsync.diffdetective.variation.tree.VariationNode<Projection<L>,L>

org.variantsync.diffdetective.variation.diff.Projection<L>

All Implemented Interfaces:

HasNodeType

public class Projection<L extends Label>
extends VariationNode<Projection<L>,L>

A view of a DiffNode as variation node at a specific time.

See the project function in section 3.1 of our paper.

This class has to be instantiated using DiffNode.projection(org.variantsync.diffdetective.variation.diff.Time).

See Also:

• DiffNode.projection(org.variantsync.diffdetective.variation.diff.Time)

Field Summary

Fields

Modifier and Type	Field	Description
private DiffNode<L>	backingNode
private Time	time

Constructor Summary

Constructors

Constructor	Description
Projection(DiffNode<L> backingNode, Time time)	Creates a new projection of a DiffNode.

Method Summary

Modifier and Type	Method	Description
void	addChild(Projection<L> child)	The same as VariationNode.insertChild(T,int) but puts the node at the end of the children list instead of inserting it at a specific index.
DiffNode<L>	getBackingNode()
List<Projection<L>>	getChildren()	Returns an unmodifiable list representing the children of this node.
org.prop4j.Node	getFormula()	Returns the formula that is stored in this node.
int	getID()	Returns an integer that uniquely identifies this node within its tree.
L	getLabel()	Returns the label of this node.
LineRange	getLineRange()	Returns the range of line numbers of this node's corresponding source code.
NodeType	getNodeType()	Returns the node type of this node which determines the type of the represented element in the variation tree (e.g., mapping or artifact).
Projection<L>	getParent()	Returns the parent of this node, or null if this node doesn't have a parent.
Time	getTime()
void	insertChild(Projection<L> child, int index)	Adds a child before the given index to the children list of this node and sets its parent to this node.
void	removeAllChildren()	Removes all children of this node and sets their parent to null.
void	removeChild(Projection<L> child)	Removes the given node from this node's children list and sets the parent of child to null.
void	setLineRange(LineRange lineRange)	Sets the range of line numbers of this node's corresponding source code.
Projection<L>	upCast()	Returns this instance as the derived class type T.

Methods inherited from class org.variantsync.diffdetective.variation.tree.VariationNode

addBelow, addChildren, anyMatch, assertConsistency, downCast, drop, forAllPreorder, forMeAndMyAncestors, getChildCount, getDepth, getFeatureMapping, getIfNode, getPresenceCondition, indexOfChild, isChild, isLeaf, isRoot, isSameAs, printSourceCode, removeChildren, shallowIsSameAs, stealChildrenOf, toVariationTree, toVariationTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.variantsync.diffdetective.variation.tree.HasNodeType

isAnnotation, isArtifact, isConditionalAnnotation, isElif, isElse, isIf

Field Details

backingNode

private DiffNode<L extends Label> backingNode

time

private Time time

Constructor Details

Projection

Projection(DiffNode<L> backingNode,
 Time time)

Creates a new projection of a DiffNode. Only DiffNode is allowed to call this method to guarantee the identity of this class (see above for details). If you want to get the projection of a DiffNode use DiffNode.projection(org.variantsync.diffdetective.variation.diff.Time).

Parameters:

backingNode - the DiffNode which should be projected

time - which projection this should be

Method Details

getTime

public Time getTime()

getBackingNode

public DiffNode<L> getBackingNode()

upCast

public Projection<L> upCast()

Description copied from class: VariationNode

Returns this instance as the derived class type T. The deriving class will only have to return this here but this can't be implemented in the base class. If some derived class can't implement this method by returning this, it probably violates the requirements for the type parameter T (namely that it' the derived class itself).

Specified by:

upCast in class VariationNode<Projection<L extends Label>,L extends Label>

getNodeType

public NodeType getNodeType()

Description copied from class: VariationNode

Returns the node type of this node which determines the type of the represented element in the variation tree (e.g., mapping or artifact).

Specified by:

getNodeType in interface HasNodeType

Specified by:

getNodeType in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• HasNodeType

getLabel

public L getLabel()

Description copied from class: VariationNode

Returns the label of this node.

If HasNodeType.isArtifact() is true this may represent the source code of this artifact. Otherwise it may represent the preprocessor expression which was parsed to obtain VariationNode.getFormula(). In either case, this label may be an arbitrary value, selected according to the needs of the user of this class.

Specified by:

getLabel in class VariationNode<Projection<L extends Label>,L extends Label>

getLineRange

public LineRange getLineRange()

Description copied from class: VariationNode

Returns the range of line numbers of this node's corresponding source code.

Specified by:

getLineRange in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.setLineRange(LineRange)

setLineRange

public void setLineRange(LineRange lineRange)

Description copied from class: VariationNode

Sets the range of line numbers of this node's corresponding source code.

Specified by:

setLineRange in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.getLineRange()

getParent

public Projection<L> getParent()

Description copied from class: VariationNode

Returns the parent of this node, or null if this node doesn't have a parent.

Specified by:

getParent in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.drop()
• VariationNode.addBelow(T)

getChildren

public List<Projection<L>> getChildren()

Description copied from class: VariationNode

Returns an unmodifiable list representing the children of this node.

The following invariant has to hold for all nodes: for (var child : node.getChildren()) { Assert.assertTrue(node == child.getParent(node)) }

Specified by:

getChildren in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.isChild(T)
• VariationNode.addChild(T)
• VariationNode.removeChild(T)

addChild

public void addChild(Projection<L> child)

Description copied from class: VariationNode

The same as VariationNode.insertChild(T,int) but puts the node at the end of the children list instead of inserting it at a specific index.

Specified by:

addChild in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.getChildren()

insertChild

public void insertChild(Projection<L> child,
 int index)

Description copied from class: VariationNode

Adds a child before the given index to the children list of this node and sets its parent to this node.

When calling VariationNode.indexOfChild(T) with child the returned index will be index as long as the children list isn't modified.

Specified by:

insertChild in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.addChildren(java.util.Collection<T>)

removeChild

public void removeChild(Projection<L> child)

Description copied from class: VariationNode

Removes the given node from this node's children list and sets the parent of child to null.

Specified by:

removeChild in class VariationNode<Projection<L extends Label>,L extends Label>

See Also:

• VariationNode.removeChildren(java.util.Collection<T>)
• VariationNode.getChildren()

removeAllChildren

public void removeAllChildren()

Description copied from class: VariationNode

Removes all children of this node and sets their parent to null. Afterwards, this node will have no children.

Specified by:

removeAllChildren in class VariationNode<Projection<L extends Label>,L extends Label>

getFormula

public org.prop4j.Node getFormula()

Description copied from class: VariationNode

Returns the formula that is stored in this node. The formula is not null for mapping nodes with annotations and null otherwise (NodeType.ARTIFACT, NodeType.ELSE).

If the type parameter T of this class is not a concrete variation tree, then the returned formula should be treated as unmodifiable to prevent undesired side effects (e.g., to DiffNodes).

Specified by:

getFormula in class VariationNode<Projection<L extends Label>,L extends Label>

getID

public int getID()

Description copied from class: VariationNode

Returns an integer that uniquely identifies this node within its tree.

Some attributes may be recovered from this ID but this depends on the derived class. For example VariationTreeNode.fromID(int, L) can recover VariationNode.getNodeType() and the start line number. Beware that Projection returns DiffNode.getID() so this id is not fully compatible with VariationTreeNode.getID().

Specified by:

getID in class VariationNode<Projection<L extends Label>,L extends Label>