com.edorasware.commons.core.entity

Interface HierarchicalEntity<T extends HierarchicalEntityId,I extends T>

Type Parameters:

T - the id type for hierarchy entities

I - the id type for this specific entity

All Superinterfaces:

Identifiable<I>

All Known Implementing Classes:

AnyWorkObject, AnyWorkObjectDefinition, WorkObject, WorkObjectDefinition

public interface HierarchicalEntity<T extends HierarchicalEntityId,I extends T>
extends Identifiable<I>

Entity that is structured hierarchically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HierarchicalEntity.HierarchicalEntityBuilder<T extends HierarchicalEntityId,SELF extends HierarchicalEntity.HierarchicalEntityBuilder<T,SELF>> Builder for a HierarchicalEntity instance.

Method Summary

Modifier and Type	Method and Description
T	getParentId() Returns the id of the parent entity.
<S extends T> S	getParentId(Class<S> expectedParentType) Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
List<? extends T>	getPath() Returns the path of the hierarchy to which the entity belongs.
T	getRootId() Returns the id of the root entity.
<S extends T> S	getTopMostParentId(Class<S> expectedParentType) Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
boolean	hasParent() Returns true if the entity has a parent.

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Method Detail

getPath

List<? extends T> getPath()

Returns the path of the hierarchy to which the entity belongs. The path starts with the root and ends with the entity itself, when iterating through the list from beginning to end.

Returns:

the hierarchy path

getRootId

T getRootId()

Returns the id of the root entity.

Returns:

the root entity id, if the entity is itself the root entity, the id of the entity is returned

hasParent

boolean hasParent()

Returns true if the entity has a parent.

Returns:

true if the entity has a parent

getParentId

T getParentId()

Returns the id of the parent entity.

Returns:

the parent entity id, or null if the entity has no parent

getParentId

<S extends T> S getParentId(Class<S> expectedParentType)

Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Type Parameters:

S - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the first parent of the entity of the expected type, or null

getTopMostParentId

<S extends T> S getTopMostParentId(Class<S> expectedParentType)

Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Type Parameters:

S - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the topmost parent of the entity of the expected type, or null