org.eclipse.viatra.query.runtime.rete.single

## Class TransitiveClosureNode

- java.lang.Object
- - org.eclipse.viatra.query.runtime.rete.network.BaseNode
  - - org.eclipse.viatra.query.runtime.rete.network.StandardNode
    - - org.eclipse.viatra.query.runtime.rete.single.SingleInputNode
      - - org.eclipse.viatra.query.runtime.rete.single.TransitiveClosureNode

- All Implemented Interfaces:
    ITcObserver<java.lang.Object>, Clearable, NetworkStructureChangeSensitiveNode, Node, Receiver, Supplier, Tunnel

      public class TransitiveClosureNode
      extends SingleInputNode
      implements Clearable, ITcObserver<java.lang.Object>, NetworkStructureChangeSensitiveNode

  This class represents a transitive closure node in the Rete net.

  This node must not be used in recursive `CommunicationGroup`s.

- - ### Field Summary

    - ### Fields inherited from class org.eclipse.viatra.query.runtime.rete.single.SingleInputNode

      `mailbox, parent`

    - ### Fields inherited from class org.eclipse.viatra.query.runtime.rete.network.StandardNode

      `childMailboxes, children`

    - ### Fields inherited from class org.eclipse.viatra.query.runtime.rete.network.BaseNode

      `nodeId, reteContainer, tag, traceInfos`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TransitiveClosureNode(ReteContainer reteContainer)` Create a new transitive closure rete node.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `clear()` Clear all partial matchings stored in memory
    `void` | `networkStructureChanged()` At the time of the invocation, the dependency graph has already been updated.
    `void` | `pullInto(java.util.Collection<Tuple> collector, boolean flush)` Pulls the contents of this object in this particular moment into a target collection.
    `void` | `pullIntoWithTimeline(java.util.Map<Tuple,Timeline<Timestamp>> collector, boolean flush)`
    `void` | `reinitializeWith(java.util.Collection<Tuple> tuples)` Initializes the graph data source with the given collection of tuples.
    `void` | `tupleDeleted(java.lang.Object source, java.lang.Object target)` Used to notify when a tuple is deleted from the transitive closure relation.
    `void` | `tupleInserted(java.lang.Object source, java.lang.Object target)` Used to notify when a tuple is inserted into the transitive closure relation.
    `void` | `update(Direction direction, Tuple updateElement, Timestamp timestamp)` updates the receiver with a newly found or lost partial matching

    - ### Methods inherited from class org.eclipse.viatra.query.runtime.rete.single.SingleInputNode

      `appendParent, assignTraceInfo, getCommunicationTracker, getMailbox, getParents, instantiateMailbox, propagatePullInto, propagatePullIntoWithTimestamp, removeParent`

    - ### Methods inherited from class org.eclipse.viatra.query.runtime.rete.network.StandardNode

      `appendChild, constructIndex, getChildMailboxes, getPulledContents, getReceivers, issueError, propagateUpdate, removeChild`

    - ### Methods inherited from class org.eclipse.viatra.query.runtime.rete.network.BaseNode

      `acceptPropagatedTraceInfo, getContainer, getNodeId, getTag, getTraceInfoPatternsEnumerated, getTraceInfos, setTag, toString, toStringCore`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface org.eclipse.viatra.query.runtime.rete.network.Node

      `acceptPropagatedTraceInfo, assignTraceInfo, getCommunicationTracker, getContainer, getNodeId, getTag, getTraceInfos, setTag`

    - ### Methods inherited from interface org.eclipse.viatra.query.runtime.rete.network.Supplier

      `appendChild, constructIndex, getPulledContents, getPulledContents, getReceivers, removeChild`

- - ### Constructor Detail

    - #### TransitiveClosureNode

          public TransitiveClosureNode(ReteContainer reteContainer)

      Create a new transitive closure rete node. Client may optionally call `reinitializeWith(Collection)` before using the node, instead of inserting the initial set of tuples one by one.
      Parameters:
        `reteContainer` - the rete container of the node

  - ### Method Detail

    - #### networkStructureChanged

          public void networkStructureChanged()

      Description copied from interface: `NetworkStructureChangeSensitiveNode`
      At the time of the invocation, the dependency graph has already been updated.
      Specified by:
        `networkStructureChanged` in interface `NetworkStructureChangeSensitiveNode`
      Overrides:
        `networkStructureChanged` in class `StandardNode`

    - #### reinitializeWith

          public void reinitializeWith(java.util.Collection<Tuple> tuples)

      Initializes the graph data source with the given collection of tuples.
      Parameters:
        `tuples` - the initial collection of tuples

    - #### pullInto

          public void pullInto(java.util.Collection<Tuple> collector,
                               boolean flush)

      Description copied from interface: `Supplier`
      Pulls the contents of this object in this particular moment into a target collection.
      Specified by:
        `pullInto` in interface `Supplier`
        `flush` - if true, flushing of messages is allowed during the pull, otherwise flushing is not allowed

    - #### pullIntoWithTimeline

          public void pullIntoWithTimeline(java.util.Map<Tuple,Timeline<Timestamp>> collector,
                                           boolean flush)

      Specified by:
        `pullIntoWithTimeline` in interface `Supplier`

    - #### update

          public void update(Direction direction,
                             Tuple updateElement,
                             Timestamp timestamp)

      Description copied from interface: `Receiver`
      updates the receiver with a newly found or lost partial matching
      Specified by:
        `update` in interface `Receiver`

    - #### clear

          public void clear()

      Description copied from interface: `Clearable`
      Clear all partial matchings stored in memory
      Specified by:
        `clear` in interface `Clearable`

    - #### tupleInserted

          public void tupleInserted(java.lang.Object source,
                                    java.lang.Object target)

      Description copied from interface: `ITcObserver`
      Used to notify when a tuple is inserted into the transitive closure relation.
      Specified by:
        `tupleInserted` in interface `ITcObserver<java.lang.Object>`
      Parameters:
        `source` - the source of the tuple
        `target` - the target of the tuple

    - #### tupleDeleted

          public void tupleDeleted(java.lang.Object source,
                                   java.lang.Object target)

      Description copied from interface: `ITcObserver`
      Used to notify when a tuple is deleted from the transitive closure relation.
      Specified by:
        `tupleDeleted` in interface `ITcObserver<java.lang.Object>`
      Parameters:
        `source` - the source of the tuple
        `target` - the target of the tuple