Package org.ametys.plugins.workspaces.util

Class WorkspaceObjectJSONHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.util.WorkspaceObjectJSONHelper

All Implemented Interfaces:

LogEnabled, Serviceable

Direct Known Subclasses:

TaskJSONHelper, ThreadJSONHelper

public class WorkspaceObjectJSONHelper
extends AbstractLogEnabled
implements Serviceable

This class represents a result column

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected PopulationContextHelper	_populationContextHelper	The population context helper
protected ProjectMemberManager	_projectMemberManager	The project member manager
protected RichTextTransformer	_richTextTransformer	Rich text transformer
protected SourceResolver	_sourceResolver	Source resolver
protected ProjectTagProviderExtensionPoint	_tagProviderExtensionPoint	The tag provider extension point
protected UserHelper	_userHelper	The user helper
protected UserManager	_userManager	The user manager
static final String	ATTRIBUTE_FOR_RICHTEXT_ERROR	Attribute to know if error occurred while handling rich text

Constructor Summary

Constructors

Constructor	Description
WorkspaceObjectJSONHelper()

Method Summary

Modifier and Type	Method	Description
protected <T extends AbstractComment> Map<String,Object>	_authorToJSON(T comment, User author, String lang)	Author to JSON
protected Map<String,Object>	_binaryToJson(Binary binary)	return a binary in JSON format
protected <T extends AbstractComment> List<Map<String,Object>>	_commentsToJson(List<T> comments, String lang, String siteName)	return a list of comments in JSON format
protected <T extends AbstractComment> List<Map<String,Object>>	_commentsToJson(List<T> comments, String lang, String siteName, ZonedDateTime lastReadDate, boolean parseCommentcontent)	return a list of comments in JSON format
protected <T extends AbstractComment> Map<String,Object>	_commentToJson(T comment, String lang, String siteName, ZonedDateTime lastReadDate, boolean parseCommentcontent)	return a list of comments in JSON format
protected List<String>	_getTags(TaggableAmetysObject taggableAmetysObject, String siteName)	return a list of tags in JSON format
protected String	richTextToRendering(RichText content)	Transform the rich text as rendering string
String	richTextToSimpleText(RichText content)	Transform the rich text as simple text
void	service(ServiceManager manager)

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

ATTRIBUTE_FOR_RICHTEXT_ERROR

public static final String ATTRIBUTE_FOR_RICHTEXT_ERROR

Attribute to know if error occurred while handling rich text

See Also:

• Constant Field Values

_userHelper

protected UserHelper _userHelper

The user helper

_tagProviderExtensionPoint

protected ProjectTagProviderExtensionPoint _tagProviderExtensionPoint

The tag provider extension point

_projectMemberManager

protected ProjectMemberManager _projectMemberManager

The project member manager

_userManager

protected UserManager _userManager

The user manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper

_sourceResolver

protected SourceResolver _sourceResolver

Source resolver

_richTextTransformer

protected RichTextTransformer _richTextTransformer

Rich text transformer

Constructor Details

WorkspaceObjectJSONHelper

public WorkspaceObjectJSONHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_commentsToJson

protected <T extends AbstractComment>
List<Map<String,Object>> _commentsToJson(List<T> comments,
 String lang,
 String siteName)

return a list of comments in JSON format

Type Parameters:

T - type of the value to retrieve

Parameters:

comments - the comments to translate as JSON

lang - the current language

siteName - The current site name

Returns:

list of comments

_commentsToJson

protected <T extends AbstractComment>
List<Map<String,Object>> _commentsToJson(List<T> comments,
 String lang,
 String siteName,
 ZonedDateTime lastReadDate,
 boolean parseCommentcontent)

return a list of comments in JSON format

Type Parameters:

T - type of the value to retrieve

Parameters:

comments - the comments to translate as JSON

lang - the current language

siteName - The current site name

lastReadDate - Last read date to check if the comment is unread

parseCommentcontent - True to parse comment content

Returns:

list of comments

richTextToRendering

protected String richTextToRendering(RichText content)
                              throws IOException

Transform the rich text as rendering string

Parameters:

content - the content

Returns:

the rendering string

Throws:

IOException - if I/O error occurred.

richTextToSimpleText

public String richTextToSimpleText(RichText content)
                            throws IOException

Transform the rich text as simple text

Parameters:

content - the content

Returns:

the abstract string

Throws:

IOException - if an error occurred

_commentToJson

protected <T extends AbstractComment>
Map<String,Object> _commentToJson(T comment,
 String lang,
 String siteName,
 ZonedDateTime lastReadDate,
 boolean parseCommentcontent)

return a list of comments in JSON format

Type Parameters:

T - type of the value to retrieve

Parameters:

comment - the comment to translate as JSON

lang - the current language

siteName - The current site name

lastReadDate - Last read date to check if the comment is unread

parseCommentcontent - True to parse comment content

Returns:

list of comments

_authorToJSON

protected <T extends AbstractComment>
Map<String,Object> _authorToJSON(T comment,
 User author,
 String lang)

Author to JSON

Type Parameters:

T - type of the value to retrieve

Parameters:

comment - the comment

author - the author

lang - the current language

Returns:

map representing the author

_binaryToJson

protected Map<String,Object> _binaryToJson(Binary binary)

return a binary in JSON format

Parameters:

binary - the binary

Returns:

the binary in JSON format

_getTags

protected List<String> _getTags(TaggableAmetysObject taggableAmetysObject,
 String siteName)

return a list of tags in JSON format

Parameters:

taggableAmetysObject - the TaggableAmetysObject

siteName - The current site name

Returns:

a list of tags