com.neurosys.common.hierarchy

Class AbstractHierarchyDaoImpl<T extends IHierarchialReference>

java.lang.Object

com.neurosys.domain.GenericAware<T>

com.neurosys.dao.jpa.GenericDaoImpl<T>

com.neurosys.dao.jpa.AbstractQueryableDaoImpl<T>

com.neurosys.common.hierarchy.AbstractHierarchyDaoImpl<T>

All Implemented Interfaces:

FreeQuery, GenericDao<T>, QueryableDao<T>

Direct Known Subclasses:

AbstractContentHierarchyDaoImpl, ProductDaoImpl

public abstract class AbstractHierarchyDaoImpl<T extends IHierarchialReference>
extends AbstractQueryableDaoImpl<T>

Some common work horse IHierarchialReference domain related common DAO method helpers

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_PARENTS Special Query Attribute: Filter out parent nodes under this parent
static String	FILTER_PARENTS_IMMEDIATE Special Query Attribute: If filterParents is true then this attribute is used to check if we want to filter for immediate
protected org.apache.commons.collections.Transformer	relEntitiesDelTransformer A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.

Fields inherited from class com.neurosys.dao.jpa.GenericDaoImpl

em

Fields inherited from class com.neurosys.domain.GenericAware

ct, t

Constructor Summary

Constructors

Constructor and Description
AbstractHierarchyDaoImpl()
AbstractHierarchyDaoImpl(Class<T> ref)

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.
Long	delete(Collection<Long> ids, String entityName)
Long	delete(Long id, String entityName)
protected int	deleteSubHierarchy(String hierarchyCode, String entityName, org.apache.commons.collections.Transformer relatedEntitiesHierachyDelete) Delete from the given hierarchy code onward (including the given code)
protected int	deleteSubHierarchy(T rootNode, String entityName, org.apache.commons.collections.Transformer relatedEntitiesHierachyDelete) 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.
protected javax.persistence.Query	filterParents(T parent, boolean immediate, boolean count) Return List of nodes that are parents under the specified parent Node.
protected String	getLastChildHierarchyCode(T parent, String entityName) WARN : Code not written for multiple processes trying to get the Max for the same category; will lead to collision or possibly return of a number already alloted to another process
List<T>	getParents(T entity, boolean includeThis, String DEFAULT_ENTITY_NAME, QueryOptimizer queryOptimizer, String entityName)
org.apache.commons.collections.Transformer	getPersistTransformer() Some dependent entities may depend on the core Entity and may need to be persisted/updated/cleaned with (after) it in the same save operation. This accepts the Entity instance as an input
org.apache.commons.collections.Transformer	getRelEntitiesDelTransformer() A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.
protected boolean	isExistsAsParent(T node) A quick check to see if the current node is a parent
Page<T>	loadPage(Query<T> query)
protected String	makeSpaceForNodeInParent(T node, T parent, Integer sequence, String entityName) WARN : Code not written for multiple processes trying to get the Max for the same category; will lead to collision or possibly return of a number already alloted to another process
void	move(T entity, T newParent, Integer sequence, String entityName)
T	save(T entity)
void	setPersistTransformer(org.apache.commons.collections.Transformer postPersistTransformer) Some dependent entities may depend on the core Entity and may need to be persisted/updated/cleaned with (after) it in the same save operation. This accepts the Entity instance as an input
void	setRelEntitiesDelTransformer(org.apache.commons.collections.Transformer relEntitiesDelTransformer) A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.
protected void	shiftHierarchy(String currentHierarchyCode, String newHierarchyCode, String entityName, T parent) Re-organizes the IHierarchialReference.getHierarchy() code.
protected void	verifyHierarchy(T rootNode, String entityName) Validate a tree / sub-tree. For a given node, it verifies if there is any hierarchy that has an alternate node with a conflicting hierarchy code.

Methods inherited from class com.neurosys.dao.jpa.AbstractQueryableDaoImpl

conditionConstruct, count, ensureRowIsEntity, ensureRowIsEntity, getEntityInstance, getQueryObject, query, query, queryPage, queryPage

Methods inherited from class com.neurosys.dao.jpa.GenericDaoImpl

delete, delete, getEntityManager, getNativeEntityName, load, load, paginate, query, query, setEntityManager, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.dao.GenericDao

delete, delete, load, load

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Field Detail

FILTER_PARENTS

public static final String FILTER_PARENTS

Special Query Attribute: Filter out parent nodes under this parent

See Also:

Constant Field Values

FILTER_PARENTS_IMMEDIATE

public static final String FILTER_PARENTS_IMMEDIATE

Special Query Attribute: If filterParents is true then this attribute is used to check if we want to filter for immediate

See Also:

Constant Field Values

relEntitiesDelTransformer

protected org.apache.commons.collections.Transformer relEntitiesDelTransformer

A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.

Constructor Detail

AbstractHierarchyDaoImpl

public AbstractHierarchyDaoImpl()

AbstractHierarchyDaoImpl

public AbstractHierarchyDaoImpl(Class<T> ref)

Method Detail

getLastChildHierarchyCode

protected String getLastChildHierarchyCode(T parent,
                                           String entityName)

WARN : Code not written for multiple processes trying to get the Max for the same category; will lead to collision or possibly return of a number already alloted to another process

