eu.cqse.check.framework.shallowparser.util

Class ConnectedEntityCollector

java.lang.Object

eu.cqse.check.framework.shallowparser.framework.ShallowEntityTraversalUtils.ShallowEntityVisitorBase

eu.cqse.check.framework.shallowparser.util.ConnectedEntityCollector

All Implemented Interfaces:

IShallowEntityVisitor

public class ConnectedEntityCollector
extends ShallowEntityTraversalUtils.ShallowEntityVisitorBase

Traverses a shallow entity tree and collects groups of entities of the same type that are directly connected together. An entity is directly connected to another entity if the other entity is either the parent or a child of the entity and has the same type.

Constructor Summary

Constructors

Constructor and Description
ConnectedEntityCollector(EShallowEntityType entityType) Constructor.
ConnectedEntityCollector(EShallowEntityType entityType, java.util.function.Predicate<ShallowEntity> entitySelector) Constructor.

Method Summary

Modifier and Type	Method and Description
void	endVisit(ShallowEntity entity) Called after visiting all children of an entity in the backtracking phase of the DFS.
java.util.List<java.util.List<ShallowEntity>>	getConnectedGroups(java.util.List<ShallowEntity> entities) Returns a list of connected entity groups.
boolean	visit(ShallowEntity entity) Denotes that visiting the entity begins.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedEntityCollector

public ConnectedEntityCollector(EShallowEntityType entityType)

Constructor.

ConnectedEntityCollector

public ConnectedEntityCollector(EShallowEntityType entityType,
                                java.util.function.Predicate<ShallowEntity> entitySelector)

Constructor.

Method Detail

visit

public boolean visit(ShallowEntity entity)

Denotes that visiting the entity begins.

Specified by:

visit in interface IShallowEntityVisitor

Overrides:

visit in class ShallowEntityTraversalUtils.ShallowEntityVisitorBase

Returns:

true if the children of this entity are to be visited as well.

endVisit

public void endVisit(ShallowEntity entity)

Called after visiting all children of an entity in the backtracking phase of the DFS. This is called regardless of whether IShallowEntityVisitor.visit(ShallowEntity) returned true or false. The default implementation does nothing.

Specified by:

endVisit in interface IShallowEntityVisitor

Overrides:

endVisit in class ShallowEntityTraversalUtils.ShallowEntityVisitorBase

getConnectedGroups

public java.util.List<java.util.List<ShallowEntity>> getConnectedGroups(java.util.List<ShallowEntity> entities)

Returns a list of connected entity groups. Each group is sorted in the order the entities where traversed while doing a depth first search.