Package org.ametys.plugins.contentstree

Class ContentsTreeHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentstree.ContentsTreeHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

ODFContentsTreeHelper

public class ContentsTreeHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for contents tree

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysResolver	The ametys object resolver instance
protected ContentTypeExtensionPoint	_contentTypesEP	The content type EP instance
protected ContentTypesHelper	_contentTypesHelper	The content types helper instance
protected TreeExtensionPoint	_treeExtensionPoint	The tree configuration EP instance
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ContentsTreeHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_addChildren(Content content, TreeConfiguration treeConfiguration, Map<String,Object> infos)	Add the json info to list the children of a content
protected Content	_getParentContent(String parentId)	Get the parent content of a tree
protected TreeConfiguration	_getTreeConfiguration(String treeId)	Get the tree configuration
Map<String,Object>	childContent2Json(Content content, String attributePath)	Get the default JSON representation of a child content
protected Map<String,Object>	content2Json(Content content)	Get the default JSON representation of a content of the tree
List<String>	filterChildrenContentByRegExp(String parentContentId, String treeId, String value)	Get the path of children content which match filter regexp
Map<String,Object>	getChildrenContent(String contentId, String treeId)	Get the children contents according the tree configuration
Map<String,List<Content>>	getChildrenContent(Content parentContent, TreeConfiguration treeConfiguration)	Get the children contents according the tree configuration
Map<String,Object>	getNodeInformations(String contentId)	Get the node informations
Map<String,Object>	getRootNodeInformations(String contentId, String treeId)	Get the root node informations
protected boolean	hasAutoExpandTargets(TreeConfiguration treeConfiguration)	Should auto expand until some kind of node?
boolean	hasChildrenContent(Content content, TreeConfiguration treeConfiguration)	Determines if the content has children contents according the tree configuration
protected boolean	isAnAutoExpandTarget(TreeConfiguration treeConfiguration, Content content)	Should auto expand until some kind of node?
protected boolean	isContentMatching(Content content, String value)	Determines if content matches the filter regexp
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver instance

_treeExtensionPoint

protected TreeExtensionPoint _treeExtensionPoint

The tree configuration EP instance

_contentTypesEP

protected ContentTypeExtensionPoint _contentTypesEP

The content type EP instance

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper instance

Constructor Details

ContentsTreeHelper

public ContentsTreeHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

hasChildrenContent

public boolean hasChildrenContent(Content content,
 TreeConfiguration treeConfiguration)

Determines if the content has children contents according the tree configuration

Parameters:

content - the root content

treeConfiguration - the tree configuration

Returns:

true if the content has children contents

getChildrenContent

public Map<String,List<Content>> getChildrenContent(Content parentContent,
 TreeConfiguration treeConfiguration)

Get the children contents according the tree configuration

Parameters:

parentContent - the root content

treeConfiguration - the tree configuration

Returns:

the children content for each child attributes

getChildrenContent

public Map<String,Object> getChildrenContent(String contentId,
 String treeId)

Get the children contents according the tree configuration

Parameters:

contentId - the parent content

treeId - the tree configuration

Returns:

the children content

_addChildren

protected void _addChildren(Content content,
 TreeConfiguration treeConfiguration,
 Map<String,Object> infos)

Add the json info to list the children of a content

Parameters:

content - The content

treeConfiguration - The current tree configuration

infos - The infos where to add the children key

filterChildrenContentByRegExp

public List<String> filterChildrenContentByRegExp(String parentContentId,
 String treeId,
 String value)

Get the path of children content which match filter regexp

Parameters:

parentContentId - The id of content to start search

treeId - The id of tree configuration

value - the value to match

Returns:

the matching paths composed by contents id separated by ';'

isContentMatching

protected boolean isContentMatching(Content content,
 String value)

Determines if content matches the filter regexp

Parameters:

content - the content

value - the value to match

Returns:

true if the content match

getRootNodeInformations

public Map<String,Object> getRootNodeInformations(String contentId,
 String treeId)

Get the root node informations

Parameters:

contentId - The content

treeId - The contents tree id

Returns:

The informations

getNodeInformations

public Map<String,Object> getNodeInformations(String contentId)

Get the node informations

Parameters:

contentId - The content

Returns:

The informations

content2Json

protected Map<String,Object> content2Json(Content content)

Get the default JSON representation of a content of the tree

Parameters:

content - the content

Returns:

the content as JSON

childContent2Json

public Map<String,Object> childContent2Json(Content content,
 String attributePath)

Get the default JSON representation of a child content

Parameters:

content - the content

attributePath - the path of attribute holding this content

Returns:

the content as JSON

_getTreeConfiguration

protected TreeConfiguration _getTreeConfiguration(String treeId)

Get the tree configuration

Parameters:

treeId - the tree id

Returns:

the tree configuration

_getParentContent

protected Content _getParentContent(String parentId)
                             throws IllegalArgumentException

Get the parent content of a tree

Parameters:

parentId - the parent id

Returns:

the parent content of a tree

Throws:

IllegalArgumentException - if an exception occurred

hasAutoExpandTargets

protected boolean hasAutoExpandTargets(TreeConfiguration treeConfiguration)

Should auto expand until some kind of node?

Parameters:

treeConfiguration - The tree configuration

Returns:

true if should auto expand

isAnAutoExpandTarget

protected boolean isAnAutoExpandTarget(TreeConfiguration treeConfiguration,
 Content content)

Should auto expand until some kind of node?

Parameters:

treeConfiguration - The tree configuration

content - The content involved

Returns:

true if should auto expand to it