Package org.ametys.plugins.workspaces.documents

Class DocumentsJSONHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.util.WorkspaceObjectJSONHelper

org.ametys.plugins.workspaces.documents.DocumentsJSONHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class DocumentsJSONHelper
extends WorkspaceObjectJSONHelper
implements Component

Helper to convert documents to JSON

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectManager	_projectManager	The project manager
static final String	ROLE	The Avalon role

Fields inherited from class org.ametys.plugins.workspaces.util.WorkspaceObjectJSONHelper

_commentsDAO, _currentUserProvider, _populationContextHelper, _projectMemberManager, _richTextTransformer, _smanager, _sourceResolver, _tagProviderExtensionPoint, _userHelper, _userManager, ATTRIBUTE_FOR_RICHTEXT_ERROR

Constructor Summary

Constructors

Constructor	Description
DocumentsJSONHelper()

Method Summary

Modifier and Type	Method	Description
<T extends AbstractComment> List<Map<String,Object>>	commentsToJson(List<T> comments, String lang, String siteName)	return a list of comments in JSON format
Map<String,Object>	extractCommonFileData(Resource file)	Internal method to extract the valuable data of a file
Map<String,Object>	extractCommonFolderData(ResourceCollection folder)	Internal method to extract the valuable data of a folder
void	service(ServiceManager manager)
Map<String,Object>	tag2json(Tag tag)	Extract tag as JSON
List<Map<String,Object>>	tags2json(Resource file)	Extract resource tags as JSON

Methods inherited from class org.ametys.plugins.workspaces.util.WorkspaceObjectJSONHelper

_authorToJSON, _binaryToJson, _commentsToJson, _commentsToJson, _commentToJson, _getTags, richTextToRendering, richTextToSimpleText

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

_projectManager

protected ProjectManager _projectManager

The project manager

Constructor Details

DocumentsJSONHelper

public DocumentsJSONHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class WorkspaceObjectJSONHelper

Throws:

ServiceException

commentsToJson

public <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

extractCommonFolderData

public Map<String,Object> extractCommonFolderData(ResourceCollection folder)

Internal method to extract the valuable data of a folder

Parameters:

folder - The folder

Returns:

the valuable folder data

extractCommonFileData

public Map<String,Object> extractCommonFileData(Resource file)

Internal method to extract the valuable data of a file

Parameters:

file - The file

Returns:

the valuable file data

tags2json

public List<Map<String,Object>> tags2json(Resource file)

Extract resource tags as JSON

Parameters:

file - the file containing the tags

Returns:

list of tags as JSON

tag2json

public Map<String,Object> tag2json(Tag tag)

Extract tag as JSON

Parameters:

tag - the tag to convert

Returns:

tag as JSON