com.neurosys.common.hierarchy

Interface HierarchyService<T extends IHierarchialReference>

All Superinterfaces:

ChangeGenerator<Object[]>

All Known Subinterfaces:

CommentService, ContentService, PostService, ProductService<T>

All Known Implementing Classes:

CommentServiceImpl, ContentServiceImpl, GenericHierarchyContentServiceImpl, PostServiceImpl, ProductServiceImpl

public interface HierarchyService<T extends IHierarchialReference>
extends ChangeGenerator<Object[]>

Common service / DAO methods that are needed by Hierarchy implementations for Domain objects that implement IHierarchialReference

Since this implements ChangeGenerator; it will also generate Events of Type

• Event Type as String}
• Hierarchical Entity OR Id of the Entity as Long

Author:

Arjun Dhar TODO: Support methods like getEntityInstance, getParents(). See ProductService

Method Summary

Modifier and Type	Method and Description
void	convert(IHierarchialReference entity, Class to) If we wish to transform an entity type we should perform the transformation and then the update.
void	deleteSubHierarchy(T rootNode) Delete a root node and its children. May throw an exception is there is a fault in the hierarchy or any node could not be deleted for some reason.
String	getLastChildHierarchyCode(T ref) Get the last existing/current child Hierarchy code
List	loadHierarchy(T rootNode, boolean loadLeaves)
List<T>	loadHierarchyFlat(T rootNode) Load list of nodes under the root in order of hierarchy but does not to a structural hierarchial conversion (Homogeneous list)
void	move(T node, T parent, Integer order) Move a content under a parent.

Methods inherited from interface com.neurosys.events.ChangeGenerator

addChangeListener, getListeners, notifyAllListeners, setListeners

Method Detail

getLastChildHierarchyCode

String getLastChildHierarchyCode(T ref)

Get the last existing/current child Hierarchy code

Parameters:

parentHierarchyCode -

Returns:

@nullable true

move

void move(T node,
          T parent,
          Integer order)
   throws Exception

Move a content under a parent. The order works by default to take the MAX/Last position under the parent; however if order is provided then it tries to adjust to specified order or else MAX/Last remains default.
This operations will also update the passed node with the latest IHierarchialReference.getParentId() and IHierarchialReference.getHierarchy().

Parameters:

node -

parent - @nullable true (if IHierarchialReference.ROOT

order - as Integer @nullable true (optional)

Throws:

Exception

loadHierarchy

List loadHierarchy(T rootNode,
                   boolean loadLeaves)

Parameters:

rootNode - this

loadLeaves -

Returns:

loadHierarchyFlat

List<T> loadHierarchyFlat(T rootNode)

Load list of nodes under the root in order of hierarchy but does not to a structural hierarchial conversion (Homogeneous list)

Parameters:

rootNode -

Returns:

deleteSubHierarchy

void deleteSubHierarchy(T rootNode)
                 throws Exception

Delete a root node and its children.
May throw an exception is there is a fault in the hierarchy or any node could not be deleted for some reason.

Parameters:

rootNode -

Throws:

Exception

convert

void convert(IHierarchialReference entity,
             Class to)

If we wish to transform an entity type we should perform the transformation and then the update. This requires an InheritanceType.SINGLE_TABLE or oen where there is a shared DiscriminatorValue
Note this implementation Update the entity Discriminator in the DB directly : Hacking