Class EventRelationshipTraverser

java.lang.Object

ch.tocco.nice2.optional.event.api.eventrelationship.EventRelationshipTraverser

@Component
public class EventRelationshipTraverser
extends Object

can be used to work with Events related by Event_relationship

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EventRelationshipTraverser.EventRelationship
static final record	EventRelationshipTraverser.TreeContext
static final record	EventRelationshipTraverser.TreeResolverSettings
static interface	EventRelationshipTraverser.TreeSorting

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_TO_CHILD_EVENT_RELATION
static final String	EVENT_TO_CHILD_RELATION
static final String	EVENT_TO_PARENT_EVENT_RELATION
static final String	EVENT_TO_PARENT_RELATION
static final String	RELATIONSHIP_TO_CHILD_RELATION
static final String	RELATIONSHIP_TO_PARENT_RELATION

Constructor Summary

Constructors

Constructor	Description
EventRelationshipTraverser()

Method Summary

Modifier and Type	Method	Description
List<Entity>	getAllChildren(Entity event)	get all children of an Event
Entity	getRootEvent(Entity event)	get the top most Event in the hierarchy.
void	visitAllChildren(Entity event, BiConsumer<Entity, EventRelationshipTraverser.TreeContext> childConsumer)
void	visitAllChildren(Entity event, BiConsumer<Entity, EventRelationshipTraverser.TreeContext> childConsumer, EventRelationshipTraverser.TreeResolverSettings settings)	run some code for each child
void	visitAllChildren(Entity event, Consumer<Entity> childConsumer)	run some code for each child

Methods inherited from class Object

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

Field Details

EVENT_TO_CHILD_RELATION

public static final String EVENT_TO_CHILD_RELATION

See Also:

• Constant Field Values

EVENT_TO_PARENT_RELATION

public static final String EVENT_TO_PARENT_RELATION

See Also:

• Constant Field Values

RELATIONSHIP_TO_CHILD_RELATION

public static final String RELATIONSHIP_TO_CHILD_RELATION

See Also:

• Constant Field Values

RELATIONSHIP_TO_PARENT_RELATION

public static final String RELATIONSHIP_TO_PARENT_RELATION

See Also:

• Constant Field Values

EVENT_TO_PARENT_EVENT_RELATION

public static final String EVENT_TO_PARENT_EVENT_RELATION

EVENT_TO_CHILD_EVENT_RELATION

public static final String EVENT_TO_CHILD_EVENT_RELATION

Constructor Details

EventRelationshipTraverser

public EventRelationshipTraverser()

Method Details

getAllChildren

public List<Entity> getAllChildren(Entity event)

get all children of an Event

Parameters:

event - the parent Event

Returns:

a list containing all child Event entities

visitAllChildren

public void visitAllChildren(Entity event,
 Consumer<Entity> childConsumer)

run some code for each child

Parameters:

event - the parent Event

childConsumer - gets called for each child

visitAllChildren

public void visitAllChildren(Entity event,
 BiConsumer<Entity, EventRelationshipTraverser.TreeContext> childConsumer)

See Also:

• visitAllChildren(Entity, BiConsumer, TreeResolverSettings)

visitAllChildren

public void visitAllChildren(Entity event,
 BiConsumer<Entity, EventRelationshipTraverser.TreeContext> childConsumer,
 EventRelationshipTraverser.TreeResolverSettings settings)

run some code for each child

Parameters:

event - the parent Event

childConsumer - gets called for each child

settings - customization settings

getRootEvent

public Entity getRootEvent(Entity event)

get the top most Event in the hierarchy. for Events not used in Seminars, multiple parents may exist, which this method treats as unresolvable and will return the last Event that was a clear single parent.

Parameters:

event - the Event to search from

Returns:

the Event with no single direct parent