Parameters:

parent - @nullable true (if null then it will add to root)

entityName - as String - Table name : to support native query

isExistsAsParent

protected boolean isExistsAsParent(T node)

A quick check to see if the current node is a parent

makeSpaceForNodeInParent

@Transactional(readOnly=false)
protected String makeSpaceForNodeInParent(T node,
                                                                         T parent,
                                                                         Integer sequence,
                                                                         String entityName)

WARN : Code not written for multiple processes trying to get the Max for the same category; will lead to collision or possibly return of a number already alloted to another process

Parameters:

node - being shifted

parent - @nullable true if IHierarchialReference.ROOT

sequence - as Integer (to position within parent) @nullable false

entityName - as String (Table or Entity name , same as this#getLastChildHierarchyCode

filterParents

@Transactional(readOnly=true)
protected javax.persistence.Query filterParents(T parent,
                                                                              boolean immediate,
                                                                              boolean count)

Return List of nodes that are parents under the specified parent Node.
The parent node must have a valid IHierarchialReference.getId() or IHierarchialReference.getHierarchy(); immediate is false.
If count'ing then it will return a list of count of children for each parent detected

Parameters:

parent - as T

immediate - as boolean; if true will fetch only parents immediately under the specified parent

entityName -

count - true will return the counts

Returns:

List of parent Ids that fit the criteria

shiftHierarchy

@Transactional(readOnly=false)
protected void shiftHierarchy(String currentHierarchyCode,
                                                             String newHierarchyCode,
                                                             String entityName,
                                                             T parent)

Re-organizes the IHierarchialReference.getHierarchy() code. Note: it does not change parent.

Parameters:

currentHierarchyCode - as String of the node to be Shifted @nullable true, for any content (like New) that does not require shifting - User Case : Ignore

newHierarchyCode - as String, to the location this will shift (will not check for conflicts, use getLastChildHierarchyCode(IHierarchialReference, String) or makeSpaceForNodeInParent(IHierarchialReference, IHierarchialReference, Integer, String) or HierarchyHelper.getNewHierarchySequence(String, String, int, List) for that.

entityName -

parent - @nullable true; Future Use

verifyHierarchy

@Transactional(readOnly=true)
protected void verifyHierarchy(T rootNode,
                                                             String entityName)
                                                      throws Exception

Validate a tree / sub-tree.
For a given node, it verifies if there is any hierarchy that has an alternate node with a conflicting hierarchy code.

Throws:

Exception

deleteSubHierarchy

@Transactional(readOnly=false,
               rollbackFor=java.lang.Exception.class)
protected int deleteSubHierarchy(String hierarchyCode,
                                                                                                                      String entityName,
                                                                                                                      org.apache.commons.collections.Transformer relatedEntitiesHierachyDelete)

Delete from the given hierarchy code onward (including the given code)

Parameters:

hierarchyCode -

entityName - as String

relatedEntitiesHierachyDelete - as Transformer, that will be passed hierarchy code and based on that it will delete all concerned records from related entities

deleteSubHierarchy

@Transactional(readOnly=false,
               rollbackFor=java.lang.Exception.class)
protected int deleteSubHierarchy(T rootNode,
                                                                                                                      String entityName,
                                                                                                                      org.apache.commons.collections.Transformer relatedEntitiesHierachyDelete)
                                                                                                               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 -

entityName - as String

relatedEntitiesHierachyDelete - as Transformer, that will be passed hierarchy code and based on that it will delete all concerned records from related entities

Throws:

Exception

convert

@Transactional(readOnly=false)
public 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

loadPage

public Page<T> loadPage(Query<T> query)

delete

public Long delete(Long id,
                   String entityName)

delete

public Long delete(Collection<Long> ids,
                   String entityName)

save

public T save(T entity)

Specified by:

save in interface GenericDao<T extends IHierarchialReference>

Overrides:

save in class GenericDaoImpl<T extends IHierarchialReference>

move

public void move(T entity,
                 T newParent,
                 Integer sequence,
                 String entityName)
          throws Exception

Parameters:

entity - as Entity type

newParent - as Entity type

sequence - as Integer

entityName - as String

Throws:

Exception

getParents

public List<T> getParents(T entity,
                          boolean includeThis,
                          String DEFAULT_ENTITY_NAME,
                          QueryOptimizer queryOptimizer,
                          String entityName)

getRelEntitiesDelTransformer

public org.apache.commons.collections.Transformer getRelEntitiesDelTransformer()

A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.

setRelEntitiesDelTransformer

public void setRelEntitiesDelTransformer(org.apache.commons.collections.Transformer relEntitiesDelTransformer)

A Transformer that accepts a String (hierarchy code), Long (id), List of Long (List of Ids) to delete from related entities.

getPersistTransformer

public org.apache.commons.collections.Transformer getPersistTransformer()

Some dependent entities may depend on the core Entity and may need to be persisted/updated/cleaned with (after) it in the same save operation.
This accepts the Entity instance as an input

setPersistTransformer

public void setPersistTransformer(org.apache.commons.collections.Transformer postPersistTransformer)

Some dependent entities may depend on the core Entity and may need to be persisted/updated/cleaned with (after) it in the same save operation.
This accepts the Entity instance as an input