Class AbstractContentTreeViewProvider

java.lang.Object

ch.tocco.nice2.dms.spi.tree.ui.AbstractContentTreeViewProvider

All Implemented Interfaces:

EntityTreeViewProvider

Direct Known Subclasses:

AbstractDmsTreeViewProvider, CmsTreeViewProvider, NewsletterTreeViewProvider

public abstract class AbstractContentTreeViewProvider
extends Object
implements EntityTreeViewProvider

Nested Class Summary

Nested classes/interfaces inherited from interface EntityTreeViewProvider

EntityTreeViewProvider.EntityTreeViewProviderDescriptor, EntityTreeViewProvider.Icon, EntityTreeViewProvider.NotInTreeException

Field Summary

Fields

Modifier and Type	Field	Description
protected final ContentTreeContext	contentTreeContext
protected final ContentTreeService	contentTreeService
protected final Context	context
protected final EntityTreeNodeFactory	entityTreeNodeFactory
protected final ContentTreeNodePermissionEvaluatorService	permissionEvaluatorService
protected final QueryBuilderFactory	queryBuilderFactory

Constructor Summary

Constructors

Constructor	Description
AbstractContentTreeViewProvider(ContentTreeService contentTreeService, Context context, EntityTreeNodeFactory entityTreeNodeFactory, QueryBuilderFactory queryBuilderFactory, ContentTreeNodePermissionEvaluatorService permissionEvaluatorService, ContentTreeContext contentTreeContext)

Method Summary

Modifier and Type	Method	Description
List<EntityTreeNode>	getChildren(Entity entity)
List<Entity>	getPath(Entity entity)	Load all parents of the passed entity into a list
EntityTreeNode	getRoot()
List<EntityTreeNode>	getRootChildren(TreeContext treeContext)
protected QueryBuilder	getRootChildrenQuery(TreeContext treeContext)
List<Entity>	getSearchResult(Entity entity)	Remote method for click event on tree nodes which cannot be displayed in the current entity explorer
HashMap<String,Object>	getTreeConfig()	Allowed config properties are those of Ext.TreePanel and additionally the following: openAsRoot: [ true | false ] set opened entity as root of the tree dataRegistry: Map with dataregistry settings (optional): enabled: true / false entityModels: Array of Strings containing names of entity models to be tracked by dataregistry searchByRelation: the method EntityTreeViewProvider.getSearchResult(Entity) is never used, it is rather searched by using related-by queries according to the relations between the involved entities as specified in EntityTreeViewProvider.getCreateRelationMap().
EntityTreeNode	getTreeNode(Entity entity)	Get a tree node for a specific entity.
void	moveAbove(Entity source, Entity target)
void	moveBelow(Entity source, Entity target)
void	moveInto(Entity source, Entity target)

Methods inherited from class Object

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

Methods inherited from interface EntityTreeViewProvider

getCreateRelationMap, getDescriptor, getIconMap

Field Details

contentTreeService

protected final ContentTreeService contentTreeService

context

protected final Context context

entityTreeNodeFactory

protected final EntityTreeNodeFactory entityTreeNodeFactory

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

contentTreeContext

protected final ContentTreeContext contentTreeContext

permissionEvaluatorService

protected final ContentTreeNodePermissionEvaluatorService permissionEvaluatorService

Constructor Details

AbstractContentTreeViewProvider

public AbstractContentTreeViewProvider(ContentTreeService contentTreeService,
 Context context,
 EntityTreeNodeFactory entityTreeNodeFactory,
 QueryBuilderFactory queryBuilderFactory,
 ContentTreeNodePermissionEvaluatorService permissionEvaluatorService,
 ContentTreeContext contentTreeContext)

Method Details

getRoot

public EntityTreeNode getRoot()

Specified by:

getRoot in interface EntityTreeViewProvider

Returns:

the root tree node, when opening the module

getChildren

public List<EntityTreeNode> getChildren(Entity entity)
                                 throws TreeModelException

Specified by:

getChildren in interface EntityTreeViewProvider

Parameters:

entity - reference entity

Returns:

a list of EntityTreeNode representing the children for the passed entity

Throws:

TreeModelException

getRootChildren

public List<EntityTreeNode> getRootChildren(TreeContext treeContext)
                                     throws TreeModelException

Specified by:

getRootChildren in interface EntityTreeViewProvider

Returns:

a list of EntityTreeNode representing the children for the root tree node

Throws:

TreeModelException

getRootChildrenQuery

protected QueryBuilder getRootChildrenQuery(TreeContext treeContext)
                                     throws PersistException

Throws:

PersistException

getPath

public List<Entity> getPath(Entity entity)
                     throws EntityTreeViewProvider.NotInTreeException

Description copied from interface: EntityTreeViewProvider

Load all parents of the passed entity into a list

Specified by:

getPath in interface EntityTreeViewProvider

Parameters:

entity - leaf entity

Returns:

a list of entities representing the path from the root entity to the entity itself

Throws:

EntityTreeViewProvider.NotInTreeException

getSearchResult

public List<Entity> getSearchResult(Entity entity)
                             throws TreeModelException

Description copied from interface: EntityTreeViewProvider

Remote method for click event on tree nodes which cannot be displayed in the current entity explorer

Specified by:

getSearchResult in interface EntityTreeViewProvider

Parameters:

entity - the entity contained in the tree node that fired the event

Returns:

a list of entities that should be displayed in the default list form (could be of any model, only displaying entities of the current module)

Throws:

TreeModelException

getTreeNode

public EntityTreeNode getTreeNode(Entity entity)
                           throws TreeModelException

Description copied from interface: EntityTreeViewProvider

Get a tree node for a specific entity. This method is called, when new values may be available and the node needs to be reloaded

Specified by:

getTreeNode in interface EntityTreeViewProvider

Parameters:

entity - the reference entity

Returns:

representing EntityTreeNode

Throws:

TreeModelException

getTreeConfig

public HashMap<String,Object> getTreeConfig()

Description copied from interface: EntityTreeViewProvider

Allowed config properties are those of Ext.TreePanel and additionally the following:

• openAsRoot: [ true | false ] set opened entity as root of the tree
• dataRegistry: Map with dataregistry settings (optional):
  • enabled: true / false
  • entityModels: Array of Strings containing names of entity models to be tracked by dataregistry
• searchByRelation: the method EntityTreeViewProvider.getSearchResult(Entity) is never used, it is rather searched by using related-by queries according to the relations between the involved entities as specified in EntityTreeViewProvider.getCreateRelationMap().

Specified by:

getTreeConfig in interface EntityTreeViewProvider

Returns:

a map containing additional settings for the DwrTreePanel

moveInto

public void moveInto(Entity source,
 Entity target)
              throws TreeModelException

Specified by:

moveInto in interface EntityTreeViewProvider

Throws:

TreeModelException

moveAbove

public void moveAbove(Entity source,
 Entity target)
               throws TreeModelException

Specified by:

moveAbove in interface EntityTreeViewProvider

Throws:

TreeModelException

moveBelow

public void moveBelow(Entity source,
 Entity target)
               throws TreeModelException

Specified by:

moveBelow in interface EntityTreeViewProvider

Throws:

TreeModelException